✨ refactor(feature): 调整commit启动询问方式，进入ajv参数校验

Author: OSpoon

README.md

@@ -43,12 +43,13 @@ codeg commit -t fix -s feat -d 修复xx功能的xxBug
 | -t, --type \<type\>               | 添加修改类型 |
 | -s, --scope \<scope\>             | 填写修改范围 |
 | -d, --description \<description\> | 填写修改描述 |
+| -a, --ask                         | 启用询问模式 |
 
 ### 询问模式
 
 ```bash
 # 启动询问模式
-codeg commit
+codeg commit --ask
 ```
 
 ```
@@ -419,6 +420,7 @@ codeg format
 # 格式化 src 和 components 文件夹下的文件
 codeg format -p ./src -p ./components
 ```
+
 | 选项                      | 描述         |
 | ------------------------- | ------------ |
 | -p, --pattern \<pattern\> | 设置匹配规则 |

package-lock.json

@@ -75,6 +75,7 @@
     "unbuild": "^2.0.0-rc.0"
   },
   "dependencies": {
+    "ajv": "^8.12.0",
     "cac": "^6.7.14",
     "enquirer": "^2.4.1",
     "eslint": "^8.50.0",

package.json

@@ -1,14 +1,14 @@
 import cac from "cac";
 
-import { cmdInstaller, handleError } from "@/helper";
+import { handleError, setup } from "@/helper";
 import { plugins } from "@/index";
 
 import pkg from "../package.json";
 
 const setupCli = async () => {
   const cli = cac("codeg");
 
-  await cmdInstaller(cli, plugins);
+  await setup(cli, plugins);
 
   cli.help();
   cli.version(pkg.version);

src/cli.ts

@@ -1,12 +1,21 @@
-import { performance } from "node:perf_hooks";
-
+import Ajv from "ajv";
 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";
 
+const schema = {
+  type: "object",
+  properties: {
+    type: { type: "string" },
+    scope: { type: "string" },
+    description: { type: "string" },
+  },
+  required: ["type", "scope", "description"],
+};
+
 const mergeConfig = async () => {
   const config = await loadConfigModule();
   const commands = config && config?.commands;
@@ -60,6 +69,7 @@ const generateEnquirer = async (): Promise<
       name: "description",
       type: "text",
       message: "请输入提交描述",
+      required: true,
     },
     {
       name: "emoji",
@@ -88,6 +98,17 @@ export const gitCommit = async (
       })}`,
     );
   }
+
+  const ajv = new Ajv();
+  const validate = ajv.compile(schema);
+  const valid = validate({
+    type,
+    scope,
+    description,
+  });
+  if (!valid && validate.errors && validate.errors?.length > 0) {
+    throw new Error(validate.errors[0].message);
+  }
   await execCommand(
     "git",
     ["commit", "-m", `${type}(${scope}): ${description}`],
@@ -104,18 +125,15 @@ export default function gitCommitInstaller(cli: CAC) {
         .option("-t, --type <type>", "添加修改类型")
         .option("-s, --scope <scope>", "填写修改范围")
         .option("-d, --description <description>", "填写修改描述")
+        .option("-a, --ask", "启用询问模式")
         .action(async (options) => {
-          const start = performance.now();
-
-          const { type, scope, description } = options;
-          if (!type || !scope || !description) {
+          const { type, scope, description, ask } = options;
+          if (ask) {
             const result = await generateEnquirer();
             await gitCommit(result.type, result.scope, result.description);
           } else {
             await gitCommit(type, scope, description);
           }
-          const getTime = () => `${(performance.now() - start).toFixed(2)}ms`;
-          loggerInfo(`😁 commit 命令执行结束, 共用时: ${getTime()}`);
         });
     },
   };

src/command/git-commit.ts

@@ -28,7 +28,7 @@ export const root = async () => {
       choices: commandChoices,
     },
   ]);
-  await execCommand("codeg", [result.command], { stdio: "inherit" });
+  await execCommand("codeg", [result.command, "--ask"], { stdio: "inherit" });
 };
 
 export default function rootInstaller(cli: CAC) {