@ruan-cat/utils 1.7.0 → 3.0.0

package/dist/node-esm/index.d.ts

@@ -0,0 +1,33 @@
+/** 包的信息 */
+interface PackageInfo {
+    /** 包名 */
+    name: string;
+    /** 包的描述 */
+    description: string;
+    /** 带有包名的官方镜像源地址 */
+    url: `https://npm.im/${string}`;
+}
+/**
+ * 获得阮喵喵全部的包信息
+ * @description
+ * 这是一个node环境下的函数，用于获取阮喵喵的所有包的信息。
+ *
+ * 使用的是node的child_process模块，调用pnpm命令获取包信息。
+ *
+ * - 默认仅考虑pnpm包
+ * - 在node环境下运行
+ */
+declare function getRuanCatPkgInfo(): Promise<PackageInfo[]>;
+
+declare const defaultCleanTargets: readonly ["node_modules", "yarn.lock", "pnpm-lock.yaml", "package-lock.json", "dist", ".turbo", ".vercel", ".cache", ".temp"];
+/**
+ * 删除node项目的依赖项便于重新安装依赖，也包括常见的各种垃圾文件。
+ * @description
+ */
+declare function clean(
+/**
+ * 被清除的目标文件夹 也包括文件
+ */
+targets?: string[]): Promise<void>;
+
+export { type PackageInfo, clean, defaultCleanTargets, getRuanCatPkgInfo };

package/dist/node-esm/index.js

@@ -0,0 +1,114 @@
+// src/node-esm/ruan-cat-pkg-info.ts
+import { spawnSync } from "node:child_process";
+async function getRuanCatPkgInfo() {
+  return new Promise((resolve, reject) => {
+    const result = spawnSync("pnpm", ["s", "@ruan-cat/*", "--registry", "https://registry.npmmirror.com/", "--json"], {
+      encoding: "utf-8"
+    });
+    if (result.error) {
+      console.error(`Error executing command: ${result.error.message}`);
+      reject(result.error);
+      return;
+    }
+    if (result.stderr) {
+      console.error(`Error in output: ${result.stderr}`);
+      reject(new Error(result.stderr));
+      return;
+    }
+    const packages = JSON.parse(result.stdout);
+    const res = packages.map(
+      (pkg) => ({
+        name: pkg.name,
+        description: pkg.description,
+        url: `https://npm.im/${pkg.name}`
+      })
+    );
+    resolve(res);
+  });
+}
+
+// src/node-cjs/tools.ts
+import { spawnSync as spawnSync2 } from "node:child_process";
+
+// src/simple-promise-tools.ts
+function generateSimpleAsyncTask(func) {
+  return function(...args) {
+    return new Promise((resolve, reject) => {
+      resolve(func(...args));
+    });
+  };
+}
+
+// src/node-cjs/tools.ts
+import consola from "consola";
+var defPrintCurrentCommand = function(params) {
+  const { command, parameters } = params;
+  consola.info(` \u5F53\u524D\u8FD0\u884C\u7684\u547D\u4EE4\u4E3A\uFF1A ${command} ${parameters.join(" ")} 
+`);
+};
+function generateSpawnSync(spawnSyncSimpleParams) {
+  const {
+    command,
+    parameters,
+    isFlow = true,
+    isShowCommand = true,
+    spawnOptions = {},
+    printCurrentCommand = defPrintCurrentCommand
+  } = spawnSyncSimpleParams;
+  if (isShowCommand) {
+    printCurrentCommand?.({ command, parameters });
+  }
+  return generateSimpleAsyncTask(() => {
+    const result = spawnSync2(command, parameters, {
+      /**
+       * 是否流式输出？
+       * 是流式输出就是继承父进程的流式输出
+       * 否则就使用默认值
+       * @see https://nodejs.org/api/child_process.html#optionsstdio
+       */
+      stdio: isFlow ? "inherit" : "pipe",
+      shell: true,
+      ...spawnOptions
+    });
+    if (!isFlow) {
+      return result;
+    }
+    if (result.error) {
+      throw result.error;
+    }
+    return result;
+  });
+}
+
+// src/node-esm/scripts/clean.ts
+var defaultCleanTargets = [
+  // node常见文件
+  "node_modules",
+  "yarn.lock",
+  "pnpm-lock.yaml",
+  "package-lock.json",
+  // 项目常见文件
+  "dist",
+  //
+  ".turbo",
+  ".vercel",
+  // vuepress
+  ".cache",
+  ".temp"
+];
+async function clean(targets) {
+  const cleanTargets = targets ?? defaultCleanTargets;
+  const glob = `**/{${cleanTargets.join()}}`;
+  console.log(" \u5F53\u524D\u8FD0\u884C\u5730\u5740 process.cwd() ", process.cwd());
+  const doClean = generateSpawnSync({
+    command: "rimraf",
+    parameters: ["-g", glob]
+  });
+  await doClean();
+}
+export {
+  clean,
+  defaultCleanTargets,
+  getRuanCatPkgInfo
+};
+//# sourceMappingURL=index.js.map

package/dist/node-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/node-esm/ruan-cat-pkg-info.ts","../../src/node-cjs/tools.ts","../../src/simple-promise-tools.ts","../../src/node-esm/scripts/clean.ts"],"sourcesContent":["import { spawnSync } from \"node:child_process\";\n\n/** 包的信息 */\nexport interface PackageInfo {\n\t/** 包名 */\n\tname: string;\n\t/** 包的描述 */\n\tdescription: string;\n\t/** 带有包名的官方镜像源地址 */\n\turl: `https://npm.im/${string}`;\n}\n\n/**\n * 获得阮喵喵全部的包信息\n * @description\n * 这是一个node环境下的函数，用于获取阮喵喵的所有包的信息。\n *\n * 使用的是node的child_process模块，调用pnpm命令获取包信息。\n *\n * - 默认仅考虑pnpm包\n * - 在node环境下运行\n */\nexport async function getRuanCatPkgInfo() {\n\treturn new Promise<PackageInfo[]>((resolve, reject) => {\n\t\t/**\n\t\t * pnpm s @ruan-cat/* --registry https://registry.npmmirror.com/ --json\n\t\t * 仅查询淘宝源的数据\n\t\t */\n\t\tconst result = spawnSync(\"pnpm\", [\"s\", \"@ruan-cat/*\", \"--registry\", \"https://registry.npmmirror.com/\", \"--json\"], {\n\t\t\tencoding: \"utf-8\",\n\t\t});\n\n\t\tif (result.error) {\n\t\t\tconsole.error(`Error executing command: ${result.error.message}`);\n\t\t\treject(result.error);\n\t\t\treturn;\n\t\t}\n\t\tif (result.stderr) {\n\t\t\tconsole.error(`Error in output: ${result.stderr}`);\n\t\t\treject(new Error(result.stderr));\n\t\t\treturn;\n\t\t}\n\n\t\tconst packages = <unknown[]>JSON.parse(result.stdout);\n\t\tconst res = packages.map(\n\t\t\t(pkg: any) =>\n\t\t\t\t({\n\t\t\t\t\tname: pkg.name,\n\t\t\t\t\tdescription: pkg.description,\n\t\t\t\t\turl: `https://npm.im/${pkg.name}`,\n\t\t\t\t}) satisfies PackageInfo,\n\t\t);\n\t\t// const res = packages;\n\t\tresolve(res);\n\t});\n}\n","/**\n * 一些node环境下的工具函数\n */\n\nimport { normalize } from \"node:path\";\nimport { spawnSync, type SpawnOptions } from \"node:child_process\";\n\nimport { generateSimpleAsyncTask } from \"@ruan-cat/utils\";\nimport consola from \"consola\";\n// import { normalizePath } from \"vite\";\n\n/**\n * 路径转换工具\n */\nexport function pathChange(path: string) {\n\treturn path.replace(/\\\\/g, \"/\");\n\t// FIXME: 无法有效地实现解析路径 测试用例不通过\n\t// return normalize(path);\n\t// FIXME: tsup打包时，无法处理好vite的依赖 会导致打包失败 不知道怎么单独使用并打包该函数\n\t// return normalizePath(path);\n}\n\nexport interface SpawnSyncSimpleParams {\n\tcommand: string;\n\tparameters: string[];\n\t/**\n\t * 是否流式输出内容\n\t * @description 默认输出的命令数据全部以流式的方式输出\n\t * @default true\n\t */\n\tisFlow?: boolean;\n\n\t/**\n\t * 是否显示命令？\n\t * @description\n\t * 是否打印目前正在执行的命令？\n\t * @default true\n\t */\n\tisShowCommand?: boolean;\n\tspawnOptions?: SpawnOptions;\n\n\t/** 打印当前运行的命令 */\n\tprintCurrentCommand?: (params: Pick<SpawnSyncSimpleParams, \"command\" | \"parameters\">) => void;\n}\n\n/**\n * 默认的打印当前运行命令 函数\n */\nexport const defPrintCurrentCommand: SpawnSyncSimpleParams[\"printCurrentCommand\"] = function (params) {\n\tconst { command, parameters } = params;\n\tconsola.info(` 当前运行的命令为： ${command} ${parameters.join(\" \")} \\n`);\n};\n\n/**\n * 生成简单的执行命令函数\n * @description\n * 对 spawnSync 做简单的包装\n *\n * 之前封装的是 execa 函数\n * @version 2\n */\nexport function generateSpawnSync(spawnSyncSimpleParams: SpawnSyncSimpleParams) {\n\tconst {\n\t\tcommand,\n\t\tparameters,\n\t\tisFlow = true,\n\t\tisShowCommand = true,\n\t\tspawnOptions = {},\n\t\tprintCurrentCommand = defPrintCurrentCommand,\n\t} = spawnSyncSimpleParams;\n\n\tif (isShowCommand) {\n\t\tprintCurrentCommand?.({ command, parameters });\n\t}\n\n\treturn generateSimpleAsyncTask(() => {\n\t\tconst result = spawnSync(command, parameters, {\n\t\t\t/**\n\t\t\t * 是否流式输出？\n\t\t\t * 是流式输出就是继承父进程的流式输出\n\t\t\t * 否则就使用默认值\n\t\t\t * @see https://nodejs.org/api/child_process.html#optionsstdio\n\t\t\t */\n\t\t\tstdio: isFlow ? \"inherit\" : \"pipe\",\n\t\t\tshell: true,\n\t\t\t...spawnOptions,\n\t\t});\n\n\t\t// 如果不是流式输出 就直接返回返回值即可\n\t\tif (!isFlow) {\n\t\t\treturn result;\n\t\t}\n\n\t\tif (result.error) {\n\t\t\tthrow result.error;\n\t\t}\n\n\t\treturn result;\n\t});\n}\n","// import { uniqueId } from \"lodash-es\";\n// const getCounter = () => uniqueId();\n\n/** 创建简单的异步任务 */\nexport function generateSimpleAsyncTask<T extends (...args: any) => any>(func: T) {\n\t// const taskId = getCounter();\n\n\treturn function (...args: any) {\n\t\t// consola.info(` 这是第 ${taskId} 个异步任务 `);\n\t\t// consola.start(\" 这里是新创建的异步函数 检查参数： \", ...args);\n\n\t\treturn new Promise<ReturnType<T>>((resolve, reject) => {\n\t\t\t// consola.start(\" 内部promise 检查参数： \", ...args);\n\t\t\tresolve(func(...args));\n\t\t});\n\t};\n}\n\nexport type SimpleAsyncTask = ReturnType<typeof generateSimpleAsyncTask>;\n\nexport const initFlag = <const>\"initFlag\";\n\n/**\n * 以队列串行的形式 串行运行异步函数\n * @see https://github.com/ascoders/weekly/blob/master/前沿技术/77.精读《用%20Reduce%20实现%20Promise%20串行执行》.md\n * @version 1\n */\nasync function runPromiseByQueueV1<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tpromises.reduce(\n\t\tasync function (previousPromise, nextPromise, currentIndex) {\n\t\t\tconst response = await previousPromise;\n\t\t\t// consola.log(` reduce串行函数 currentIndex= ${currentIndex} res =`, response);\n\t\t\treturn await nextPromise(response);\n\t\t},\n\t\tPromise.resolve(initFlag) as Promise<any>,\n\t);\n}\n\n/**\n * 以队列串行的形式 串行运行异步函数\n * @version 2\n */\nexport async function runPromiseByQueue<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tlet response: typeof initFlag | Awaited<T> = initFlag;\n\tfor await (const promise of promises) {\n\t\tresponse = await promise(response);\n\t}\n}\n\n/**\n * 以并行的形式 并发运行异步函数\n */\nexport async function runPromiseByConcurrency<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tawait Promise.all(promises.map((promise) => promise()));\n}\n","import { generateSpawnSync } from \"../../node-cjs/index.ts\";\n\ntype GlobString = `**/{${string}}`;\n\nexport const defaultCleanTargets = <const>[\n\t// node常见文件\n\t\"node_modules\",\n\t\"yarn.lock\",\n\t\"pnpm-lock.yaml\",\n\t\"package-lock.json\",\n\n\t// 项目常见文件\n\t\"dist\",\n\n\t//\n\t\".turbo\",\n\t\".vercel\",\n\n\t// vuepress\n\t\".cache\",\n\t\".temp\",\n];\n\n/**\n * 删除node项目的依赖项便于重新安装依赖，也包括常见的各种垃圾文件。\n * @description\n */\nexport async function clean(\n\t/**\n\t * 被清除的目标文件夹 也包括文件\n\t */\n\ttargets?: string[],\n) {\n\tconst cleanTargets = targets ?? defaultCleanTargets;\n\tconst glob: GlobString = `**/{${cleanTargets.join()}}`;\n\n\tconsole.log(\" 当前运行地址 process.cwd() \", process.cwd());\n\n\tconst doClean = generateSpawnSync({\n\t\tcommand: \"rimraf\",\n\t\tparameters: [\"-g\", glob],\n\t});\n\n\tawait doClean();\n}\n"],"mappings":";AAAA,SAAS,iBAAiB;AAsB1B,eAAsB,oBAAoB;AACzC,SAAO,IAAI,QAAuB,CAAC,SAAS,WAAW;AAKtD,UAAM,SAAS,UAAU,QAAQ,CAAC,KAAK,eAAe,cAAc,mCAAmC,QAAQ,GAAG;AAAA,MACjH,UAAU;AAAA,IACX,CAAC;AAED,QAAI,OAAO,OAAO;AACjB,cAAQ,MAAM,4BAA4B,OAAO,MAAM,OAAO,EAAE;AAChE,aAAO,OAAO,KAAK;AACnB;AAAA,IACD;AACA,QAAI,OAAO,QAAQ;AAClB,cAAQ,MAAM,oBAAoB,OAAO,MAAM,EAAE;AACjD,aAAO,IAAI,MAAM,OAAO,MAAM,CAAC;AAC/B;AAAA,IACD;AAEA,UAAM,WAAsB,KAAK,MAAM,OAAO,MAAM;AACpD,UAAM,MAAM,SAAS;AAAA,MACpB,CAAC,SACC;AAAA,QACA,MAAM,IAAI;AAAA,QACV,aAAa,IAAI;AAAA,QACjB,KAAK,kBAAkB,IAAI,IAAI;AAAA,MAChC;AAAA,IACF;AAEA,YAAQ,GAAG;AAAA,EACZ,CAAC;AACF;;;AClDA,SAAS,aAAAA,kBAAoC;;;ACDtC,SAAS,wBAAyD,MAAS;AAGjF,SAAO,YAAa,MAAW;AAI9B,WAAO,IAAI,QAAuB,CAAC,SAAS,WAAW;AAEtD,cAAQ,KAAK,GAAG,IAAI,CAAC;AAAA,IACtB,CAAC;AAAA,EACF;AACD;;;ADRA,OAAO,aAAa;AAwCb,IAAM,yBAAuE,SAAU,QAAQ;AACrG,QAAM,EAAE,SAAS,WAAW,IAAI;AAChC,UAAQ,KAAK,2DAAc,OAAO,IAAI,WAAW,KAAK,GAAG,CAAC;AAAA,CAAK;AAChE;AAUO,SAAS,kBAAkB,uBAA8C;AAC/E,QAAM;AAAA,IACL;AAAA,IACA;AAAA,IACA,SAAS;AAAA,IACT,gBAAgB;AAAA,IAChB,eAAe,CAAC;AAAA,IAChB,sBAAsB;AAAA,EACvB,IAAI;AAEJ,MAAI,eAAe;AAClB,0BAAsB,EAAE,SAAS,WAAW,CAAC;AAAA,EAC9C;AAEA,SAAO,wBAAwB,MAAM;AACpC,UAAM,SAASC,WAAU,SAAS,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO7C,OAAO,SAAS,YAAY;AAAA,MAC5B,OAAO;AAAA,MACP,GAAG;AAAA,IACJ,CAAC;AAGD,QAAI,CAAC,QAAQ;AACZ,aAAO;AAAA,IACR;AAEA,QAAI,OAAO,OAAO;AACjB,YAAM,OAAO;AAAA,IACd;AAEA,WAAO;AAAA,EACR,CAAC;AACF;;;AE/FO,IAAM,sBAA6B;AAAA;AAAA,EAEzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAGA;AAAA;AAAA,EAGA;AAAA,EACA;AAAA;AAAA,EAGA;AAAA,EACA;AACD;AAMA,eAAsB,MAIrB,SACC;AACD,QAAM,eAAe,WAAW;AAChC,QAAM,OAAmB,OAAO,aAAa,KAAK,CAAC;AAEnD,UAAQ,IAAI,wDAA0B,QAAQ,IAAI,CAAC;AAEnD,QAAM,UAAU,kBAAkB;AAAA,IACjC,SAAS;AAAA,IACT,YAAY,CAAC,MAAM,IAAI;AAAA,EACxB,CAAC;AAED,QAAM,QAAQ;AACf;","names":["spawnSync","spawnSync"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "1.7.0",
+  "version": "3.0.0",
   "description": "阮喵喵工具集合。一个纯typescript库，也提供纯js文件。",
   "type": "module",
   "main": "./src/index.ts",
@@ -20,11 +20,18 @@
       "import": "./src/index.ts",
       "require": "./dist/index.cjs"
     },
-    "./node": {
-      "types": "./src/node.d.ts",
-      "import": "./src/node.js",
-      "require": "./dist/node.cjs"
+    "./node-cjs": {
+      "types": "./src/node-cjs/index.ts",
+      "import": "./src/node-cjs/index.ts",
+      "require": "./dist/node-cjs/index.cjs"
     },
+    "./node-esm": {
+      "types": "./src/node-esm/index.ts",
+      "import": "./src/node-esm/index.ts"
+    },
+    "./unplugin-vue-router": "./src/unplugin-vue-router/index.ts",
+    "./vite-plugin-autogeneration-import-file": "./src/vite-plugin-autogeneration-import-file/index.ts",
+    "./vueuse": "./src/vueuse/index.ts",
     "./src/*": "./src/*",
     "./dist/*": "./dist/*"
   },
@@ -46,6 +53,8 @@
     "src",
     "dist/*",
     "!src/tests",
+    "!src/**/tests",
+    "!src/**/*.md",
     "tsconfig.json"
   ],
   "dependencies": {
@@ -61,14 +70,17 @@
     "tsup": "^8.3.5",
     "type-plus": "^7.6.2",
     "typedoc": "^0.27.0",
+    "typedoc-plugin-frontmatter": "^1.2.1",
     "typedoc-plugin-markdown": "^4.3.0",
     "typescript": "5.7.3",
-    "unplugin-vue-router": "^0.10.8",
+    "unplugin-vue-router": "^0.11.2",
+    "vite-plugin-autogeneration-import-file": "^3.0.0",
     "@ruan-cat/vuepress-preset-config": "^0.1.19"
   },
   "peerDependencies": {
     "typescript": "5.7.3",
-    "unplugin-vue-router": "^0.10.8"
+    "unplugin-vue-router": "^0.10.0",
+    "vite-plugin-autogeneration-import-file": ">=3"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -77,6 +89,9 @@
     "unplugin-vue-router": {
       "optional": true
     },
+    "vite-plugin-autogeneration-import-file": {
+      "optional": true
+    },
     "@vueuse/integrations": {
       "optional": true
     },
@@ -85,10 +100,12 @@
     }
   },
   "scripts": {
-    "copy-readme": "cpx readme.md docs",
+    "clean-docs": "rimraf -g \"docs/**/!(.vuepress)\"",
+    "copy-src": "cpx \"src/**/*\" docs",
+    "copy-readme": "cpx README.md docs",
     "copy-changelog": "cpx CHANGELOG.md docs",
     "typedoc": "typedoc --options typedoc.config.mjs",
-    "prettier-docs-(invalid)": "prettier docs/**/*.md --write",
+    "changelog-yaml": "node --import=tsx ./scripts/yaml-in-md.ts --md=./docs/CHANGELOG.md",
     "docs:dev-main": "vuepress-vite dev docs --clean-cache --open",
     "docs:dev": "turbo docs:dev",
     "build:docs-main": "vuepress-vite build docs",

package/src/index.ts

@@ -1,13 +1,7 @@
 export * from "./rmmv-class-expand-tools.ts";
 export * from "./conditions.ts";
-export * from "./unplugin-vue-router/index.ts";
 export * from "./define-promise-tasks.ts";
 export * from "./simple-promise-tools.ts";
-export * from "./vueuse/useAxios.ts";
-export * from "./ruan-cat-pkg-info.ts";
 
 export * from "./types/pnpm-workspace.yaml.shim.ts";
 export * from "./types/Prettify.ts";
-
-// 单独打包成cjs 并单独导出
-// export * from "./node.ts";

package/src/node-cjs/index.ts

@@ -0,0 +1 @@
+export * from "./tools.ts";

package/src/{node.ts → node-cjs/tools.ts}

@@ -3,10 +3,9 @@
  */
 
 import { normalize } from "node:path";
-import { spawnSync } from "node:child_process";
+import { spawnSync, type SpawnOptions } from "node:child_process";
 
 import { generateSimpleAsyncTask } from "@ruan-cat/utils";
-// import gradient from "gradient-string";
 import consola from "consola";
 // import { normalizePath } from "vite";
 
@@ -38,6 +37,7 @@ export interface SpawnSyncSimpleParams {
 	 * @default true
 	 */
 	isShowCommand?: boolean;
+	spawnOptions?: SpawnOptions;
 
 	/** 打印当前运行的命令 */
 	printCurrentCommand?: (params: Pick<SpawnSyncSimpleParams, "command" | "parameters">) => void;
@@ -65,6 +65,7 @@ export function generateSpawnSync(spawnSyncSimpleParams: SpawnSyncSimpleParams)
 		parameters,
 		isFlow = true,
 		isShowCommand = true,
+		spawnOptions = {},
 		printCurrentCommand = defPrintCurrentCommand,
 	} = spawnSyncSimpleParams;
 
@@ -82,6 +83,7 @@ export function generateSpawnSync(spawnSyncSimpleParams: SpawnSyncSimpleParams)
 			 */
 			stdio: isFlow ? "inherit" : "pipe",
 			shell: true,
+			...spawnOptions,
 		});
 
 		// 如果不是流式输出 就直接返回返回值即可

package/src/node-esm/index.ts

@@ -0,0 +1,3 @@
+export * from "./ruan-cat-pkg-info.ts";
+
+export * from "./scripts/clean.ts";

package/src/node-esm/scripts/clean.ts

@@ -0,0 +1,45 @@
+import { generateSpawnSync } from "../../node-cjs/index.ts";
+
+type GlobString = `**/{${string}}`;
+
+export const defaultCleanTargets = <const>[
+	// node常见文件
+	"node_modules",
+	"yarn.lock",
+	"pnpm-lock.yaml",
+	"package-lock.json",
+
+	// 项目常见文件
+	"dist",
+
+	//
+	".turbo",
+	".vercel",
+
+	// vuepress
+	".cache",
+	".temp",
+];
+
+/**
+ * 删除node项目的依赖项便于重新安装依赖，也包括常见的各种垃圾文件。
+ * @description
+ */
+export async function clean(
+	/**
+	 * 被清除的目标文件夹 也包括文件
+	 */
+	targets?: string[],
+) {
+	const cleanTargets = targets ?? defaultCleanTargets;
+	const glob: GlobString = `**/{${cleanTargets.join()}}`;
+
+	console.log(" 当前运行地址 process.cwd() ", process.cwd());
+
+	const doClean = generateSpawnSync({
+		command: "rimraf",
+		parameters: ["-g", glob],
+	});
+
+	await doClean();
+}

package/src/unplugin-vue-router/README.md

@@ -0,0 +1,21 @@
+---
+dir:
+  collapsible: false
+  link: true
+---
+
+# unplugin-vue-router
+
+## 安装依赖
+
+你需要独立安装 unplugin-vue-router 。
+
+```bash
+pnpm i -D unplugin-vue-router
+```
+
+## 使用
+
+```ts
+import { getRouteName } from "@ruan-cat/utils/unplugin-vue-router";
+```

package/src/unplugin-vue-router/index.ts

@@ -10,6 +10,17 @@ type GetRouteName = NonNullable<Options["getRouteName"]>;
  * 故自定义。
  *
  * unplugin-vue-router 插件的 getRouteName 配置项
+ *
+ * FIXME: https://github.com/vitejs/vite/issues/5370
+ *
+ * 该函数设计出来是为了解决这个问题
+ *
+ * 在vite符号链接未解决时，应该直接使用js文件，如下：
+ * (作废)
+ * import { getRouteName } from "@ruan-cat/utils/dist/index.js";
+ *
+ * 若已经彻底解决，请直接试图用来自符号链接的ts文件，如下：
+ * import { getRouteName } from "@ruan-cat/utils/unplugin-vue-router";
  */
 export const getRouteName: GetRouteName = function _getRouteName(node): ReturnType<GetRouteName> {
 	// 如果是根节点 那么没有对应的文件夹名称 返回空字符串

package/src/vite-plugin-autogeneration-import-file/README.md

@@ -0,0 +1,37 @@
+---
+dir:
+  collapsible: false
+  link: true
+---
+
+# 自动类型生成插件的二次封装
+
+[vite-plugin-autogeneration-import-file](https://github.com/yuntian001/vite-plugin-autogeneration-import-file)，这个 vite 插件可以实现自动类型导入。在实际使用过程中，需要配置很多东西，故此处对该插件的使用做一些二次封装，并讲解该如何使用。
+
+## 安装依赖
+
+毕竟属于对该插件的二次封装，请自行安装依赖：
+
+```bash
+pnpm i -D vite-plugin-autogeneration-import-file
+```
+
+## 在 vite 配置内使用
+
+使用示例如下：
+
+::: details
+
+@[code](./tests/vite.config.ts)
+
+:::
+
+## 使用的模板
+
+类型文件使用的模板如下：
+
+::: details
+
+@[code](./template/components.template.ts)
+
+:::

package/src/vite-plugin-autogeneration-import-file/index.ts

@@ -0,0 +1,120 @@
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath, URL } from "node:url";
+import * as fs from "node:fs";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+import { upperFirst, isUndefined } from "lodash-es";
+import { createPlugin, getName } from "vite-plugin-autogeneration-import-file";
+import consola from "consola";
+
+const { autoImport } = createPlugin();
+
+/**
+ * 解析目录
+ * @description
+ * 用于解析目录路径 默认从项目根目录开始
+ *
+ * 这里的项目根目录默认为 process.cwd()
+ *
+ * 作为工具函数对外导出 便于用户自己整理解析的文件路径
+ */
+export function pathResolve(dir: string) {
+	const resPath = resolve(process.cwd(), dir);
+	console.info(` 解析的文件路径: ${resPath}`);
+	return resPath;
+}
+
+type DirOptions = Parameters<typeof autoImport>["0"];
+type DirOption = DirOptions[number];
+type _DirOptionName = DirOption["name"];
+
+type _DirOptionNameNotString = Exclude<_DirOptionName, string>;
+type DirOptionName = NonNullable<_DirOptionNameNotString>;
+
+/**
+ * 创建名称生成函数
+ * @description
+ * 用于诸如特定的名称前缀 便于实现模块注册
+ */
+export function createDirOptionNameFunction(
+	/**
+	 * 组件名称前缀
+	 * @description
+	 * 一般写成大写字母
+	 * @example
+	 * Components
+	 * Page
+	 */
+	prefix: string = "",
+) {
+	/**
+	 * 组件名命名规则支持字符串模板和函数
+	 * @description
+	 * 设置首字母为大写
+	 */
+	const dirOptionName: DirOptionName = function name(fileName) {
+		const resFileName = getName(fileName);
+		const resFileNameWithPrefix = <const>`${upperFirst(prefix)}${upperFirst(resFileName)}`;
+		return resFileNameWithPrefix;
+	};
+
+	return dirOptionName;
+}
+
+/**
+ * 默认的自动导入模板文件名
+ * @description
+ * 你可以在项目内准备一个模板文件 这个模板文件建议取名为 components.template.d.ts
+ * 读取模板时 会默认读取该名称的文件
+ * @example components.template.d.ts
+ */
+export const defaultAutoImportTemplateFilename = <const>"components.template.ts";
+
+/**
+ * 默认的自动导入模板文件路径
+ * @description
+ * 我们默认你的模板文件在项目根目录下的 template 文件夹内
+ */
+export const defaultAutoImportTemplatePath = <const>`./template/${defaultAutoImportTemplateFilename}`;
+
+/**
+ * 直接获得默认的自动导入模板
+ * @description
+ * 直接读取本项目内的 components.template.d.ts 文件
+ * 反正都读取默认模板了 直接获取字符串即可
+ */
+function getDefaultAutoImportTemplate() {
+	/** 相对路径文件 就在旁边的文件 */
+	const templatePath = join(__dirname, defaultAutoImportTemplatePath);
+	return fs.readFileSync(templatePath, "utf-8");
+}
+
+/** 默认的自动导入模板 */
+export const defaultAutoImportTemplate = getDefaultAutoImportTemplate();
+
+/**
+ * 创建文件生成模板字符串
+ * @description
+ * 会生成一个字符串 用于作为生成类型声明文件的模板
+ */
+export function createAutoImportTemplate(
+	/**
+	 * 模板路径
+	 * @description
+	 * 你可以传入一个模板路径 默认会读取项目根目录下的 template 文件夹内的 components.template.d.ts 文件
+	 * @default ./template/components.template.d.ts
+	 */
+	path?: string,
+) {
+	// 如果用户没传递路径 就直接返回默认的模板
+	if (isUndefined(path)) {
+		return defaultAutoImportTemplate;
+	} else {
+		const filepath = pathResolve(path);
+		consola.log(` 当前读取的文件路径为: ${filepath}`);
+		// 否则读取用户传递的路径
+		return fs.readFileSync(pathResolve(path), "utf-8");
+	}
+}

package/src/vite-plugin-autogeneration-import-file/template/components.template.ts

@@ -0,0 +1,21 @@
+/* eslint-disable */
+// @ts-nocheck
+
+/**
+ * 这是特定模板
+ */
+
+/* prettier-ignore */
+declare module "vue" {
+	export interface GlobalComponents {
+		//code
+	}
+}
+
+/* prettier-ignore */
+declare global {
+	//typeCode
+}
+
+/* prettier-ignore */
+export {};

package/src/vueuse/README.md

@@ -0,0 +1,9 @@
+---
+dir:
+  order: 20
+  link: true
+---
+
+# vueuse
+
+这里对 vueuse 的函数做二次封装。

package/src/vueuse/index.ts

@@ -0,0 +1 @@
+export * from "./useAxios/index.ts";

package/src/vueuse/useAxios/README.md

@@ -0,0 +1,59 @@
+---
+order: 10
+dir:
+  collapsible: false
+  link: true
+  order: 10
+---
+
+# useAxios 的包装函数
+
+useAxiosWrapper，该函数旨在于实现 useAxios 的封装。
+
+## 安装依赖
+
+```bash
+pnpm i -P @vueuse/integrations axios
+```
+
+## 准备接口返回数据的类型
+
+接口请求返回类型，通常是一个泛型，请根据你的业务场景准备好类似于下面的类型：
+
+::: details
+
+@[code](./tests/types/ApifoxModel.ts)
+
+:::
+
+## 准备简单的 axios 请求实例
+
+这里的本质是为了准备一个拦截器内没有解包 data 的 axios 实例，因为 useAxios 默认帮我们完成 axios 的 data 解包了。
+
+比如以下的简单实例：
+
+::: details
+
+@[code](./tests/createAxiosInstance.ts)
+
+:::
+
+## 定义接口
+
+如下：
+
+::: details
+
+@[code](./tests/homeCategoryHead.ts)
+
+:::
+
+## 使用接口
+
+如下：
+
+::: details
+
+@[code](./tests/homeCategoryHead.test.ts)
+
+:::

package/tsconfig.json

@@ -32,6 +32,7 @@
 		"types": [
 			"typedoc",
 			"typedoc-plugin-markdown",
+			"node"
 		],
 	},
 	"include": [
@@ -43,6 +44,5 @@
 	"exclude": [
 		// 测试用例的全部文件 交由本项目根目录下的 tsconfig.json 处理
 		"src/tests/**/*.ts",
-		"notuse-typedoc.config.cjs"
 	]
 }