✨ refactor(app): 统一内外命令的格式,并支持挂载询问模式

Author: OSpoon

src/command/eslint-fix.ts

@@ -0,0 +1,45 @@
+import type { CAC } from "cac";
+
+import { ACTIVATION, eslintGlob } from "@/config";
+import { execCommand } from "@/helper";
+import { loggerError, loggerInfo, printError, printInfo } from "@/logger";
+import { CommandsOptions } from "@/types";
+
+export const eslintFix = async (paths: string[]) => {
+  if (ACTIVATION) {
+    loggerInfo(`eslintFix 参数信息: \n ${paths}`);
+  }
+
+  try {
+    await execCommand("npx", ["eslint", "--fix", ...paths], {
+      stdio: "inherit",
+    });
+    printInfo("代码已通过 eslint 校验");
+  } catch (error) {
+    printError(`代码未通过 eslint 校验`);
+    loggerError(error);
+    process.exit(1);
+  }
+};
+
+export default function eslintFixInstaller(config: CommandsOptions) {
+  const { fix } = config;
+  return {
+    name: "fix",
+    describe: "运行 eslint 静态扫描和修复代码中存在的问题",
+    command: "fix",
+    setup: (cli: CAC) => {
+      cli
+        .command("fix", "运行 eslint 静态扫描和修复代码中存在的问题")
+        .option("-p, --pattern <pattern>", "设置匹配规则")
+        .action(async (options) => {
+          let paths = fix?.paths || eslintGlob;
+          const { pattern } = options;
+          if (pattern) {
+            paths = typeof pattern === "string" ? [pattern] : pattern;
+          }
+          await eslintFix(paths);
+        });
+    },
+  };
+}

src/command/eslint-fix/index.ts

@@ -3,8 +3,14 @@ import type { CAC } from "cac";
 import enquirer from "enquirer";
 
 import { ACTIVATION, gitCommitScopes, gitCommitTypes } from "@/config";
-import { execCommand, loadConfigModule, loggerInfo } from "@/helper";
-import { GitCommitOptions } from "@/types";
+import { execCommand } from "@/helper";
+import { loggerInfo } from "@/logger";
+import {
+  CommandsOptions,
+  CommitScope,
+  CommitType,
+  GitCommitOptions,
+} from "@/types";
 
 const schema = {
   type: "object",
@@ -16,26 +22,12 @@ const schema = {
   required: ["type", "scope", "description"],
 };
 
-const mergeConfig = async () => {
-  const config = await loadConfigModule();
-  const commands = config && config?.commands;
-  if (commands && commands.commit) {
-    const { gitCommitTypes: types, gitCommitScopes: scopes } = commands.commit;
-    return {
-      types: types && types.length > 0 ? types : gitCommitTypes,
-      scopes: scopes && scopes.length > 0 ? scopes : gitCommitScopes,
-    };
-  }
-  return {
-    types: gitCommitTypes,
-    scopes: gitCommitScopes,
-  };
-};
-
-const generateEnquirer = async (): Promise<
+const generateEnquirer = async (
+  types: Array<CommitType>,
+  scopes: Array<CommitScope>,
+): Promise<
   Pick<GitCommitOptions, Exclude<keyof GitCommitOptions, "emoji">>
 > => {
-  const { types, scopes } = await mergeConfig();
   const typesChoices = types.map(({ emoji, code, description }) => {
     const formatCode = `${code}:`.padEnd(20);
     return {
@@ -116,10 +108,13 @@ export const gitCommit = async (
   );
 };
 
-export default function gitCommitInstaller(cli: CAC) {
+export default function gitCommitInstaller(config: CommandsOptions) {
+  const { commit } = config;
   return {
-    name: "gitCommitInstaller",
-    setup: () => {
+    name: "commit",
+    describe: "生成 angualr 规范的提交信息",
+    command: "commit --ask",
+    setup: (cli: CAC) => {
       cli
         .command("commit", "生成 angualr 规范的提交信息")
         .option("-t, --type <type>", "添加修改类型")
@@ -128,8 +123,10 @@ export default function gitCommitInstaller(cli: CAC) {
         .option("-a, --ask", "启用询问模式")
         .action(async (options) => {
           const { type, scope, description, ask } = options;
+          const types = commit?.gitCommitTypes || gitCommitTypes;
+          const scopes = commit?.gitCommitScopes || gitCommitScopes;
           if (ask) {
-            const result = await generateEnquirer();
+            const result = await generateEnquirer(types, scopes);
             await gitCommit(result.type, result.scope, result.description);
           } else {
             await gitCommit(type, scope, description);

src/command/git-commit.ts renamed to src/command/git-commit/index.ts

@@ -2,16 +2,16 @@ import type { CAC } from "cac";
 import enquirer from "enquirer";
 import updateNotifier from "simple-update-notifier";
 
-import { commands } from "@/config";
 import { execCommand } from "@/helper";
+import { CommandOptions } from "@/types";
 
 import pkg from "../../package.json";
 
 interface PromptResult {
   command: string;
 }
 
-export const root = async () => {
+export const root = async (commands: Array<CommandOptions>) => {
   updateNotifier({ pkg });
   const commandChoices = commands.map(({ display, command, description }) => {
     const formatCommand = `${display || command}`.padEnd(15);
@@ -31,16 +31,16 @@ export const root = async () => {
   await execCommand("codeg", result.command.split(" "), { stdio: "inherit" });
 };
 
-export default function rootInstaller(cli: CAC) {
+export default function rootInstaller(commands: Array<CommandOptions>) {
   return {
     name: "rootInstaller",
-    setup: () => {
+    setup: (cli: CAC) => {
       cli
         .command("[root]", "启动 CodeGenius 命令行选项模式 ")
         .alias("start")
         .alias("dev")
         .action(async () => {
-          await root();
+          await root(commands);
         });
     },
   };

src/command/root.ts

@@ -4,7 +4,7 @@ import type { CAC } from "cac";
 import enquirer from "enquirer";
 import fsExtra from "fs-extra";
 
-import { generateScripts } from "@/helper";
+import { generateScripts } from "@/command/script/utils";
 import { execCommand } from "@/helper";
 import { CommandOptions } from "@/types";
 
@@ -14,10 +14,10 @@ export async function scriptRun() {
   );
 
   const scriptChoices = scripts.map((script: CommandOptions) => {
-    const formatCmd = `${script.cmd}`.padEnd(15);
+    const formatCmd = `${script.display}`.padEnd(15);
     return {
-      name: script.script,
-      message: `${formatCmd} ${script.desc}`,
+      name: script.command,
+      message: `${formatCmd} ${script.description}`,
     };
   });
 
@@ -44,10 +44,12 @@ export async function scriptRun() {
   }
 }
 
-export default function scriptRunInstaller(cli: CAC) {
+export default function scriptRunInstaller() {
   return {
-    name: "scriptRunInstaller",
-    setup: () => {
+    name: "script",
+    describe: "代理运行 package.scripts 脚本",
+    command: "script",
+    setup: (cli: CAC) => {
       cli
         .command("script", "代理运行 package.scripts 脚本")
         .action(async () => {

src/command/script.ts renamed to src/command/script/index.ts

@@ -0,0 +1,81 @@
+import fs from "node:fs";
+import path from "node:path";
+
+import fsExtra from "fs-extra";
+
+import { printInfo } from "@/logger";
+import { CommandOptions } from "@/types";
+
+/**
+ * 用于转换 scripts 结构
+ * @param scripts
+ * @returns
+ */
+export function genScriptConfig(scripts: { [key: string]: string }) {
+  return Object.keys(scripts).map((key) => {
+    return {
+      command: key,
+      display: scripts[key],
+      description: "description the function of this cmd command",
+    };
+  });
+}
+
+/**
+ * 用于合并两份 scripts.config.json 数据
+ * @param pkgScripts
+ * @param configScripts
+ * @returns
+ */
+export function syncScripts(
+  pkgScripts: Array<CommandOptions>,
+  configScripts: Array<CommandOptions>,
+) {
+  const mergedScripts = [...configScripts];
+
+  for (const pkgScript of pkgScripts) {
+    const configScript = mergedScripts.find(
+      (i) => i.command === pkgScript.command,
+    );
+
+    if (configScript) {
+      if (configScript.display !== pkgScript.display) {
+        configScript.display = pkgScript.display;
+      }
+    } else {
+      mergedScripts.push(pkgScript);
+    }
+  }
+
+  const scripts = mergedScripts.filter((configScript) => {
+    return pkgScripts.find((i) => i.command === configScript.command);
+  });
+
+  return scripts;
+}
+
+/**
+ * 读取 package.json 解析并生成 scripts.config.json 配置文件
+ */
+export const generateScripts = async () => {
+  const pkg = await fsExtra.readJSONSync(
+    path.join(process.cwd(), "package.json"),
+  );
+  let configContent = genScriptConfig(pkg.scripts);
+  const configfile = path.join(process.cwd(), "scripts.config.json");
+  if (fs.existsSync(configfile)) {
+    const { scripts } = await fsExtra.readJSONSync(configfile);
+    configContent = syncScripts(configContent, scripts);
+  }
+  await fsExtra.outputFileSync(
+    configfile,
+    JSON.stringify(
+      {
+        scripts: configContent,
+      },
+      null,
+      2,
+    ),
+  );
+  printInfo("代理脚本 scripts.config.json 已完成同步");
+};

src/command/script/utils.ts

@@ -92,28 +92,16 @@ export const gitCommitScopes: Array<CommitScope> = [
   },
 ];
 
-export const commands = [
+export const defaultCommands = [
   {
-    command: "commit --ask",
-    description: "生成 angualr 规范的提交信息",
-  },
-  {
-    command: "fix",
-    description: "运行 eslint 静态扫描和修复代码中存在的问题",
-  },
-  {
-    command: "script",
-    description: "代理执行 package.scripts 脚本",
+    display: "version",
+    command: "--version",
+    description: "查看版本号",
   },
   {
     display: "help",
     command: "--help",
-    description: "查看 CodeGenius 终端命令",
-  },
-  {
-    display: "version",
-    command: "--version",
-    description: "查看 CodeGenius 版本信息",
+    description: "查看帮助信息",
   },
 ];