feat: add new command (generate-templates)

Author: js2me

cli/execute.js

@@ -13,6 +13,7 @@ const execute = (params, commands, instance) => {
 
     if (error) {
       reject(new Error(error));
+      return;
     }
 
     if (!usageOptions.length && command.name === root_command) {
@@ -91,9 +92,22 @@ const processArgs = (commands, args) => {
     if (error) return;
 
     if (i === 0) {
-      command = commands[arg] || commands[root_command];
-      allFlagKeys = command.options.reduce((acc, option) => [...acc, ...option.flags.keys], []);
+      command = commands[arg];
+
+      if (!command && !arg.startsWith("-")) {
+        const tip = didYouMean(arg, _.keys(commands));
+        error = `unknown command ${arg}${tip ? `\n(Did you mean ${tip} ?)` : ""}`;
+      } else if (!command) {
+        command = commands[root_command];
+      }
+
+      if (command) {
+        allFlagKeys = command.options.reduce((acc, option) => [...acc, ...option.flags.keys], []);
+      }
     }
+
+    if (error) return;
+
     if (arg.startsWith("-")) {
       const option = command.options.find((option) => option.flags.keys.includes(arg));
 
@@ -127,6 +141,14 @@ const processArgs = (commands, args) => {
   });
   command = command || commands[root_command];
 
+  if (error) {
+    return {
+      command: null,
+      usageOptions: [],
+      error,
+    };
+  }
+
   return {
     command,
     usageOptions,

cli/index.js

@@ -8,13 +8,33 @@ const { displayVersion } = require("./operations/display-version");
 const cli = (input) => {
   const commands = {};
 
-  const addCommand = (command) => {
+  const addCommand = (command, { addVersion = false, addHelp = true } = {}) => {
     commands[command.name] = {
       name: command.name,
       description: `${command.description || ""}`,
       options: _.compact(_.map(command.options, processOption)),
     };
 
+    if (addVersion) {
+      commands[command.name].options.unshift(
+        processOption({
+          flags: "-v, --version",
+          description: "output the current version",
+          operation: () => displayVersion(instance),
+        }),
+      );
+    }
+
+    if (addHelp) {
+      commands[command.name].options.push(
+        processOption({
+          flags: "-h, --help",
+          description: "display help for command",
+          operation: () => displayHelp(commands, instance, commands[command.name]),
+        }),
+      );
+    }
+
     return instance;
   };
 
@@ -25,10 +45,16 @@ const cli = (input) => {
     execute: (params) => execute(params, commands, instance),
   };
 
-  addCommand({
-    name: root_command,
-    options: [],
-  });
+  addCommand(
+    {
+      name: root_command,
+      options: [],
+    },
+    {
+      addVersion: false,
+      addHelp: false,
+    },
+  );
 
   _.forEach(input.options, (option) => {
     const processed = processOption(option);
@@ -55,7 +81,7 @@ const cli = (input) => {
     processOption({
       flags: "-h, --help",
       description: "display help for command",
-      operation: () => displayHelp(commands, instance),
+      operation: () => displayHelp(commands, instance, commands[root_command]),
     }),
   );
 

cli/operations/display-help.js

@@ -1,33 +1,56 @@
 const _ = require("lodash");
 const { root_command } = require("../constants");
 
-const displayHelp = (commands, instance) => {
-  const generateOptionsOutput = (options) =>
-    options.reduce(
-      (acc, option) => {
-        const flags = `${option.flags.keys.join(", ")}${option.flags.value?.raw ? ` ${option.flags.value?.raw}` : ""}`;
-        const description = `${option.description || ""}${
-          option.default === undefined || (option.flags.isNoFlag && option.default === true)
-            ? ""
-            : ` (default: ${typeof option.default === "string" ? `"${option.default}"` : option.default})`
-        }`;
-
-        if (flags.length > acc.maxLength) {
-          acc.maxLength = flags.length;
-        }
-
-        acc.options.push({
-          flags,
-          description,
-        });
-        return acc;
-      },
-      {
-        options: [],
-        maxLength: 0,
-      },
-    );
+const generateOptionsOutput = (options) =>
+  options.reduce(
+    (acc, option) => {
+      const flags = `${option.flags.keys.join(", ")}${option.flags.value?.raw ? ` ${option.flags.value?.raw}` : ""}`;
+      const description = `${option.description || ""}${
+        option.default === undefined || (option.flags.isNoFlag && option.default === true)
+          ? ""
+          : ` (default: ${typeof option.default === "string" ? `"${option.default}"` : option.default})`
+      }`;
+
+      if (flags.length > acc.maxLength) {
+        acc.maxLength = flags.length;
+      }
+
+      acc.options.push({
+        flags,
+        description,
+      });
+      return acc;
+    },
+    {
+      options: [],
+      maxLength: 0,
+    },
+  );
+
+const generateOptionsTextOutput = (options, maxLength, spaces) =>
+  options
+    .map((option) => {
+      const spacesText = Array(spaces).fill(" ").join("");
+      const leftStr = `${spacesText}${option.flags.padEnd(maxLength, " ")}  `;
+      const leftStrFiller = Array(leftStr.length).fill(" ").join("");
+      const descriptionLines = option.description.split("\n");
+
+      return (
+        leftStr +
+        descriptionLines
+          .map((line, i) => {
+            if (i === 0) {
+              return line;
+            }
+
+            return `\n${leftStrFiller}${line}`;
+          })
+          .join("")
+      );
+    })
+    .join("\n");
 
+const displayAllHelp = (commands, instance) => {
   const { options, maxLength: maxOptionLength } = generateOptionsOutput(commands[root_command].options);
 
   const { commands: commandLabels, maxLength: maxCommandLength } = _.filter(
@@ -57,29 +80,6 @@ const displayHelp = (commands, instance) => {
     },
   );
 
-  const generateOptionsTextOutput = (options, maxLength, spaces) =>
-    options
-      .map((option) => {
-        const spacesText = Array(spaces).fill(" ").join("");
-        const leftStr = `${spacesText}${option.flags.padEnd(maxLength, " ")}  `;
-        const leftStrFiller = Array(leftStr.length).fill(" ").join("");
-        const descriptionLines = option.description.split("\n");
-
-        return (
-          leftStr +
-          descriptionLines
-            .map((line, i) => {
-              if (i === 0) {
-                return line;
-              }
-
-              return `\n${leftStrFiller}${line}`;
-            })
-            .join("")
-        );
-      })
-      .join("\n");
-
   const optionsOutput = generateOptionsTextOutput(options, maxOptionLength, 2);
 
   const commandsOutput = commandLabels
@@ -128,6 +128,30 @@ ${instance.input.description}`
 ${outputTest}`);
 };
 
+const displayHelp = (commands, instance, command) => {
+  if (command.name === root_command) return displayAllHelp(commands, instance);
+
+  const { options, maxLength: maxOptionLength } = generateOptionsOutput(command.options);
+  const optionsOutput = generateOptionsTextOutput(options, maxOptionLength, 2);
+
+  const outputTest = [
+    optionsOutput &&
+      `Options:
+${optionsOutput}`,
+  ]
+    .filter(Boolean)
+    .join("\n\n");
+
+  console.log(`Usage: ${instance.input.name} ${command.name}${optionsOutput ? " [options]" : ""}
+${
+  command.description &&
+  `
+${command.description}`
+}
+
+${outputTest}`);
+};
+
 module.exports = {
   displayHelp,
 };

index.d.ts

@@ -1,3 +1,5 @@
+type HttpClientType = "axios" | "fetch";
+
 interface GenerateApiParamsBase {
   /**
    * default 'api.ts'
@@ -34,7 +36,7 @@ interface GenerateApiParamsBase {
   /**
    * generated http client type
    */
-  httpClientType?: "axios" | "fetch";
+  httpClientType?: HttpClientType;
   /**
    * use "default" response status code as success response too.
    * some swagger schemas use "default" response status code as success response type by default.
@@ -499,3 +501,15 @@ export interface GenerateApiOutput {
 }
 
 export declare function generateApi(params: GenerateApiParams): Promise<GenerateApiOutput>;
+
+export interface GenerateTemplatesParams {
+  cleanOutput?: boolean;
+  output?: string;
+  httpClientType?: HttpClientType;
+  modular?: boolean;
+  silent?: boolean;
+}
+
+export interface GenerateTemplatesOutput extends Pick<GenerateApiOutput, "files" | "createFile"> {}
+
+export declare function generateTemplates(params: GenerateTemplatesParams): Promise<GenerateTemplatesOutput>;