✨refactor(core): 重构注册方式

Author: OSpoon

src/cli.ts

@@ -1,20 +1,19 @@
 import cac, { CAC } from "cac";
 
 import { handleError } from "@/shared/index";
-import { commandSet } from "@/setup";
 
 import { version } from "../package.json";
+import { cmdInstaller } from "./setup";
 
 function welcome(cli: CAC) {
   cli.outputHelp();
 }
 
 export const setupCli = async () => {
   const cli = cac("cg");
+  cli.command("");
 
-  Object.keys(commandSet).forEach((key) => {
-    commandSet[key](cli);
-  });
+  cmdInstaller(cli);
 
   cli.help();
   cli.version(version);

src/command/clear.ts

@@ -1,5 +1,7 @@
+import type { CAC } from "cac";
+
 import { execCommand, loggerInfo } from "@/shared/index";
-import { ACTIVATION } from "@/shared/config";
+import { ACTIVATION, clearGlob } from "@/shared/config";
 
 export const clear = async (paths: string[]) => {
   if (ACTIVATION) {
@@ -10,3 +12,23 @@ export const clear = async (paths: string[]) => {
     stdio: "inherit",
   });
 };
+
+export default function clearInstaller(cli: CAC) {
+  return {
+    name: "clearInstaller",
+    setup: () => {
+      cli
+        .command("clear", "运行 rimraf 删除不再需要的文件或文件夹")
+        .option("-p, --pattern <pattern>", "设置配置规则", {
+          default: [...clearGlob],
+        })
+        .action(async (options) => {
+          const patterns =
+            typeof options.pattern === "string"
+              ? [options.pattern]
+              : options.pattern;
+          await clear(patterns);
+        });
+    },
+  };
+}

src/command/create-project.ts

@@ -1,7 +1,9 @@
+import type { CAC } from "cac";
+
 import enquirer from "enquirer";
 
 import { execCommand, loggerInfo } from "@/shared/index";
-import { ACTIVATION } from "@/shared/config";
+import { ACTIVATION, projectSources } from "@/shared/config";
 import { ProjectSource } from "@/shared/types";
 
 interface PromptResult {
@@ -35,3 +37,16 @@ export const createProject = async (sources: ProjectSource[]) => {
     stdio: "inherit",
   });
 };
+
+export default function createProjectInstaller(cli: CAC) {
+  return {
+    name: "createProjectInstaller",
+    setup: () => {
+      cli
+        .command("create", "运行 npm create 快速创建基础项目")
+        .action(async () => {
+          await createProject(projectSources);
+        });
+    },
+  };
+}

src/command/eslint-fix.ts

@@ -1,5 +1,7 @@
+import type { CAC } from "cac";
+
 import { execCommand, loggerInfo } from "@/shared/index";
-import { ACTIVATION } from "@/shared/config";
+import { ACTIVATION, eslintGlob } from "@/shared/config";
 
 export const eslintFix = async (paths: string[]) => {
   if (ACTIVATION) {
@@ -15,3 +17,23 @@ export const eslintFix = async (paths: string[]) => {
     },
   );
 };
+
+export default function eslintFixInstaller(cli: CAC) {
+  return {
+    name: "eslintFixInstaller",
+    setup: () => {
+      cli
+        .command("fix", "运行 eslint 静态扫描和修复代码中存在的问题")
+        .option("-p, --pattern <pattern>", "设置匹配规则", {
+          default: [...eslintGlob],
+        })
+        .action(async (options) => {
+          const patterns =
+            typeof options.pattern === "string"
+              ? [options.pattern]
+              : options.pattern;
+          await eslintFix(patterns);
+        });
+    },
+  };
+}

src/command/git-commit-verify.ts

@@ -1,3 +1,5 @@
+import type { CAC } from "cac";
+
 import { readFileSync } from "node:fs";
 import path from "node:path";
 
@@ -17,3 +19,16 @@ export const gitCommitVerify = async () => {
     process.exit(1);
   }
 };
+
+export default function gitCommitVerifyInstaller(cli: CAC) {
+  return {
+    name: "gitCommitVerifyInstaller",
+    setup: () => {
+      cli
+        .command("verify", "校验 COMMIT_EDITMSG 中的信息是否符合 Angualr 规范")
+        .action(async () => {
+          await gitCommitVerify();
+        });
+    },
+  };
+}

src/command/git-commit.ts

@@ -1,6 +1,8 @@
+import type { CAC } from "cac";
+
 import enquirer from "enquirer";
 
-import { ACTIVATION } from "@/shared/config";
+import { ACTIVATION, gitCommitScopes, gitCommitTypes } from "@/shared/config";
 import { CommitScope, CommitType } from "@/shared/types";
 import { loggerInfo, execCommand } from "@/shared/index";
 interface PromptResult {
@@ -64,3 +66,20 @@ export const gitCommit = async (
   const content = `${result.type}(${result.scope}): ${result.description}`;
   await execCommand("git", ["commit", "-m", content], { stdio: "inherit" });
 };
+
+export default function gitCommitInstaller(cli: CAC) {
+  return {
+    name: "gitCommitInstaller",
+    setup: () => {
+      cli
+        .command("commit", "生成 angualr 规范的提交信息")
+        .option("--no-emoji", "禁用 emoji")
+        .action(async (options) => {
+          const { emoji } = options;
+          await gitCommit(gitCommitTypes, gitCommitScopes, {
+            emoji,
+          });
+        });
+    },
+  };
+}

src/command/git-init-hooks.ts

@@ -1,3 +1,5 @@
+import type { CAC } from "cac";
+
 import path from "node:path";
 import { existsSync } from "node:fs";
 
@@ -20,3 +22,16 @@ export const gitInitSimpleHooks = async (cwd = process.cwd()) => {
   });
   await execCommand("npx", ["simple-git-hooks"], { stdio: "inherit" });
 };
+
+export default function gitInitSimpleHooksInstaller(cli: CAC) {
+  return {
+    name: "gitInitSimpleHooksInstaller",
+    setup: () => {
+      cli
+        .command("hooks", "新增或修改 simple-git-hooks 配置后需要重新初始化")
+        .action(async () => {
+          await gitInitSimpleHooks();
+        });
+    },
+  };
+}

src/command/npm-dep-check.ts

@@ -1,7 +1,25 @@
+import type { CAC } from "cac";
+
 import { execCommand } from "@/shared/index";
 
 export const npmDepCheck = async () => {
   await execCommand("npx", ["npm-check"], {
     stdio: "inherit",
   });
 };
+
+export default function npmDepCheckInstaller(cli: CAC) {
+  return {
+    name: "npmDepCheckInstaller",
+    setup: () => {
+      cli
+        .command(
+          "depcheck",
+          "运行 npm-check 检查过时的、不正确的和未使用的依赖项",
+        )
+        .action(async () => {
+          await npmDepCheck();
+        });
+    },
+  };
+}

src/command/npm-registry.ts

@@ -1,3 +1,5 @@
+import type { CAC } from "cac";
+
 import enquirer from "enquirer";
 
 import { printInfo, printWarring, execCommand } from "@/shared/index";
@@ -44,3 +46,14 @@ export const npmRegistry = async () => {
 
   await printCurrentRegistry();
 };
+
+export default function npmRegistryInstaller(cli: CAC) {
+  return {
+    name: "npmRegistryInstaller",
+    setup: () => {
+      cli.command("registry", "切换 NPM 镜像地址").action(async () => {
+        await npmRegistry();
+      });
+    },
+  };
+}

src/command/npm-run.ts

@@ -1,3 +1,5 @@
+import type { CAC } from "cac";
+
 import path from "node:path";
 import fs from "node:fs/promises";
 
@@ -32,3 +34,14 @@ export const npmRun = async (cwd = process.cwd()) => {
     execCommand(cmd, args, { stdio: "inherit" });
   }
 };
+
+export default function npmRunInstaller(cli: CAC) {
+  return {
+    name: "npmRunInstaller",
+    setup: () => {
+      cli.command("run", "列出可以运行的全部脚本").action(async () => {
+        await npmRun();
+      });
+    },
+  };
+}