The project introduces the concept of "extensions".

For NPM package to be considered an extension, it must have a package.json field scandipwa.type equal to extension. For example:

{
    "scandipwa": {
        "type": "extension"
    }
    ...
}

The extensions are power-less without a theme. The application compiles from a theme sources. Extensions are just an isolated pieces, which make some features of your application work.

Registering an extension

Both themes and extensions can register extensions. In order to do it, the extension should be added to scandipwa.extensions object of package.json . The extension must be a valid NPM package, therefore you are required to add it into dependencies field of your package.json. Like so:

{
    "dependencies": {
        "@scandipwa/m2-theme": "0.0.2",
        ...
    },
    "scandipwa": {
        "extensions": {
            "@scandipwa/m2-theme": true
        },
        ...
    }
    ...
}

This process could be automated using ScandiPWA CLI. First, make sure you are in your theme's root folder. Now, to install an extension from NPM registry, you can use following command:

scandipwa extension install <PACKAGE>

In order to create new extension, use following command:

scandipwa extension create <PACKAGE>

Enabling an extension

Enabling and disabling an extension is achieved by setting the trueor false as a value of the extension key in scandipwa.extensions . Your theme can control enabled extensions across the whole application. This allows to disable the previously enabled extension. The sequence of preference in this case is:

1. Your theme enabled extensions

2. Your theme's parent themes enabled extensions

3. Extension enabled extensions

Extension features

Extensions are very important and powerful part of ScandiPWA tool-chain. Following feature are available:

• ​Application plugins​

• ​Build configuration plugins​

• ​Module preference​

• ​File provision​

Following features are upcoming in next versions of Create ScandiPWA App releases:

• Translation bundles

• HTML template plugin

​