Merge pull request #278 from contentstack/fix/DX-992

fix: invalid boilerplate error
contentstack · Jul 24, 2024 · 02ce60c · 02ce60c
2 parents 3b4fe60 + 17d1b5c
commit 02ce60c
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -81,10 +81,11 @@ USAGE
 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
+  -n, --name=<value>      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
+  --boilerplate=<value>   Provide a boilerplate from the following options: App Boilerplate, DAM App Boilerplate or
+                          Ecommerce App Boilerplate
 
 DESCRIPTION
   Create a new app in Developer Hub and optionally clone a boilerplate locally.
@@ -98,7 +99,11 @@ EXAMPLES
 
   $ 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>
+  $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <App Boilerplate>
+
+  $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <DAM App Boilerplate>
+
+  $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <Ecommerce App Boilerplate>
 ```
 
 _See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/create.ts)_

diff --git a/src/commands/app/create.ts b/src/commands/app/create.ts
@@ -35,6 +35,7 @@ import {
   sanitizePath,
   selectedBoilerplate,
   validateBoilerplate,
+  validateAppName,
 } from "../../util";
 
 export default class Create extends BaseCommand<typeof Create> {
@@ -53,13 +54,14 @@ 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>",
+    "$ <%= config.bin %> <%= command.id %> --name App-4 --app-type organization --org <UID> --boilerplate <App Boilerplate>",
+    "$ <%= config.bin %> <%= command.id %> --name App-4 --app-type organization --org <UID> --boilerplate <DAM App Boilerplate>",
+    "$ <%= config.bin %> <%= command.id %> --name App-4 --app-type organization --org <UID> --boilerplate <Ecommerce App Boilerplate>",
   ];
 
   static flags: FlagInput = {
     name: flags.string({
       char: "n",
-      default: "app-boilerplate",
       description: appCreate.NAME_DESCRIPTION,
     }),
     "app-type": flags.string({
@@ -75,7 +77,7 @@ export default class Create extends BaseCommand<typeof Create> {
       char: "d",
       description: commonMsg.CURRENT_WORKING_DIR,
     }),
-    "boilerplate": flags.string({
+    boilerplate: flags.string({
       description: appCreate.BOILERPLATE_TEMPLATES,
     }),
   };
@@ -150,27 +152,32 @@ export default class Create extends BaseCommand<typeof Create> {
    * @memberof Create
    */
   async flagsPromptQueue() {
-    if (isEmpty(this.sharedConfig.appName)) {
-      this.sharedConfig.appName = await getAppName(
-        this.sharedConfig.defaultAppName
-      );
+    if (this.sharedConfig.appName) {
+      validateAppName(this.sharedConfig.appName);
     }
+
+    let boilerplate: BoilerplateAppType | null = null;
     if (isEmpty(this.sharedConfig.boilerplateName)) {
-      const boilerplate: BoilerplateAppType = await selectedBoilerplate();
+      boilerplate = await selectedBoilerplate();
+    } else {
+      boilerplate = (await validateBoilerplate(
+        this.sharedConfig.boilerplateName
+      )) as BoilerplateAppType;
+    }
 
-      if (boilerplate) {
-        this.sharedConfig.boilerplateName = boilerplate.name
+    if (boilerplate) {
+      let boilerplateName = this.sharedConfig.appName || boilerplate.name;
+      if (isEmpty(this.sharedConfig.appName)) {
+        boilerplateName = boilerplateName
           .toLowerCase()
-          .replace(/ /g, "-");
-        this.sharedConfig.appBoilerplateGithubUrl = boilerplate.link;
-        this.sharedConfig.appName = await getAppName(
-          this.sharedConfig.boilerplateName
-        );
+          .replace(/ /g, "-")
+          .substring(0, 20);
       }
-    } else {
-      await validateBoilerplate(this.sharedConfig.boilerplateName);
+
+      this.sharedConfig.boilerplateName = boilerplateName;
+      this.sharedConfig.appBoilerplateGithubUrl = boilerplate.link;
+      this.sharedConfig.appName = boilerplateName;
     }
-    this.sharedConfig.appName = this.sharedConfig.boilerplateName;
 
     //Auto select org in case of oauth
     this.sharedConfig.org =

diff --git a/src/messages/index.ts b/src/messages/index.ts
@@ -58,7 +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"
+  BOILERPLATE_TEMPLATES: "Provide a boilerplate from the following options: App Boilerplate, DAM App Boilerplate or Ecommerce App Boilerplate"
 };
 
 const getAppMsg = {

diff --git a/src/util/common-utils.ts b/src/util/common-utils.ts
@@ -407,16 +407,19 @@ async function fetchBoilerplateDetails(): Promise<Record<string, any>[]> {
     throw error;
   }
 }
-async function validateBoilerplate(boilerplateName: string): Promise<void> {
+
+async function validateBoilerplate(boilerplateName: string) {
   const boilerplates = await fetchBoilerplateDetails();
-  const isValid = find(
+  const boilerplate = find(
     boilerplates,
-    (boilerplate) => boilerplate.name.toLowerCase()
-    .replace(/ /g, "-") === boilerplateName
+    (boilerplate) => boilerplate.name === boilerplateName
   );
-  if (!isValid) {
-    throw new Error("Invalid boilerplate. Please enter a valid boilerplate.");
+  if (!boilerplate) {
+    throw new Error(
+      "Invalid boilerplate! Please select a boilerplate from the following options: App Boilerplate, DAM App Boilerplate or Ecommerce App Boilerplate"
+    );
   }
+  return boilerplate;
 }
 
 export {

diff --git a/src/util/inquirer.ts b/src/util/inquirer.ts
@@ -368,9 +368,7 @@ async function askConfirmation(): Promise<boolean> {
   });
 }
 
-const askProjectName = async (
-  projectName: string,
-): Promise<string> => {
+const askProjectName = async (projectName: string): Promise<string> => {
   return await cliux.inquire({
     type: "input",
     name: "name",
@@ -402,6 +400,11 @@ const selectedBoilerplate = async (): Promise<any> => {
     });
 };
 
+const validateAppName = (name: string) => {
+  if (name.length < 3 || name.length > 20) {
+    throw new Error($t(errors.INVALID_NAME, { min: "3", max: "20" }));
+  }
+};
 export {
   getOrg,
   getAppName,
@@ -418,4 +421,5 @@ export {
   selectProject,
   askProjectName,
   selectedBoilerplate,
+  validateAppName,
 };