@contentstack/cli-cm-bootstrap 1.0.0 → 1.0.3

package/README.md

@@ -2,23 +2,60 @@ Contentstack CLI’s “Bootstrap” plugin enables you to automate the process
 
 This means that all the required steps such as stack, environment, and content type creation, entry and asset publishing are performed just by using a single command.
 
-Usage:
-$ csdx cm:bootstrap
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @contentstack/cli-cm-bootstrap
+$ csdx COMMAND
+running command...
+$ csdx (-v|--version|version)
+@contentstack/cli-cm-bootstrap/1.0.3 darwin-x64 node-v14.16.0
+$ csdx --help [COMMAND]
+USAGE
+  $ csdx COMMAND
+...
+```
+<!-- usagestop -->
+```sh-session
+$ npm install -g @contentstack/cli-cm-clone
+$ csdx COMMAND
+running command...
+$ csdx --help [COMMAND]
+USAGE
+  $ csdx COMMAND
+...
+```
+# Commands
+<!-- commands -->
+* [`csdx cm:bootstrap`](#csdx-cmbootstrap)
 
-After running the “Bootstrap” command, follow the steps below to complete the setup:
+## `csdx cm:bootstrap`
 
-App Preference: Select the app (starter or sample) you want to clone from the list of available options.
-Technology: Select the app framework (React, Angular, Node, and so on) in which you want to set up the project.
-Path: Provide the destination folder path/location where the app will be cloned.
-Organization name: Select your organization name from the provided list.
-Stack: Select the stack where you want to import the content of the app. You can also create a new stack and for the import operation.
+Bootstrap contentstack apps
 
-These steps will help you kickstart your app.
-$ csdx cm:bootstrap -s <sampleapp or starterapp> -t <optional github private repo token> -a <app name> -d <path or the location of the folder to clone the app>
+```
+USAGE
+  $ csdx cm:bootstrap
 
-Options:
+OPTIONS
+  -a, --appName=appName          App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter,
+                                 nuxt-starter
 
--s, sampleapp or starterapp: The type of app you want to clone.
- -t: (optional) The token of your private repo to access the project.
--a, --appName: The app name, eg. Gatsby, Next, Nuxt, etc.
--d, --data: Specify the path or the location of the folder to clone the app.
+  -d, --directory=directory      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
+
+  -t, --accessToken=accessToken  Access token for private github repo
+
+EXAMPLES
+  $ csdx cm:bootstrap
+  $ csdx cm:bootstrap -d <path/to/setup/the/app>
+  $ csdx cm:bootstrap -t <github access token>
+```
+
+_See code: [src/commands/cm/bootstrap.ts](https://github.com/contentstack/cli/blob/v1.0.3/src/commands/cm/bootstrap.ts)_
+<!-- commandsstop -->

package/lib/bootstrap/github/client.js

@@ -4,7 +4,7 @@ const axios_1 = require("axios");
 const zlib = require("zlib");
 const tar = require("tar");
 const mkdirp = require("mkdirp");
-const error_1 = require("./error");
+const github_error_1 = require("./github-error");
 const messages_1 = require("../../messages");
 const DEFAULT_BRANCH = 'master';
 class GitHubClient {
@@ -46,7 +46,7 @@ class GitHubClient {
                 };
             }
             else {
-                throw new error_1.default(messages_1.default.parse('CLI_BOOTSTRAP_GITHUB_ACCESS_NOT_FOUND'), 1);
+                throw new github_error_1.default(messages_1.default.parse('CLI_BOOTSTRAP_GITHUB_ACCESS_NOT_FOUND'), 1);
             }
         }
         const response = await axios_1.default.get(url, options);

package/lib/bootstrap/index.js

@@ -5,10 +5,10 @@ const cli_ux_1 = require("cli-ux");
 const path = require("path");
 const seed_1 = require("@contentstack/cli-cm-seed/lib/commands/cm/seed");
 const client_1 = require("./github/client");
-const error_1 = require("./github/error");
+const github_error_1 = require("./github/github-error");
 const utils_1 = require("./utils");
 const messages_1 = require("../messages");
-exports.ENGLISH_LOCALE = 'en-us';
+exports.ENGLISH_LOCALE = "en-us";
 /**
  * @description Bootstraps the sample app
  * Clone the repo
@@ -31,14 +31,14 @@ class Bootstrap {
         this.options = options;
     }
     async run() {
-        cli_ux_1.default.action.start(messages_1.default.parse('CLI_BOOTSTRAP_START_CLONE_APP'));
+        cli_ux_1.default.action.start(messages_1.default.parse("CLI_BOOTSTRAP_START_CLONE_APP"));
         try {
             await this.ghClient.getLatest(this.cloneDirectory);
         }
         catch (error) {
-            if (error instanceof error_1.default) {
+            if (error instanceof github_error_1.default) {
                 if (error.status === 404) {
-                    cli_ux_1.default.error(messages_1.default.parse('CLI_BOOTSTRAP_REPO_NOT_FOUND', this.appConfig.source));
+                    cli_ux_1.default.error(messages_1.default.parse("CLI_BOOTSTRAP_REPO_NOT_FOUND", this.appConfig.source));
                 }
             }
             throw error;
@@ -48,17 +48,17 @@ class Bootstrap {
         }
         // seed plugin start
         try {
-            const result = await seed_1.default.run(['-r', this.appConfig.stack]);
+            const result = await seed_1.default.run(["-r", this.appConfig.stack]);
             if (result.api_key) {
                 await utils_1.setupEnvironments(this.managementAPIClient, result.api_key, this.appConfig, this.cloneDirectory, this.region);
             }
             else {
-                throw new Error(messages_1.default.parse('CLI_BOOTSTRAP_NO_API_KEY_FOUND'));
+                throw new Error(messages_1.default.parse("CLI_BOOTSTRAP_NO_API_KEY_FOUND"));
             }
-            cli_ux_1.default.log(messages_1.default.parse('CLI_BOOTSTRAP_SUCCESS'));
+            cli_ux_1.default.log(messages_1.default.parse("CLI_BOOTSTRAP_SUCCESS"));
         }
         catch (error) {
-            cli_ux_1.default.error(messages_1.default.parse('CLI_BOOTSTRAP_STACK_CREATION_FAILED', this.appConfig.stack));
+            cli_ux_1.default.error(messages_1.default.parse("CLI_BOOTSTRAP_STACK_CREATION_FAILED", this.appConfig.stack));
         }
     }
 }

package/lib/bootstrap/utils.js

@@ -20,14 +20,19 @@ exports.setupEnvironments = async (managementAPIClient, api_key, appConfig, clon
                     'token': {
                         'name': `Sample app ${environment.name}`,
                         'description': 'Sample app',
-                        'scope': [{
+                        'scope': [
+                            {
                                 'module': 'environment',
                                 'environments': [environment.name],
-                                'acl': {
-                                    'read': true
-                                }
-                            }]
-                    }
+                                'acl': { 'read': true }
+                            },
+                            {
+                                module: "branch",
+                                acl: { read: true },
+                                branches: ["main"]
+                            }
+                        ]
+                    },
                 };
                 try {
                     const tokenResult = await managementAPIClient.stack({ api_key }).deliveryToken().create(body);
@@ -44,6 +49,7 @@ exports.setupEnvironments = async (managementAPIClient, api_key, appConfig, clon
                     }
                 }
                 catch (error) {
+                    console.log("error", error);
                     cli_ux_1.default.log(messages_1.default.parse('CLI_BOOTSTRAP_APP_FAILED_TO_CREATE_ENV_FILE_FOR_ENV', environment.name));
                 }
             }
@@ -95,14 +101,14 @@ const envFileHandler = async (appConfigKey, environmentVariables, clonedDirector
         case 'reactjs-starter':
             fileName = `.env.${environmentVariables.environment}.local`;
             filePath = path.join(clonedDirectory, fileName);
-            content = `REACT_APP_APIKEY=${environmentVariables.api_key}\nREACT_APP_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nREACT_APP_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nREACT_APP_CUSTOM_HOST=' + customHost : '')}${(!isUSRegion && !customHost) ? '\nREACT_APP_REGION=' + region.name : ''}`;
+            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_CUSTOM_HOST=' + customHost : '')}${(!isUSRegion && !customHost) ? '\nREACT_APP_CONTENTSTACK_REGION=' + region.name : ''}`;
             result = await writeEnvFile(content, filePath);
             break;
         case 'nextjs':
         case 'nextjs-starter':
             fileName = `.env.${environmentVariables.environment}.local`;
             filePath = path.join(clonedDirectory, fileName);
-            content = `API_KEY=${environmentVariables.api_key}\nDELIVERY_TOKEN=${environmentVariables.deliveryToken}\nENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nCUSTOM_HOST=' + customHost : '')}${(!isUSRegion && !customHost ? '\nREGION=' + region.name : '')}`;
+            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${(customHost ? '\nCONTENTSTACK_CUSTOM_HOST=' + customHost : '')}${(!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : '')}`;
             result = await writeEnvFile(content, filePath);
             break;
         case 'gatsby':

package/lib/commands/cm/bootstrap.js

@@ -12,17 +12,17 @@ class BootstrapCommand extends cli_command_1.Command {
         return this._managementAPIClient;
     }
     async run() {
-        const { flags } = this.parse(BootstrapCommand);
+        const bootstrapCommandFlags = this.parse(BootstrapCommand).flags;
         try {
             if (!this.authToken) {
                 this.error(messages_1.default.parse('CLI_BOOTSTRAP_LOGIN_FAILED'), { exit: 2, suggestions: ['https://www.contentstack.com/docs/developers/cli/authentication/'] });
             }
             // inquire user inputs
-            let appType = flags.appType || 'starterapp';
+            let appType = bootstrapCommandFlags.appType || 'starterapp';
             if (!appType) {
                 appType = await interactive_1.inquireAppType();
             }
-            const selectedAppName = flags.appName;
+            const selectedAppName = bootstrapCommandFlags.appName;
             let selectedApp;
             if (!selectedAppName) {
                 if (appType === 'sampleapp') {
@@ -39,12 +39,12 @@ class BootstrapCommand extends cli_command_1.Command {
                 this.error(messages_1.default.parse('CLI_BOOTSTRAP_INVALID_APP_NAME'), { exit: 1 });
             }
             const appConfig = config_1.getAppLevelConfigByName(selectedAppName || selectedApp.configKey);
-            let cloneDirectory = flags.directory;
+            let cloneDirectory = bootstrapCommandFlags.directory;
             if (!cloneDirectory) {
                 cloneDirectory = await interactive_1.inquireCloneDirectory();
             }
             // Check the access token
-            let accessToken = flags.accessToken;
+            let accessToken = bootstrapCommandFlags.accessToken;
             if (appConfig.private && !accessToken) {
                 accessToken = await interactive_1.inquireGithubAccessToken();
             }

package/messages/index.json

@@ -0,0 +1,18 @@
+{
+    "CLI_BOOTSTRAP_INVALID_APP_NAME": "Invalid app name received, use cm:bootstrap see the list of apps supported",
+    "CLI_BOOTSTRAP_LOGIN_FAILED": "You need to login, first. See: auth:login --help",
+    "CLI_BOOTSTRAP_GITHUB_ACCESS_NOT_FOUND": "No Github access token found",
+    "CLI_BOOTSTRAP_START_CLONE_APP": "Cloning the selected app",
+    "CLI_BOOTSTRAP_REPO_NOT_FOUND": "Unable to find a repo for \"%s\"",
+    "CLI_BOOTSTRAP_NO_API_KEY_FOUND": "No API key generated for the stack",
+    "CLI_BOOTSTRAP_STACK_CREATION_FAILED": "Unable to create stack for content \"%s\"",
+    "CLI_BOOTSTRAP_APP_SELECTION_ENQUIRY": "Select an App",
+    "CLI_BOOTSTRAP_APP_COPY_SOURCE_CODE_DESTINATION_TYPE_ENQUIRY": "Choose the location where you want to copy the source code",
+    "CLI_BOOTSTRAP_APP_COPY_SOURCE_CODE_DESTINATION_ENQUIRY": "Enter destination path",
+    "CLI_BOOTSTRAP_NO_ACCESS_TOKEN_CREATED": "Note: Access token not created already, check out this link https://github.com/settings/tokens \n Provide github access token",
+    "CLI_BOOTSTRAP_TYPE_OF_APP_ENQUIRY": "Choose the type of app you want to clone",
+    "CLI_BOOTSTRAP_APP_FAILED_TO_CREATE_TOKEN_FOR_ENV": "Failed to create delivery token for env \"%s\"",
+    "CLI_BOOTSTRAP_APP_FAILED_TO_CREATE_ENV_FILE_FOR_ENV": "Failed to setup env file for \"%s\"",
+    "CLI_BOOTSTRAP_APP_ENV_NOT_FOUND_FOR_THE_STACK": "No environments found for the stack",
+    "CLI_BOOTSTRAP_SUCCESS": "Project setup is successful!"
+}

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.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 -d <path/to/setup/the/app>","$ csdx cm:bootstrap -t <github access token>"],"flags":{"appName":{"name":"appName","type":"option","char":"a","description":"App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter","required":false},"directory":{"name":"directory","type":"option","char":"d","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},"accessToken":{"name":"accessToken","type":"option","char":"t","description":"Access token for private github repo","required":false},"appType":{"name":"appType","type":"option","char":"s","description":"Sample or Starter app","hidden":true,"required":false}},"args":[]}}}
+{"version":"1.0.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 -d <path/to/setup/the/app>","$ csdx cm:bootstrap -t <github access token>"],"flags":{"appName":{"name":"appName","type":"option","char":"a","description":"App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter","required":false},"directory":{"name":"directory","type":"option","char":"d","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},"accessToken":{"name":"accessToken","type":"option","char":"t","description":"Access token for private github repo","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.0.0",
+  "version": "1.0.3",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "scripts": {
@@ -18,8 +18,8 @@
   },
   "dependencies": {
     "@contentstack/cli-command": "^0.1.1-beta.1",
-    "@contentstack/cli-cm-seed": "1.0.6",
-    "@contentstack/management": "^1.2.1",
+    "@contentstack/cli-cm-seed": "^1.0.7",
+    "@contentstack/management": "^1.2.4",
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
     "axios": "^0.21.1",
@@ -53,6 +53,7 @@
   },
   "files": [
     "/lib",
+    "/messages",
     "/npm-shrinkwrap.json",
     "/oclif.manifest.json"
   ],