Merge pull request #275 from contentstack/fix/dx-544-update-documentation

updated with a flag and added example

Author: harshithad0703

README.md

@@ -20,7 +20,7 @@ $ npm install -g @contentstack/apps-cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/apps-cli/1.2.1 darwin-arm64 node-v18.20.2
+@contentstack/apps-cli/1.3.0 darwin-arm64 node-v18.16.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -67,22 +67,24 @@ EXAMPLES
   $ csdx app:reinstall
 ```
 
-_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/index.ts)_
+_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/index.ts)_
 
 ## `csdx app:create`
 
 Create a new app in Developer Hub and optionally clone a boilerplate locally.
 
 ```
 USAGE
-  $ csdx app:create [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>]
+  $ csdx app:create [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>] [--boilerplate
+    <value>]
 
 FLAGS
   -c, --config=<value>    Path of the external config
   -d, --data-dir=<value>  Current working directory.
   -n, --name=<value>      [default: app-boilerplate] Name of the app to be created
   --app-type=<option>     [default: stack] Type of app
                           <options: stack|organization>
+  --boilerplate=<value>   Choose a boilerplate from search list
 
 DESCRIPTION
   Create a new app in Developer Hub and optionally clone a boilerplate locally.
@@ -95,9 +97,11 @@ EXAMPLES
   $ csdx app:create --name App-2 --app-type stack -d ./boilerplate
 
   $ csdx app:create --name App-3 --app-type organization --org <UID> -d ./boilerplate -c ./external-config.json
+
+  $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplates <boilerplate-name>
 ```
 
-_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/create.ts)_
 
 ## `csdx app:delete`
 
@@ -121,7 +125,7 @@ EXAMPLES
   $ csdx app:delete --app-uid <value> --org <value> -d ./boilerplate
 ```
 
-_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/delete.ts)_
+_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/delete.ts)_
 
 ## `csdx app:deploy`
 
@@ -158,7 +162,7 @@ EXAMPLES
   $ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <Hosting with Launch> --launch-project <new> --config <config-path>
 ```
 
-_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/deploy.ts)_
+_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/deploy.ts)_
 
 ## `csdx app:get`
 
@@ -187,7 +191,7 @@ EXAMPLES
   $ csdx app:get --org <value> --app-uid <value> --app-type organization
 ```
 
-_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/get.ts)_
+_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/get.ts)_
 
 ## `csdx app:install`
 
@@ -212,7 +216,7 @@ EXAMPLES
   $ csdx app:install --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
 ```
 
-_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/install.ts)_
+_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/install.ts)_
 
 ## `csdx app:reinstall`
 
@@ -237,7 +241,7 @@ EXAMPLES
   $ csdx app:reinstall --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
 ```
 
-_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/reinstall.ts)_
+_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/reinstall.ts)_
 
 ## `csdx app:uninstall`
 
@@ -263,7 +267,7 @@ EXAMPLES
   $ csdx app:uninstall --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>
 ```
 
-_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/uninstall.ts)_
+_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/uninstall.ts)_
 
 ## `csdx app:update`
 
@@ -285,5 +289,5 @@ EXAMPLES
   $ csdx app:update --app-manifest ./boilerplate/manifest.json
 ```
 
-_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/update.ts)_
+_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/update.ts)_
 <!-- commandsstop -->

src/commands/app/create.ts

@@ -34,6 +34,7 @@ import {
   getOrgAppUiLocation,
   sanitizePath,
   selectedBoilerplate,
+  validateBoilerplate,
 } from "../../util";
 
 export default class Create extends BaseCommand<typeof Create> {
@@ -52,6 +53,7 @@ export default class Create extends BaseCommand<typeof Create> {
     "$ <%= config.bin %> <%= command.id %> --name App-1 --app-type stack",
     "$ <%= config.bin %> <%= command.id %> --name App-2 --app-type stack -d ./boilerplate",
     "$ <%= config.bin %> <%= command.id %> --name App-3 --app-type organization --org <UID> -d ./boilerplate -c ./external-config.json",
+    "$ <%= config.bin %> <%= command.id %> --name App-4 --app-type organization --org <UID> --boilerplates <boilerplate-name>",
   ];
 
   static flags: FlagInput = {
@@ -73,11 +75,15 @@ export default class Create extends BaseCommand<typeof Create> {
       char: "d",
       description: commonMsg.CURRENT_WORKING_DIR,
     }),
+    "boilerplate": flags.string({
+      description: appCreate.BOILERPLATE_TEMPLATES,
+    }),
   };
 
   async run(): Promise<void> {
     this.sharedConfig.org = this.flags.org;
     this.sharedConfig.appName = this.flags.name;
+    this.sharedConfig.boilerplateName = this.flags.boilerplate;
 
     await this.flagsPromptQueue();
 
@@ -97,18 +103,7 @@ export default class Create extends BaseCommand<typeof Create> {
           message: this.messages.CONFIRM_CLONE_BOILERPLATE,
         }))
       ) {
-        const boilerplate: BoilerplateAppType = await selectedBoilerplate();
-
-        if (boilerplate) {
-          this.sharedConfig.boilerplateName = boilerplate.name
-            .toLowerCase()
-            .replace(/ /g, "-");
-          this.sharedConfig.appBoilerplateGithubUrl = boilerplate.link;
-          this.sharedConfig.appName = await getAppName(
-            this.sharedConfig.boilerplateName
-          );
-          await this.boilerplateFlow();
-        }
+        await this.boilerplateFlow();
       } else {
         this.manageManifestToggeling();
         await this.registerTheAppOnDeveloperHub(false);
@@ -160,6 +155,22 @@ export default class Create extends BaseCommand<typeof Create> {
         this.sharedConfig.defaultAppName
       );
     }
+    if (isEmpty(this.sharedConfig.boilerplateName)) {
+      const boilerplate: BoilerplateAppType = await selectedBoilerplate();
+
+      if (boilerplate) {
+        this.sharedConfig.boilerplateName = boilerplate.name
+          .toLowerCase()
+          .replace(/ /g, "-");
+        this.sharedConfig.appBoilerplateGithubUrl = boilerplate.link;
+        this.sharedConfig.appName = await getAppName(
+          this.sharedConfig.boilerplateName
+        );
+      }
+    } else {
+      await validateBoilerplate(this.sharedConfig.boilerplateName);
+    }
+    this.sharedConfig.appName = this.sharedConfig.boilerplateName;
 
     //Auto select org in case of oauth
     this.sharedConfig.org =
@@ -314,10 +325,7 @@ export default class Create extends BaseCommand<typeof Create> {
         this.appData = merge(this.appData, pick(response, validKeys));
         if (saveManifest) {
           writeFileSync(
-            resolve(
-              this.sharedConfig.folderPath,
-              "manifest.json"
-            ),
+            resolve(this.sharedConfig.folderPath, "manifest.json"),
             JSON.stringify(this.appData),
             {
               encoding: "utf8",

src/config/index.ts

@@ -3,7 +3,6 @@ import { resolve } from "path";
 const config = {
   defaultAppName: "app-boilerplate",
   manifestPath: resolve(__dirname, "manifest.json"),
-  boilerplateName: "marketplace-app-boilerplate-main",
   developerHubBaseUrl: "",
   appBoilerplateGithubUrl:
     "https://codeload.github.com/contentstack/marketplace-app-boilerplate/zip/refs/heads/main",

src/messages/index.ts

@@ -58,6 +58,7 @@ const appCreate = {
   REGISTER_THE_APP_ON_DEVELOPER_HUB:
     "Registering the app with the name {appName} on the Developer Hub...",
   START_APP_COMMAND: "Start the app using the following command: {command}",
+  BOILERPLATE_TEMPLATES: "Choose a boilerplate from search list"
 };
 
 const getAppMsg = {

src/util/common-utils.ts

@@ -21,6 +21,7 @@ import {
 import { askProjectName } from "./inquirer";
 import { deployAppMsg } from "../messages";
 import config from "../config";
+import find from "lodash/find";
 
 export type CommonOptions = {
   log: LogFn;
@@ -406,6 +407,17 @@ async function fetchBoilerplateDetails(): Promise<Record<string, any>[]> {
     throw error;
   }
 }
+async function validateBoilerplate(boilerplateName: string): Promise<void> {
+  const boilerplates = await fetchBoilerplateDetails();
+  const isValid = find(
+    boilerplates,
+    (boilerplate) => boilerplate.name.toLowerCase()
+    .replace(/ /g, "-") === boilerplateName
+  );
+  if (!isValid) {
+    throw new Error("Invalid boilerplate. Please enter a valid boilerplate.");
+  }
+}
 
 export {
   getOrganizations,
@@ -428,5 +440,6 @@ export {
   disconnectApp,
   formatUrl,
   handleProjectNameConflict,
-  fetchBoilerplateDetails
+  fetchBoilerplateDetails,
+  validateBoilerplate,
 };

src/util/inquirer.ts

@@ -14,6 +14,7 @@ import { AppTarget } from "@contentstack/management/types/app/index";
 
 import messages, {
   $t,
+  appCreate,
   deployAppMsg,
   errors,
   uninstallAppMsg,
@@ -394,7 +395,7 @@ const selectedBoilerplate = async (): Promise<any> => {
       type: "search-list",
       name: "App",
       choices: boilerplates.map((bp) => bp.name),
-      message: "Select a boilerplate from search list",
+      message: appCreate.BOILERPLATE_TEMPLATES,
     })
     .then((name) => {
       return find(boilerplates, (boilerplate) => boilerplate.name === name);