@contentstack/cli-cm-bootstrap 1.1.0 → 1.1.3

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contentstack/cli-cm-bootstrap
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-cm-bootstrap/1.1.0 linux-x64 node-v16.14.2
+@contentstack/cli-cm-bootstrap/1.1.3 darwin-arm64 node-v18.11.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -52,7 +52,7 @@ OPTIONS
   -y, --yes=yes
 
   --app-name=app-name                App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter,
-                                     nuxt-starter
+                                     nuxt-starter, vue-starter, stencil-starter
 
   --org=org                          Provide organization UID to create a new stack
 
@@ -69,5 +69,5 @@ EXAMPLES
   --stack-name "stack-name"
 ```
 
-_See code: [src/commands/cm/bootstrap.ts](https://github.com/contentstack/cli/blob/v1.1.0/src/commands/cm/bootstrap.ts)_
+_See code: [src/commands/cm/bootstrap.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-bootstrap/src/commands/cm/bootstrap.ts)_
 <!-- commandsstop -->

package/lib/bootstrap/index.js

@@ -63,7 +63,7 @@ class Bootstrap {
             }
             const result = await seed_1.default.run(cmd);
             if (result.api_key) {
-                await (0, utils_1.setupEnvironments)(this.managementAPIClient, result.api_key, this.appConfig, this.cloneDirectory, this.region);
+                await (0, utils_1.setupEnvironments)(this.managementAPIClient, result.api_key, this.appConfig, this.cloneDirectory, this.region, this.options.livePreviewEnabled);
             }
             else {
                 throw new Error(messages_1.default.parse('CLI_BOOTSTRAP_NO_API_KEY_FOUND'));

package/lib/bootstrap/interactive.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inquireAppType = exports.inquireGithubAccessToken = exports.inquireCloneDirectory = exports.inquireApp = void 0;
+exports.inquireLivePreviewSupport = exports.inquireAppType = exports.inquireGithubAccessToken = exports.inquireCloneDirectory = exports.inquireApp = void 0;
 const path = require("path");
 const inquirer = require("inquirer");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
@@ -87,3 +87,12 @@ async function inquireAppType() {
     return appType.type;
 }
 exports.inquireAppType = inquireAppType;
+async function inquireLivePreviewSupport() {
+    const { livePreviewEnabled } = await inquirer.prompt({
+        type: 'confirm',
+        name: 'livePreviewEnabled',
+        message: 'Enable live preview?'
+    });
+    return livePreviewEnabled;
+}
+exports.inquireLivePreviewSupport = inquireLivePreviewSupport;

package/lib/bootstrap/utils.js

@@ -11,7 +11,7 @@ const messages_1 = require("../messages");
  * Create delivery token
  * Create enviroment
  */
-const setupEnvironments = async (managementAPIClient, api_key, appConfig, clonedDirectory, region) => {
+const setupEnvironments = async (managementAPIClient, api_key, appConfig, clonedDirectory, region, livePreviewEnabled) => {
     const environmentResult = await managementAPIClient.stack({ api_key }).environment().query().find();
     if (Array.isArray(environmentResult.items) && environmentResult.items.length > 0) {
         for (const environment of environmentResult.items) {
@@ -41,8 +41,9 @@ const setupEnvironments = async (managementAPIClient, api_key, appConfig, cloned
                             api_key,
                             deliveryToken: tokenResult.token,
                             environment: environment.name,
+                            livePreviewEnabled,
                         };
-                        await envFileHandler(appConfig.appConfigKey || '', environmentVariables, clonedDirectory, region);
+                        await envFileHandler(appConfig.appConfigKey || '', environmentVariables, clonedDirectory, region, livePreviewEnabled);
                     }
                     else {
                         cli_utilities_1.cliux.print(messages_1.default.parse('CLI_BOOTSTRAP_APP_FAILED_TO_CREATE_TOKEN_FOR_ENV', environment.name));
@@ -82,7 +83,7 @@ const writeEnvFile = (content, fileName) => {
  * @description Create environment files for each app
  * TBD: moving the content to config file
  */
-const envFileHandler = async (appConfigKey, environmentVariables, clonedDirectory, region) => {
+const envFileHandler = async (appConfigKey, environmentVariables, clonedDirectory, region, livePreviewEnabled) => {
     if (!appConfigKey || !environmentVariables) {
         return;
     }
@@ -103,21 +104,21 @@ const envFileHandler = async (appConfigKey, environmentVariables, clonedDirector
         case 'reactjs-starter':
             fileName = `.env.${environmentVariables.environment}.local`;
             filePath = path.join(clonedDirectory, fileName);
-            content = `REACT_APP_CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nREACT_APP_CONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nREACT_APP_CONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nREACT_APP_CONTENTSTACK_API_HOST=' + customHost : '')}${(!isUSRegion && !customHost) ? '\nREACT_APP_CONTENTSTACK_REGION=' + region.name : ''}\nSKIP_PREFLIGHT_CHECK=true`;
+            content = `REACT_APP_CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nREACT_APP_CONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nREACT_APP_CONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nREACT_APP_CONTENTSTACK_API_HOST=' + customHost : '')}${(!isUSRegion && !customHost) ? '\nREACT_APP_CONTENTSTACK_REGION=' + region.name : ''}\nSKIP_PREFLIGHT_CHECK=true\nREACT_APP_CONTENTSTACK_LIVE_PREVIEW=${livePreviewEnabled}`;
             result = await writeEnvFile(content, filePath);
             break;
         case 'nextjs':
         case 'nextjs-starter':
             fileName = `.env.${environmentVariables.environment}.local`;
             filePath = path.join(clonedDirectory, fileName);
-            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nCONTENTSTACK_API_HOST=' + customHost : '')}${(!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : '')}`;
+            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nCONTENTSTACK_API_HOST=' + customHost : '')}${(!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : '')}\nCONTENTSTACK_LIVE_PREVIEW=${livePreviewEnabled}`;
             result = await writeEnvFile(content, filePath);
             break;
         case 'gatsby':
         case 'gatsby-starter':
             fileName = `.env.${environmentVariables.environment}`;
             filePath = path.join(clonedDirectory, fileName);
-            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}\nCONTENTSTACK_API_HOST=${managementAPIHost}`;
+            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}\nCONTENTSTACK_API_HOST=${managementAPIHost}\nCONTENTSTACK_LIVE_PREVIEW=${livePreviewEnabled}`;
             result = await writeEnvFile(content, filePath);
             break;
         case 'angular':
@@ -127,16 +128,23 @@ const envFileHandler = async (appConfigKey, environmentVariables, clonedDirector
             result = await writeEnvFile(content, filePath);
             break;
         case 'angular-starter':
-            content = `export const environment = { \n\tproduction: true \n}; \nexport const Config = { \n\tapi_key: '${environmentVariables.api_key}', \n\tdelivery_token: '${environmentVariables.deliveryToken}', \n\tenvironment: '${environmentVariables.environment}'${(!isUSRegion && !customHost ? `,\n\tregion: '${region.name}'` : '')},\n\tapi_host: '${customHost ? customHost : ''}',\n\tapp_host: '',\n\tmanagement_token: '',\n\tlive_preview: ''\n};`;
+            content = `export const environment = { \n\tproduction: true \n}; \nexport const Config = { \n\tapi_key: '${environmentVariables.api_key}', \n\tdelivery_token: '${environmentVariables.deliveryToken}', \n\tenvironment: '${environmentVariables.environment}'${(!isUSRegion && !customHost ? `,\n\tregion: '${region.name}'` : '')},\n\tapi_host: '${customHost ? customHost : managementAPIHost}',\n\tapp_host: '',\n\tmanagement_token: '',\n\tlive_preview: ${livePreviewEnabled}\n};`;
             fileName = `environment${(environmentVariables.environment === 'production' ? '.prod.' : ".")}ts`;
             filePath = path.join(clonedDirectory, 'src', 'environments', fileName);
             result = await writeEnvFile(content, filePath);
             break;
         case 'nuxtjs':
         case 'nuxt-starter':
+        case 'stencil-starter':
             fileName = (production ? '.env.production' : '.env');
             filePath = path.join(clonedDirectory, fileName);
-            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nCONTENTSTACK_API_HOST=' + customHost : '')}${(!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : '')}`;
+            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nCONTENTSTACK_API_HOST=' + customHost : '')}${(!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : '')}\nCONTENTSTACK_LIVE_PREVIEW=${livePreviewEnabled}`;
+            result = await writeEnvFile(content, filePath);
+            break;
+        case 'vue-starter':
+            fileName = '.env';
+            filePath = path.join(clonedDirectory, fileName);
+            content = `VUE_APP_CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nVUE_APP_CONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nVUE_APP_CONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nVUE_APP_CONTENTSTACK_API_HOST=' + customHost : '')}${(!isUSRegion && !customHost ? '\nVUE_APP_CONTENTSTACK_REGION=' + region.name : '')}\nVUE_APP_CONTENTSTACK_LIVE_PREVIEW=${livePreviewEnabled}`;
             result = await writeEnvFile(content, filePath);
             break;
         default:

package/lib/commands/cm/bootstrap.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_command_1 = require("@contentstack/cli-command");
+const path_1 = require("path");
 const ContentstackManagementSDK = require('@contentstack/management');
 const bootstrap_1 = require("../../bootstrap");
 const interactive_1 = require("../../bootstrap/interactive");
@@ -53,6 +54,8 @@ class BootstrapCommand extends cli_command_1.Command {
             if (!cloneDirectory) {
                 cloneDirectory = await (0, interactive_1.inquireCloneDirectory)();
             }
+            cloneDirectory = (0, path_1.resolve)(cloneDirectory);
+            const livePreviewEnabled = await (0, interactive_1.inquireLivePreviewSupport)();
             const seedParams = {};
             const stackAPIKey = bootstrapCommandFlags['stack-api-key'];
             const org = bootstrapCommandFlags['org'];
@@ -73,6 +76,7 @@ class BootstrapCommand extends cli_command_1.Command {
                 managementAPIClient: this.managementAPIClient,
                 region: this.region,
                 appType,
+                livePreviewEnabled,
             };
             const bootstrap = new bootstrap_1.default(options);
             await bootstrap.run();
@@ -93,7 +97,7 @@ BootstrapCommand.examples = [
 ];
 BootstrapCommand.flags = {
     'app-name': cli_command_1.flags.string({
-        description: 'App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter',
+        description: 'App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter, vue-starter, stencil-starter',
         multiple: false,
         required: false,
     }),

package/lib/config.js

@@ -15,6 +15,8 @@ const config = {
         { displayName: 'Gatsby', configKey: 'gatsby-starter' },
         { displayName: 'Angular', configKey: 'angular-starter' },
         { displayName: 'Nuxt JS', configKey: 'nuxt-starter' },
+        { displayName: 'Vue JS', configKey: 'vue-starter' },
+        { displayName: 'Stencil', configKey: 'stencil-starter' },
     ],
     appLevelConfig: {
         nextjs: {
@@ -57,6 +59,14 @@ const config = {
             source: 'contentstack/contentstack-angular-starter',
             stack: 'contentstack/stack-starter-app',
         },
+        'vue-starter': {
+            source: 'contentstack/contentstack-vuejs-starter-app',
+            stack: 'contentstack/stack-starter-app',
+        },
+        'stencil-starter': {
+            source: 'contentstack/contentstack-stencil-starter-app',
+            stack: 'contentstack/stack-starter-app',
+        },
     },
 };
 exports.default = config;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.1.0","commands":{"cm:bootstrap":{"id":"cm:bootstrap","description":"Bootstrap contentstack apps","pluginName":"@contentstack/cli-cm-bootstrap","pluginType":"core","aliases":[],"examples":["$ csdx cm:bootstrap","$ csdx cm:bootstrap --project-dir <path/to/setup/the/app>","$ csdx cm:bootstrap --app-name \"reactjs-starter\" --project-dir <path/to/setup/the/app>","$ csdx cm:bootstrap --app-name \"reactjs-starter\" --project-dir <path/to/setup/the/app> --stack-api-key \"stack-api-key\"","$ csdx cm:bootstrap --app-name \"reactjs-starter\" --project-dir <path/to/setup/the/app> --org \"your-org-uid\" --stack-name \"stack-name\""],"flags":{"app-name":{"name":"app-name","type":"option","description":"App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter","required":false},"project-dir":{"name":"project-dir","type":"option","description":"Directory to setup the project. If directory name has a space then provide the path as a string or escap the space using back slash eg: \"../../test space\" or ../../test\\ space","required":false},"app-type":{"name":"app-type","type":"option","description":"Sample or Starter app","hidden":true,"required":false},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"Provide stack API key to seed content","required":false},"org":{"name":"org","type":"option","description":"Provide organization UID to create a new stack","required":false},"stack-name":{"name":"stack-name","type":"option","char":"n","description":"Name of a new stack that will be created.","required":false},"yes":{"name":"yes","type":"option","char":"y","required":false},"appName":{"name":"appName","type":"option","char":"a","description":"App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter","hidden":true,"required":false},"directory":{"name":"directory","type":"option","char":"d","description":"Directory to set up the project. If directory name has a space then provide the path as a string or escape the space using backslash eg: \"../../test space\" or ../../test\\ space","hidden":true,"required":false},"appType":{"name":"appType","type":"option","char":"s","description":"Sample or Starter app","hidden":true,"required":false}},"args":[]}}}
+{"version":"1.1.3","commands":{"cm:bootstrap":{"id":"cm:bootstrap","description":"Bootstrap contentstack apps","pluginName":"@contentstack/cli-cm-bootstrap","pluginType":"core","aliases":[],"examples":["$ csdx cm:bootstrap","$ csdx cm:bootstrap --project-dir <path/to/setup/the/app>","$ csdx cm:bootstrap --app-name \"reactjs-starter\" --project-dir <path/to/setup/the/app>","$ csdx cm:bootstrap --app-name \"reactjs-starter\" --project-dir <path/to/setup/the/app> --stack-api-key \"stack-api-key\"","$ csdx cm:bootstrap --app-name \"reactjs-starter\" --project-dir <path/to/setup/the/app> --org \"your-org-uid\" --stack-name \"stack-name\""],"flags":{"app-name":{"name":"app-name","type":"option","description":"App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter, vue-starter, stencil-starter","required":false},"project-dir":{"name":"project-dir","type":"option","description":"Directory to setup the project. If directory name has a space then provide the path as a string or escap the space using back slash eg: \"../../test space\" or ../../test\\ space","required":false},"app-type":{"name":"app-type","type":"option","description":"Sample or Starter app","hidden":true,"required":false},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"Provide stack API key to seed content","required":false},"org":{"name":"org","type":"option","description":"Provide organization UID to create a new stack","required":false},"stack-name":{"name":"stack-name","type":"option","char":"n","description":"Name of a new stack that will be created.","required":false},"yes":{"name":"yes","type":"option","char":"y","required":false},"appName":{"name":"appName","type":"option","char":"a","description":"App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter","hidden":true,"required":false},"directory":{"name":"directory","type":"option","char":"d","description":"Directory to set up the project. If directory name has a space then provide the path as a string or escape the space using backslash eg: \"../../test space\" or ../../test\\ space","hidden":true,"required":false},"appType":{"name":"appType","type":"option","char":"s","description":"Sample or Starter app","hidden":true,"required":false}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-bootstrap",
   "description": "Bootstrap contentstack apps",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "scripts": {
@@ -17,13 +17,13 @@
     "test:report": "nyc --reporter=lcov mocha \"test/**/*.test.js\""
   },
   "dependencies": {
-    "@contentstack/cli-cm-seed": "^1.1.0",
-    "@contentstack/cli-command": "^1.0.0",
-    "@contentstack/cli-utilities": "^1.0.0",
+    "@contentstack/cli-cm-seed": "^1.1.3",
+    "@contentstack/cli-command": "^1.0.2",
+    "@contentstack/cli-utilities": "^1.0.3",
     "@contentstack/management": "^1.3.0",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.18.3",
-    "inquirer": "^8.0.0",
+    "inquirer": "^8.2.4",
     "mkdirp": "^1.0.4",
     "tar": "^6.0.5"
   },
@@ -71,7 +71,8 @@
     ],
     "plugin": [
       "@contentstack/cli-cm-seed"
-    ]
+    ],
+    "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-bootstrap/<%- commandPath %>"
   },
   "repository": "contentstack/cli"
 }