@ruan-cat/utils 4.8.1 → 4.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "4.8.1",
+  "version": "4.9.1",
   "description": "阮喵喵工具集合。默认提供js文件，也直接提供ts文件。",
   "type": "module",
   "main": "./src/index.ts",
@@ -60,27 +60,27 @@
     "tsconfig.json"
   ],
   "dependencies": {
-    "@vueuse/integrations": "^13.3.0",
-    "axios": "^1.8.1",
-    "consola": "^3.4.0",
+    "@vueuse/integrations": "^13.5.0",
+    "axios": "^1.11.0",
+    "consola": "^3.4.2",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {
-    "@antfu/utils": "^9.1.0",
+    "@antfu/utils": "^9.2.0",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^22.13.8",
-    "@types/qs": "^6.9.18",
+    "@types/node": "^22.16.5",
+    "@types/qs": "^6.14.0",
     "commander": "^13.1.0",
     "js-yaml": "^4.1.0",
     "qs": "^6.14.0",
-    "tsup": "^8.4.0",
+    "tsup": "^8.5.0",
     "type-plus": "^7.6.2",
-    "typedoc": "^0.28.0",
+    "typedoc": "^0.28.7",
     "typedoc-plugin-frontmatter": "^1.3.0",
-    "typedoc-plugin-markdown": "^4.5.0",
-    "typescript": "^5.8.2",
-    "unplugin-auto-import": "^19.1.1",
-    "unplugin-vue-router": "^0.12.0",
+    "typedoc-plugin-markdown": "^4.7.1",
+    "typescript": "^5.8.3",
+    "unplugin-auto-import": "^19.3.0",
+    "unplugin-vue-router": "^0.14.0",
     "vite-plugin-autogeneration-import-file": "^3.0.0",
     "vitepress": "^1.6.3"
   },

package/src/.vitepress/config.mts

@@ -1,9 +1,11 @@
 // 工具包文档项目 直接导入生成文档配置 避免出现循环依赖
 import { setUserConfig, setGenerateSidebar, withMermaid } from "../../../vitepress-preset-config";
-import { addChangelog2doc } from "@ruan-cat/utils/node-esm";
+import { addChangelog2doc, copyReadmeMd } from "@ruan-cat/utils/node-esm";
 
 import { description } from "../../package.json";
 
+copyReadmeMd("./src");
+
 addChangelog2doc({
 	target: "./src",
 	data: {

package/src/node-esm/index.ts

@@ -2,5 +2,6 @@ export * from "./ruan-cat-pkg-info";
 
 export * from "./scripts/clean";
 export * from "./scripts/copy-changelog";
+export * from "./scripts/copy-readme";
 export * from "./scripts/yaml-to-md";
 export * from "./scripts/add-changelog-to-doc";

package/src/node-esm/scripts/copy-readme.ts

@@ -0,0 +1,58 @@
+import fs from "node:fs";
+import path from "node:path";
+import consola from "consola";
+
+import { isConditionsSome } from "../../conditions";
+
+/** 大写字母的文件 */
+const capitalReadmeMd = "README.md" as const;
+
+/** 小写字母的文件 */
+const lowerCaseReadmeMd = "readme.md" as const;
+
+/** 检查当前运行的根目录 是否存在文件名大写的 `README.md` 文件 */
+export function hasCapitalReadmeMd() {
+	const res = fs.existsSync(path.resolve(process.cwd(), capitalReadmeMd));
+	if (!res) {
+		consola.warn(`当前项目根目录不存在 ${capitalReadmeMd} 文件`);
+	}
+	return res;
+}
+
+/** 检查当前运行的根目录 是否存在文件名小写的 `readme.md` 文件 */
+export function hasLowerCaseReadmeMd() {
+	const res = fs.existsSync(path.resolve(process.cwd(), lowerCaseReadmeMd));
+	if (!res) {
+		consola.log(`当前项目根目录不存在 ${lowerCaseReadmeMd} 文件`);
+	}
+	return res;
+}
+
+/** 检查当前运行的根目录 是否存在任意一个大小写命名的 README.md 文件 */
+export function hasReadmeMd() {
+	const res = isConditionsSome([() => hasCapitalReadmeMd(), () => hasCapitalReadmeMd()]);
+	return res;
+}
+
+/**
+ * 将 README.md 文件移动到指定要求的位置内，并重命名为 index.md
+ * @description
+ * 该函数相当于实现 `cpx README.md docs` 命令
+ */
+export function copyReadmeMd(/** 目标文件夹 */ target: string) {
+	if (!hasReadmeMd()) {
+		return;
+	}
+
+	let readmeFileName: string = capitalReadmeMd;
+	if (hasCapitalReadmeMd()) {
+		readmeFileName = capitalReadmeMd;
+	} else if (hasLowerCaseReadmeMd()) {
+		readmeFileName = lowerCaseReadmeMd;
+	}
+
+	const source = path.resolve(process.cwd(), readmeFileName);
+	const destination = path.resolve(process.cwd(), target, "index.md");
+
+	fs.copyFileSync(source, destination);
+}