✨refactor(app): 重构命令已codeg启动,并增加交互式启动方式

Author: OSpoon

README.md

@@ -25,7 +25,6 @@ npm i -g code-genius
 | clear      | --pattern \<pattern\>                                                                    | './dist/' | 运行 rimraf 删除不再需要的文件或文件夹              |
 | hooks      | --                                                                                       | --        | 新增或修改 simple-git-hooks 配置后需要重新初始化    |
 | depcheck   | --                                                                                       | --        | 运行 npm-check 检查过时的、不正确的和未使用的依赖项 |
-| run        | --                                                                                       | --        | 列出可以运行的全部脚本                              |
 | registry   | --                                                                                       | --        | 切换 NPM 镜像地址                                   |
 | fix        | --pattern \<pattern\>                                                                    | './src'   | 运行 eslint 静态扫描和修复代码中存在的问题          |
 | format     | --pattern \<pattern\>                                                                    | './src'   | 运行 prettier 格式化代码风格                        |

package.json

@@ -31,6 +31,7 @@
   "types": "dist/index.d.ts",
   "bin": {
     "cg": "./bin/codeGenius.mjs",
+    "codeg": "./bin/codeGenius.mjs",
     "code-genius": "./bin/codeGenius.mjs"
   },
   "files": [

src/cli.ts

@@ -1,35 +1,17 @@
-import cac, { CAC } from "cac";
+import cac from "cac";
 
 import { handleError } from "@/shared/index";
 
 import pkg from "../package.json";
 import { cmdInstaller } from "./setup";
 
-import updateNotifier from "simple-update-notifier";
-
-function welcome(cli: CAC) {
-  cli.outputHelp();
-}
-
 export const setupCli = async () => {
-  const cli = cac("cg");
-  cli.command("");
+  const cli = cac("codeg");
 
   cmdInstaller(cli);
 
   cli.help();
   cli.version(pkg.version);
-  cli.command("update", "检测 CodeGenius 版本").action(() => {
-    updateNotifier({ pkg, alwaysRun: true });
-  });
-
-  cli.on("command:!", () => {
-    welcome(cli);
-  });
-
-  cli.on("command:*", () => {
-    welcome(cli);
-  });
 
   cli.parse(process.argv, { run: false });
 

src/command/root.ts

@@ -0,0 +1,47 @@
+import type { CAC } from "cac";
+
+import enquirer from "enquirer";
+import updateNotifier from "simple-update-notifier";
+
+import { execCommand } from "@/shared/index";
+import { commands } from "@/shared/config";
+import pkg from "../../package.json";
+
+interface PromptResult {
+  command: string;
+}
+
+export const root = async () => {
+  updateNotifier({ pkg });
+  const commandChoices = commands.map(({ display, command, description }) => {
+    const formatCommand = `${display || command}`.padEnd(15);
+    return {
+      name: command,
+      message: `${formatCommand}${description}`,
+    };
+  });
+  const result = await enquirer.prompt<PromptResult>([
+    {
+      name: "command",
+      type: "select",
+      message: "请选择正确执行的 CodeG 命令",
+      choices: commandChoices,
+    },
+  ]);
+  await execCommand("codeg", [result.command], { stdio: "inherit" });
+};
+
+export default function rootInstaller(cli: CAC) {
+  return {
+    name: "rootInstaller",
+    setup: () => {
+      cli
+        .command("[root]", "启动 CodeGenius 命令行选项模式 ")
+        .alias("start")
+        .alias("dev")
+        .action(async () => {
+          await root();
+        });
+    },
+  };
+}

src/setup.ts

@@ -1,12 +1,12 @@
 import type { CAC } from "cac";
 
+import rootInstaller from "./command/root";
 import createProjectInstaller from "./command/create-project";
 import clearInstaller from "./command/clear";
 import gitCommitInstaller from "./command/git-commit";
 import gitCommitVerifyInstaller from "./command/git-commit-verify";
 import gitInitSimpleHooksInstaller from "./command/git-init-hooks";
 import npmDepCheckInstaller from "./command/npm-dep-check";
-import npmRunInstaller from "./command/npm-run";
 import npmRegistryInstaller from "./command/npm-registry";
 import eslintFixInstaller from "./command/eslint-fix";
 import prettierFormatInstaller from "./command/prettier-format";
@@ -16,6 +16,7 @@ import gitUserInstaller from "./command/git-user";
 import quantityInstaller from "./command/quantity";
 
 export function cmdInstaller(cli: CAC) {
+  rootInstaller(cli).setup();
   gitCommitInstaller(cli).setup();
   gitCommitVerifyInstaller(cli).setup();
   gitUserInstaller(cli).setup();
@@ -29,5 +30,4 @@ export function cmdInstaller(cli: CAC) {
   templateInstaller(cli).setup();
   lighthouseInstaller(cli).setup();
   quantityInstaller(cli).setup();
-  npmRunInstaller(cli).setup();
 }

src/shared/config.ts

@@ -190,3 +190,68 @@ export const gitUserOptions: GitUserOptions = {
   ruleEmail:
     "^[a-zA-Z0-9._%+-]+@(163|qq|126|139|sina|sohu|yeah|gmail)\\.(com|net)$",
 };
+
+export const commands = [
+  {
+    command: "commit",
+    description: "生成 angualr 规范的提交信息",
+  },
+  {
+    command: "verify",
+    description: "校验 COMMIT_EDITMSG 中的信息是否符合 Angualr 规范",
+  },
+  {
+    command: "git-user",
+    description: "设置或校验 git user 信息是否规范",
+  },
+  {
+    command: "hooks",
+    description: "新增或修改 simple-git-hooks 配置后需要重新初始化",
+  },
+  {
+    command: "registry",
+    description: "切换 NPM 镜像地址",
+  },
+  {
+    command: "clear",
+    description: "运行 rimraf 删除不再需要的文件或文件夹",
+  },
+  {
+    command: "depcheck",
+    description: "运行 depcheck 检查过时的、不正确的和未使用的依赖项",
+  },
+  {
+    command: "fix",
+    description: "运行 eslint 静态扫描和修复代码中存在的问题",
+  },
+  {
+    command: "format",
+    description: "运行 prettier 格式化代码风格",
+  },
+  {
+    command: "create",
+    description: "运行 npm create 快速创建基础项目",
+  },
+  {
+    command: "template",
+    description: "运行 cg 生成 CodeGenius 内置模板项目",
+  },
+  {
+    command: "lighthouse",
+    description: "运行 lighthouse 分析及收集 Web 应用的性能指标",
+  },
+  {
+    command: "quantity",
+    description: "运行 cloc 分析并统计代码量",
+  },
+  {
+    display: "help",
+    command: "--help",
+    description: "查看 CodeGenius 终端命令",
+  },
+  {
+    display: "version",
+    command: "--version",
+    description: "查看 CodeGenius 版本信息",
+  },
+];

src/shared/index.ts

@@ -21,7 +21,7 @@ const boxenBorderStyle = {
     top: "-",
     bottom: "-",
     left: "|",
-    right: "",
+    right: "|",
   },
 };