✨ refactor(feature): 重构clear、registry、impsort询问模块

OSpoon · OSpoon · commit 8e87f097deef · 2023-10-03T15:57:36.000+08:00
diff --git a/README.md b/README.md
@@ -142,6 +142,7 @@ codeg clear -p ./dist -p ./node_modules
 | 选项                      | 描述         |
 | ------------------------- | ------------ |
 | -p, --pattern \<pattern\> | 设置匹配规则 |
+| -a, --ask                 | 启用询问模式 |
 
 ### 询问模式
 
@@ -237,6 +238,10 @@ import { npmDepCheck } from "code-genius";
 codeg registry -u https://registry.npmjs.org/
 ```
 
+| 选项      | 描述         |
+| --------- | ------------ |
+| -a, --ask | 启用询问模式 |
+
 ### 询问模式
 
 ```bash
@@ -461,6 +466,7 @@ codeg impsort -p ./src -p ./components
 | 选项                      | 描述         |
 | ------------------------- | ------------ |
 | -p, --pattern \<pattern\> | 设置匹配规则 |
+| -a, --ask                 | 启用询问模式 |
 
 ### 询问模式
 
diff --git a/src/command/clear.ts b/src/command/clear.ts
@@ -1,6 +1,7 @@
 import path from "node:path";
 import { performance } from "node:perf_hooks";
 
+import Ajv from "ajv";
 import type { CAC } from "cac";
 import enquirer from "enquirer";
 import fs from "fs-extra";
@@ -9,6 +10,14 @@ import { ACTIVATION, clearGlob } from "@/config";
 import { execCommand, loggerInfo, printInfo } from "@/helper";
 import { ClearOptions, CodeGeniusOptions } from "@/types";
 
+const schema = {
+  type: "object",
+  properties: {
+    paths: { type: "array" },
+  },
+  required: ["paths"],
+};
+
 const mergeConfig = async (config: CodeGeniusOptions) => {
   const commands = config && config?.commands;
   if (commands && commands.clear) {
@@ -61,6 +70,16 @@ export const clear = async (paths: string[]) => {
   if (ACTIVATION) {
     loggerInfo(`clear 参数信息: \n ${JSON.stringify(paths)}`);
   }
+
+  const ajv = new Ajv();
+  const validate = ajv.compile(schema);
+  const valid = validate({
+    paths,
+  });
+  if (!valid && validate.errors && validate.errors?.length > 0) {
+    throw new Error(validate.errors[0].message);
+  }
+
   await execCommand("npx", ["rimraf", "--glob", ...paths], {
     stdio: "inherit",
   });
@@ -74,17 +93,15 @@ export default function clearInstaller(cli: CAC, config: CodeGeniusOptions) {
       cli
         .command("clear", "运行 rimraf 删除不再需要的文件或文件夹")
         .option("-p, --pattern <pattern>", "设置匹配规则")
+        .option("-a, --ask", "启用询问模式")
         .action(async (options) => {
-          const { pattern } = options;
+          const { pattern, ask } = options;
           let paths = [];
-          if (!pattern) {
+          if (ask) {
             const result = await generateEnquirer(config);
             paths = result.files;
           } else {
-            paths =
-              typeof options.pattern === "string"
-                ? [options.pattern]
-                : options.pattern;
+            paths = typeof pattern === "string" ? [pattern] : pattern;
           }
           const start = performance.now();
           await clear(paths);
diff --git a/src/command/eslint-import-sort.ts b/src/command/eslint-import-sort.ts
@@ -1,5 +1,7 @@
 import path from "node:path";
+import { performance } from "node:perf_hooks";
 
+import Ajv from "ajv";
 import type { CAC } from "cac";
 import enquirer from "enquirer";
 import { ESLint } from "eslint";
@@ -11,6 +13,14 @@ import { ImpSortOptions } from "@/types";
 
 import { CodeGeniusOptions } from "./../types";
 
+const schema = {
+  type: "object",
+  properties: {
+    paths: { type: "array" },
+  },
+  required: ["paths"],
+};
+
 const mergeConfig = async (config: CodeGeniusOptions) => {
   const commands = config && config?.commands;
   if (commands && commands.impsort) {
@@ -63,6 +73,15 @@ export const impSort = async (paths: string[]) => {
     loggerInfo(`impSort 参数信息: \n ${JSON.stringify(paths)}`);
   }
 
+  const ajv = new Ajv();
+  const validate = ajv.compile(schema);
+  const valid = validate({
+    paths,
+  });
+  if (!valid && validate.errors && validate.errors?.length > 0) {
+    throw new Error(validate.errors[0].message);
+  }
+
   const eslint = new ESLint({
     fix: true,
     overrideConfig: {
@@ -92,19 +111,20 @@ export default function impSortInstaller(cli: CAC, config: CodeGeniusOptions) {
       cli
         .command("impsort", "运行 eslint 对模块导入进行分组&按字母排序")
         .option("-p, --pattern <pattern>", "设置匹配规则")
+        .option("-a, --ask", "启用询问模式")
         .action(async (options) => {
-          const { pattern } = options;
+          const { pattern, ask } = options;
           let paths = [];
-          if (!pattern) {
+          if (ask) {
             const result = await generateEnquirer(config);
             paths = result.files;
           } else {
-            paths =
-              typeof options.pattern === "string"
-                ? [options.pattern]
-                : options.pattern;
+            paths = typeof pattern === "string" ? [pattern] : pattern;
           }
+          const start = performance.now();
           await impSort(paths);
+          const getTime = () => `${(performance.now() - start).toFixed(2)}ms`;
+          loggerInfo(`😁 impsort 命令执行结束, 共用时: ${getTime()}`);
         });
     },
   };
diff --git a/src/command/npm-registry.ts b/src/command/npm-registry.ts
@@ -1,10 +1,19 @@
+import Ajv from "ajv";
 import type { CAC } from "cac";
 import enquirer from "enquirer";
 
 import { ACTIVATION, npmRegisters } from "@/config";
 import { execCommand, loggerInfo, printInfo, printWarring } from "@/helper";
 import { RegistryOptions } from "@/types";
 
+const schema = {
+  type: "object",
+  properties: {
+    registry: { type: "string" },
+  },
+  required: ["registry"],
+};
+
 const printCurrentRegistry = async (isBefore = true) => {
   printInfo(`${isBefore ? "当前" : "最新"} NPM 镜像地址（全局）：`);
   await execCommand("npm", ["config", "get", "registry", "-g"], {
@@ -46,6 +55,16 @@ export const npmRegistry = async (registry: string) => {
   if (ACTIVATION) {
     loggerInfo(`npmRegistry 参数信息: \n ${JSON.stringify(registry)}`);
   }
+
+  const ajv = new Ajv();
+  const validate = ajv.compile(schema);
+  const valid = validate({
+    registry,
+  });
+  if (!valid && validate.errors && validate.errors?.length > 0) {
+    throw new Error(validate.errors[0].message);
+  }
+
   await execCommand("npm", ["config", "set", "registry", registry], {
     stdio: "inherit",
   });
@@ -59,10 +78,11 @@ export default function npmRegistryInstaller(cli: CAC) {
       cli
         .command("registry", "切换 NPM 镜像地址")
         .option("-u, --url <url>", "镜像地址")
+        .option("-a, --ask", "启用询问模式")
         .action(async (options) => {
-          const { url } = options;
+          const { url, ask } = options;
           let registryUrl = "";
-          if (!url) {
+          if (ask) {
             const result = await generateEnquirer();
             registryUrl = result.url;
           } else {
diff --git a/src/command/prettier-format.ts b/src/command/prettier-format.ts
@@ -1,3 +1,5 @@
+import { performance } from "node:perf_hooks";
+
 import type { CAC } from "cac";
 
 import { ACTIVATION, formatGlob } from "@/config";
@@ -41,13 +43,16 @@ export default function prettierFormatInstaller(
         .action(async (options) => {
           const { paths } = await mergeConfig(config);
           const { pattern } = options;
+          const start = performance.now();
           if (pattern) {
             await prettierFormat(
               typeof pattern === "string" ? [pattern] : pattern,
             );
           } else {
             await prettierFormat(paths);
           }
+          const getTime = () => `${(performance.now() - start).toFixed(2)}ms`;
+          loggerInfo(`😁 format 命令执行结束, 共用时: ${getTime()}`);
         });
     },
   };
diff --git a/src/command/root.ts b/src/command/root.ts
@@ -28,7 +28,7 @@ export const root = async () => {
       choices: commandChoices,
     },
   ]);
-  await execCommand("codeg", [result.command, "--ask"], { stdio: "inherit" });
+  await execCommand("codeg", result.command.split(" "), { stdio: "inherit" });
 };
 
 export default function rootInstaller(cli: CAC) {
diff --git a/src/config.ts b/src/config.ts
@@ -201,7 +201,7 @@ export const gitUserOptions: GitUserOptions = {
 
 export const commands = [
   {
-    command: "commit",
+    command: "commit --ask",
     description: "生成 angualr 规范的提交信息",
   },
   {
@@ -217,11 +217,11 @@ export const commands = [
     description: "新增或修改 simple-git-hooks 配置后需要重新初始化",
   },
   {
-    command: "registry",
+    command: "registry --ask",
     description: "切换 NPM 镜像地址",
   },
   {
-    command: "clear",
+    command: "clear --ask",
     description: "运行 rimraf 删除不再需要的文件或文件夹",
   },
   {
@@ -233,7 +233,7 @@ export const commands = [
     description: "运行 eslint 静态扫描和修复代码中存在的问题",
   },
   {
-    command: "impsort",
+    command: "impsort --ask",
     description: "运行 eslint 对模块导入进行分组&按字母排序",
   },
   {

Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ export const gitUserOptions: GitUserOptions = {`
`201`	`201`
`202`	`202`	`export const commands = [`
`203`	`203`	`{`
`204`		`- command: "commit",`
	`204`	`+ command: "commit --ask",`
`205`	`205`	`description: "生成 angualr 规范的提交信息",`
`206`	`206`	`},`
`207`	`207`	`{`
`@@ -217,11 +217,11 @@ export const commands = [`
`217`	`217`	`description: "新增或修改 simple-git-hooks 配置后需要重新初始化",`
`218`	`218`	`},`
`219`	`219`	`{`
`220`		`- command: "registry",`
	`220`	`+ command: "registry --ask",`
`221`	`221`	`description: "切换 NPM 镜像地址",`
`222`	`222`	`},`
`223`	`223`	`{`
`224`		`- command: "clear",`
	`224`	`+ command: "clear --ask",`
`225`	`225`	`description: "运行 rimraf 删除不再需要的文件或文件夹",`
`226`	`226`	`},`
`227`	`227`	`{`
`@@ -233,7 +233,7 @@ export const commands = [`
`233`	`233`	`description: "运行 eslint 静态扫描和修复代码中存在的问题",`
`234`	`234`	`},`
`235`	`235`	`{`
`236`		`- command: "impsort",`
	`236`	`+ command: "impsort --ask",`
`237`	`237`	`description: "运行 eslint 对模块导入进行分组&按字母排序",`
`238`	`238`	`},`
`239`	`239`	`{`