✨ refactor(feature): 重构clear命令

Author: OSpoon

README.md

@@ -16,9 +16,15 @@ npm i code-genius
 npm i -g code-genius
 ```
 
-## commit 命令介绍
+帮助信息
 
-生成符合 Angualr 规范的提交内容,支持命令模式和询问模式;
+```bash
+code-genius --help
+```
+
+## commit 命令
+
+生成 **Angualr** 规范的提交信息, 支持命令模式, 询问模式和 **API** 模式;
 
 ### 命令模式
 
@@ -35,14 +41,91 @@ codeg commit -t fix -s feat -d 修复xx功能的xxBug
 ### 询问模式
 
 ```bash
+# 启动询问模式
 codeg commit
+```
 
+```
+# 询问过程
 1. 请选择提交类型
 2. 请选择提交范
 3. 请输入提交描述
 4. 要在提交信息中显示内置的 emoji 表情吗?
 ```
 
+### API 模式
+
+仅对 `git commit -m "xxx"` 包装, 无提交规范生成.
+
+```typescript
+import { gitCommit } from "code-genius";
+
+(async () => {
+  await gitCommit("fix(feat): 修复xx功能的xxBug");
+})();
+```
+
+## verify 命令
+
+校验 `COMMIT_EDITMSG` 中的信息是否符合 **Angualr** 规范, 支持命令模式和 **API** 模式;
+
+### 命令模式
+
+```bash
+codeg verify
+```
+
+### API 模式
+
+```typescript
+import { gitCommitVerify } from "code-genius";
+
+(async () => {
+  await gitCommitVerify();
+  console.log("Git 提交信息校验通过, 正在执行后续逻辑...");
+})();
+```
+
+## clear 命令
+
+运行 `rimraf` 删除不再需要的文件或文件夹, 支持命令模式, 询问模式和 **API** 模式;
+
+### 命令模式
+
+```bash
+# 删除 dist 文件夹
+codeg clear -p ./dist
+
+# 删除 dist 和 node_modules 两个文件夹
+codeg clear -p ./dist -p ./node_modules
+```
+
+| 选项                      | 描述         |
+| ------------------------- | ------------ |
+| -p, --pattern \<pattern\> | 设置匹配规则 |
+
+### 询问模式
+
+```bash
+# 启动询问模式
+codeg clear
+```
+
+```
+# 询问过程
+1. 请选择需要清理的文件/夹
+```
+
+### API 模式
+
+```typescript
+import { clear } from "code-genius";
+
+(async () => {
+  await clear(["./dist"]);
+})();
+```
+
 ## 命令
 
 | 命令       | 参数                                                                                     | 默认值    | 功能描述                                            |

api-model/api-clear.ts

@@ -0,0 +1,5 @@
+import { clear } from "../src/index";
+
+(async () => {
+  await clear(["./dist"]);
+})();

api-model/api-commit.ts

@@ -0,0 +1,5 @@
+import { gitCommit } from "../src/index";
+
+(async () => {
+  await gitCommit("fix(feat): 修复xx功能的xxBug");
+})();

api-model/api-verify.ts

@@ -0,0 +1,6 @@
+import { gitCommitVerify } from "../src/index";
+
+(async () => {
+  await gitCommitVerify();
+  console.log("Git 提交信息校验通过, 正在执行后续逻辑...");
+})();

src/command/clear.ts

@@ -1,7 +1,44 @@
 import type { CAC } from "cac";
 
+import path from "node:path";
+
+import fs from "fs-extra";
+import enquirer from "enquirer";
+
 import { execCommand, loggerInfo } from "@/shared/index";
 import { ACTIVATION, clearGlob } from "@/shared/config";
+import { ClearOptions } from "@/shared/types";
+
+const generateEnquirer = async (): Promise<ClearOptions> => {
+  const files = fs
+    .readdirSync(path.join(process.cwd(), "."))
+    .filter((v) => !v.startsWith("."))
+    .map((file) => {
+      return {
+        sort: fs.statSync(path.join(process.cwd(), file)).isFile() ? 1 : 0,
+        file,
+      };
+    });
+  files.sort((v1, v2) => v1.sort - v2.sort);
+  const fileMultiChoices = files.map((v) => {
+    return {
+      name: `./${v.file}`,
+      message: `${v.file}`,
+      hint: clearGlob.includes(`./${v.file}`) ? "建议清理" : "",
+    };
+  });
+  const result = await enquirer.prompt<ClearOptions>([
+    {
+      name: "files",
+      type: "multiselect",
+      message: "请选择需要清理的文件/夹",
+      choices: fileMultiChoices,
+    },
+  ]);
+  return {
+    files: result.files,
+  };
+};
 
 export const clear = async (paths: string[]) => {
   if (ACTIVATION) {
@@ -18,15 +55,20 @@ export default function clearInstaller(cli: CAC) {
     setup: () => {
       cli
         .command("clear", "运行 rimraf 删除不再需要的文件或文件夹")
-        .option("-p, --pattern <pattern>", "设置配置规则", {
-          default: [...clearGlob],
-        })
+        .option("-p, --pattern <pattern>", "设置匹配规则")
         .action(async (options) => {
-          const patterns =
-            typeof options.pattern === "string"
-              ? [options.pattern]
-              : options.pattern;
-          await clear(patterns);
+          const { pattern } = options;
+          let paths = [];
+          if (!pattern) {
+            const result = await generateEnquirer();
+            paths = result.files;
+          } else {
+            paths =
+              typeof options.pattern === "string"
+                ? [options.pattern]
+                : options.pattern;
+          }
+          await clear(paths);
         });
     },
   };

src/shared/config.ts

@@ -9,7 +9,7 @@ import {
 
 import { blue, green, yellow } from "kolorist";
 
-export const clearGlob = ["./dist/"];
+export const clearGlob = ["./dist", "./node_modules"];
 
 export const formatGlob = ["./src"];
 

src/shared/types.ts

@@ -69,3 +69,7 @@ export interface GitCommitOptions {
   scope: string;
   description: string;
 }
+
+export interface ClearOptions {
+  files: Array<string>;
+}

tsconfig.json

@@ -17,6 +17,6 @@
       "@/*": ["src/*"]
     }
   },
-  "include": ["src/**/*", "scripts/**/*"],
+  "include": ["src/**/*", "scripts/**/*", "api-module/**/*"],
   "exclude": ["node_modules", "dist"]
 }