@appshell/cli 0.3.0-alpha.5 → 0.3.0

package/README.md

@@ -11,7 +11,7 @@
 
 # @appshell/cli
 
-Appshell utilities for building micro-frontends with Appshell and Webpack Module federation.
+Utility for building micro-frontends with Appshell and Webpack Module federation.
 
 Working examples can be found [here](https://github.com/navaris/appshell/tree/main/examples).
 
@@ -83,11 +83,11 @@ Options:
 appshell generate manifest --template dist/appshell.config.json
 ```
 
-**Where does the content of CONFIGS_DIR come from?**
+**Where does the content of APPSHELL_REGISTRY come from?**
 
-> Each micro-frontend configured to use [@appshell/manifest-webpack-plugin](https://www.npmjs.com/package/@appshell/manifest-webpack-plugin) emits it's configuration to the configs directory at build time, which is subsequently processed with this utility to reflect the current runtime environment.
+> Each micro-frontend configured to use [@appshell/manifest-webpack-plugin](https://www.npmjs.com/package/@appshell/manifest-webpack-plugin) emits a manifest template, which is subsequently used to generate a manifest for the remote module. This manifest is then registered with the APPSHELL_REGISTRY.
 
-Sample content from CONFIGS_DIR:
+Sample manifest template `appshell.config.json`:
 
 ```json
 {
@@ -130,11 +130,11 @@ Sample content from CONFIGS_DIR:
 
 **How does my runtime environment get reflected in the appshell manifest?**
 
-> Note the variable expansion syntax `${CRA_MFE_URL}`. When `generate` is called the actual runtime environment values are injected and all configurations are ultimately merged into a global appshell manifest.
+> Note the variable expansion syntax `${CRA_MFE_URL}`. When `appshell generate manifest` is called the actual runtime environment values are injected in order to produce the remote module's appshell manifest.
 
 > **Note** the `environment` section defines runtime environment variables that are injected into the global namesapce `window.__appshell_env__[module_name]` when a federated component is loaded. See the examples for a use case.
 
-Sample global appshell manifest produced by the `generate` function:
+Sample appshell manifest produced by the `appshell generate manifest` function:
 
 ```json
 {
@@ -227,11 +227,11 @@ Sample global appshell manifest produced by the `generate` function:
 }
 ```
 
-This global appshell manifest can be consumed by your micro-frontend Appshell host and used to configure the Appshell accordingly.
+This appshell manifest is registered with `APPSHELL_REGISTRY` and subsequently consumed by the Appshell host.
 
 ## Register a manifest
 
-Register on or more appshell manifests with the global registry.
+Register one or more appshell manifests with the global registry.
 
 ```bash
 appshell register
@@ -246,26 +246,6 @@ Options:
                                          [string] [default: "appshell_registry"]
 ```
 
-## Merge manifests
-
-Merge one or more appshell manifests to produce one global appshell manifest.
-
-```bash
-appshell merge
-
-Merge one or more appshell manifests
-
-Options:
-      --help      Show help                                            [boolean]
-      --version   Show version number                                  [boolean]
-  -o, --outDir    Output location for the appshell manifest
-                                                         [string] [default: "."]
-  -f, --outFile   Output filename for the appshell manifest
-                                    [string] [default: "appshell.manifest.json"]
-  -m, --manifest  One or more manifests to merge into a single appshell manifest
-                                                                         [array]
-```
-
 ## Generate runtime env
 
 Generates a runtime env js file that can be consumed by the application at runtime.
@@ -282,7 +262,7 @@ Options:
   -o, --outDir   Output location for the runtime environment js             [string] [default: "."]
   -f, --outFile  Output filename for the runtime environment js             [string] [default: "runtime.env.js"]
   -p, --prefix   Only capture environment variables that start with prefix  [string] [default: ""]
-  -g, --globalName     Global variable name window[globalName] used in the output js    [string] [default: "appshell_env"]
+  -g, --globalName     Global variable name window[globalName] used in the output js    [string] [default: "__appshell_env__"]
 ```
 
 ### Sample usage
@@ -294,7 +274,7 @@ appshell generate env -e .env --prefix APPSHELL_ --outDir dist
 Sample output `runtime.env.js`
 
 ```js
-window.appshell_env = {
+window.__appshell_env__ = {
   APPSHELL_VAR_1 = 'val 1',
   APPSHELL_VAR_2 = 'val 2'
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appshell/cli",
-  "version": "0.3.0-alpha.5",
+  "version": "0.3.0",
   "description": "cli utility to generate a global appshell artifacts for module federation micro-frontends",
   "main": "dist/main.js",
   "repository": "https://github.com/navaris/appshell.git",
@@ -30,5 +30,5 @@
     "appshell"
   ],
   "license": "MIT",
-  "gitHead": "05026fe4d960f8bae77b6a00935d62184b6f874d"
+  "gitHead": "a20c074472f1f55b0479b07e95d63aa0ccdd4be9"
 }