🎉 feat(app): 更新

Author: OSpoon

README.md

@@ -1 +1,79 @@
-# codeg-clear-plugin
+# @codegenius/clear-plugin
+
+## 安装
+
+```bash
+npm i @codegenius/clear-plugin
+```
+
+```javascript
+// 开发期间使用
+import { defineConfig } from "code-genius";
+import clearInstaller from "@codegenius/clear-plugin";
+
+export default defineConfig({
+  plugins: [
+    clearInstaller({
+      files: ["./src"],
+    }),
+  ],
+});
+```
+
+## 使用
+
+运行 `rimraf` 删除不再需要的文件或文件夹, 支持命令模式, 询问模式和 **API** 模式;
+
+使用场景: 用于删除可以通过项目运行自动生成的文件, 如: `dist` 目录, 还有顽固的 `node_modules`.
+
+### 命令模式
+
+```bash
+# 删除 dist 文件夹
+codeg clear -p ./dist
+
+# 删除 dist 和 node_modules 两个文件夹
+codeg clear -p ./dist -p ./node_modules
+```
+
+| 选项                      | 描述         |
+| ------------------------- | ------------ |
+| -p, --pattern \<pattern\> | 设置匹配规则 |
+| -a, --ask                 | 启用询问模式 |
+
+### 询问模式
+
+```bash
+# 启动询问模式
+codeg clear --ask
+```
+
+```
+# 询问过程
+1. 请选择需要清理的文件/夹
+```
+
+### API 模式
+
+```typescript
+import { clear } from "code-genius";
+
+(async () => {
+  await clear(["./dist"]);
+})();
+```
+
+### 配置文件
+
+```typescript
+# 覆盖默认的 `files` 配置
+import { defineConfig } from "code-genius";
+
+export default defineConfig({
+  commands: {
+    clear: {
+      files: ["./dist"]
+    },
+  },
+});
+```

src/common.ts

@@ -0,0 +1,26 @@
+import Ajv from "ajv";
+import type { CAC } from "cac";
+
+export interface ClearOptions {
+  cli: CAC,
+  files: Array<string>;
+}
+
+export const clearGlob = ["./src"];
+
+export const schema = {
+  type: "object",
+  properties: {
+    paths: { type: "array" },
+  },
+  required: ["paths"],
+};
+
+export const validateArgs = (schema: object, data: unknown) => {
+  const ajv = new Ajv();
+  const validate = ajv.compile(schema);
+  const valid = validate(data);
+  if (!valid && validate.errors && validate.errors?.length > 0) {
+    throw new Error(validate.errors[0].message);
+  }
+};

src/index.ts

@@ -1,39 +1,15 @@
 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";
 
-import { ACTIVATION, clearGlob } from "code-genius";
-import { execCommand, loggerInfo, printInfo } from "code-genius";
-import { ClearOptions, CodeGeniusOptions } from "code-genius";
-
-const schema = {
-  type: "object",
-  properties: {
-    paths: { type: "array" },
-  },
-  required: ["paths"],
-};
-
-const mergeConfig = async (config: CodeGeniusOptions) => {
-  const commands = config && config?.commands;
-  if (commands && commands.clear) {
-    const { files } = commands.clear;
-    return {
-      paths: files && files.length > 0 ? files : clearGlob,
-    };
-  }
-  return {
-    paths: clearGlob,
-  };
-};
+import { ACTIVATION, execCommand, loggerInfo, printInfo } from "code-genius";
+import { ClearOptions, clearGlob, schema, validateArgs } from "./common";
 
 const generateEnquirer = async (
-  config: CodeGeniusOptions
-): Promise<ClearOptions> => {
+  paths: Array<string>
+): Promise<Array<string>> => {
   const files = fs
     .readdirSync(path.join(process.cwd(), "."))
     .filter((v) => !v.startsWith("."))
@@ -45,7 +21,6 @@ const generateEnquirer = async (
     });
   files.sort((v1, v2) => v1.sort - v2.sort);
 
-  const { paths } = await mergeConfig(config);
   const fileMultiChoices = files.map((v) => {
     return {
       name: `./${v.file}`,
@@ -61,32 +36,24 @@ const generateEnquirer = async (
       choices: fileMultiChoices,
     },
   ]);
-  return {
-    files: result.files,
-  };
+  return result.files;
 };
 
 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);
-  }
+  validateArgs(schema, paths);
 
   await execCommand("npx", ["rimraf", "--glob", ...paths], {
     stdio: "inherit",
   });
   printInfo("清理结束");
 };
 
-export default function clearInstaller(cli: CAC, config: CodeGeniusOptions) {
+const clearInstaller = (config: ClearOptions) => {
+  const { cli, files } = config;
   return {
     name: "clearInstaller",
     setup: () => {
@@ -98,8 +65,7 @@ export default function clearInstaller(cli: CAC, config: CodeGeniusOptions) {
           const { pattern, ask } = options;
           let paths = [];
           if (ask) {
-            const result = await generateEnquirer(config);
-            paths = result.files;
+            paths = await generateEnquirer(files || clearGlob);
           } else {
             paths = typeof pattern === "string" ? [pattern] : pattern;
           }
@@ -110,4 +76,6 @@ export default function clearInstaller(cli: CAC, config: CodeGeniusOptions) {
         });
     },
   };
-}
+};
+
+export { clear, clearInstaller };