@ruan-cat/utils 4.13.0 → 4.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "4.13.0",
+  "version": "4.14.0",
   "description": "阮喵喵工具集合。默认提供js文件，也直接提供ts文件。",
   "type": "module",
   "main": "./src/index.ts",
@@ -16,7 +16,7 @@
   },
   "exports": {
     ".": {
-      "types": "./dsit/index.d.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },

package/src/.vitepress/config.mts

@@ -1,6 +1,5 @@
 // 工具包文档项目 直接导入生成文档配置 避免出现循环依赖
-import { setUserConfig, setGenerateSidebar } from "../../../vitepress-preset-config";
-import { addChangelog2doc, copyReadmeMd } from "@ruan-cat/utils/node-esm";
+import { setUserConfig, setGenerateSidebar, addChangelog2doc, copyReadmeMd } from "../../../vitepress-preset-config";
 
 import { description } from "../../package.json";
 
@@ -20,6 +19,9 @@ const userConfig = setUserConfig({
 	title: "阮喵喵工具包",
 	description,
 	themeConfig: {
+		editLink: {
+			pattern: "https://github.com/ruan-cat/monorepo/blob/dev/packages/utils/src/:path",
+		},
 		socialLinks: [
 			{
 				icon: "github",

package/src/node-esm/index.ts

@@ -1,8 +1,4 @@
 export * from "./ruan-cat-pkg-info";
 
 export * from "./scripts/clean";
-export * from "./scripts/copy-changelog";
-export * from "./scripts/copy-claude-agents";
-export * from "./scripts/copy-readme";
-export * from "./scripts/yaml-to-md";
-export * from "./scripts/add-changelog-to-doc";
+export * from "./yaml-to-md";

package/src/node-esm/{scripts/yaml-to-md.ts → yaml-to-md.ts}

@@ -4,19 +4,6 @@ import { consola } from "consola";
 import { isUndefined } from "lodash-es";
 import yaml from "js-yaml";
 
-// import { program } from "commander";
-// import prettier from "prettier";
-// import prettierConfig from "../prettier.config.js";
-// program
-// 	.name("yaml-in-md")
-// 	// 环境变量的地址
-// 	.option("--md <path>", "目标md文件的地址，目前仅考虑单个文件")
-// 	.parse();
-// const options = program.opts();
-// consola.info(" 查看命令行提供的参数 ", options);
-// /** md文件的地址 */
-// const defMdPath: string = options?.md;
-
 export interface WriteYaml2mdParams<T = Record<string, any>> {
 	/** 目标md文件地址 */
 	mdPath: string;

package/src/node-esm/scripts/add-changelog-to-doc.ts

@@ -1,29 +0,0 @@
-import path from "node:path";
-
-import { copyChangelogMd, hasChangelogMd } from "./copy-changelog";
-import { writeYaml2md } from "./yaml-to-md";
-
-export interface AddChangelog2docOptions<T = Record<string, any>> {
-	/** 目标文件夹 */
-	target: string;
-
-	/** 被插入到md头部的数据 */
-	data: T;
-}
-
-/** 将变更日志添加到指定的文档目录内 并提供参数 */
-export function addChangelog2doc<T>(options: AddChangelog2docOptions<T>) {
-	const { data, target } = options;
-
-	if (!hasChangelogMd()) {
-		return;
-	}
-
-	copyChangelogMd(target);
-
-	const mdPath = path.resolve(process.cwd(), target, "CHANGELOG.md");
-	writeYaml2md({
-		mdPath,
-		data,
-	});
-}

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

@@ -1,29 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import consola from "consola";
-
-/** 检查当前运行的根目录 是否存在 CHANGELOG.md 文件 */
-export function hasChangelogMd() {
-	const res = fs.existsSync(path.resolve(process.cwd(), "CHANGELOG.md"));
-	if (!res) {
-		consola.log("当前项目根目录为：", process.cwd());
-		consola.warn("当前项目根目录不存在 CHANGELOG.md 文件");
-	}
-	return res;
-}
-
-/**
- * 将 CHANGELOG.md 文件移动到指定要求的位置内
- * @description
- * 该函数相当于实现 `cpx CHANGELOG.md docs` 命令
- */
-export function copyChangelogMd(/** 目标文件夹 */ target: string) {
-	if (!hasChangelogMd()) {
-		return;
-	}
-
-	const source = path.resolve(process.cwd(), "CHANGELOG.md");
-	const destination = path.resolve(process.cwd(), target, "CHANGELOG.md");
-
-	fs.copyFileSync(source, destination);
-}

package/src/node-esm/scripts/copy-claude-agents.ts

@@ -1,194 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import consola from "consola";
-
-/**
- * 从当前工作目录向上查找 monorepo 根目录
- * @returns monorepo 根目录的绝对路径，如果找不到则返回 null
- * @description
- * 通过查找 pnpm-workspace.yaml 文件来定位 monorepo 根目录。
- * 从 process.cwd() 开始向上遍历，直到找到该文件或到达文件系统根目录。
- */
-function findMonorepoRoot(): string | null {
-	let currentDir = process.cwd();
-	const root = path.parse(currentDir).root;
-
-	while (currentDir !== root) {
-		const workspaceFile = path.join(currentDir, "pnpm-workspace.yaml");
-		if (fs.existsSync(workspaceFile)) {
-			return currentDir;
-		}
-		currentDir = path.dirname(currentDir);
-	}
-
-	// 检查根目录本身
-	const workspaceFile = path.join(root, "pnpm-workspace.yaml");
-	if (fs.existsSync(workspaceFile)) {
-		return root;
-	}
-
-	return null;
-}
-
-/**
- * 解析根目录路径
- * @param rootDir - 根目录路径，支持相对路径（如 `../../../`）或绝对路径
- * @returns 解析后的绝对路径
- * @description
- * 路径解析优先级：
- * 1. 如果传入 rootDir，将相对路径基于 process.cwd() 解析为绝对路径
- * 2. 如果未传入 rootDir，自动向上查找包含 pnpm-workspace.yaml 的 monorepo 根目录
- * 3. 如果自动查找失败，回退到 process.cwd()
- */
-function resolveRootDir(rootDir?: string): string {
-	if (rootDir) {
-		// 将相对路径或绝对路径解析为绝对路径
-		return path.resolve(process.cwd(), rootDir);
-	}
-
-	// 自动查找 monorepo 根目录
-	const monorepoRoot = findMonorepoRoot();
-	if (monorepoRoot) {
-		return monorepoRoot;
-	}
-
-	// 回退到当前工作目录
-	return process.cwd();
-}
-
-/**
- * 检查指定根目录是否存在 .claude/agents 文件夹
- * @param options - 配置选项
- * @param options.rootDir - 可选的根目录路径，支持相对路径（如 `../../../` 表示向上三级目录）。
- *                          如果不传入，将自动向上查找包含 pnpm-workspace.yaml 的 monorepo 根目录。
- *                          相对路径会基于当前工作目录 (process.cwd()) 解析为绝对路径。
- * @returns 是否存在 .claude/agents 文件夹
- * @example
- * // 自动检测 monorepo 根目录
- * hasClaudeAgents()
- *
- * // 手动指定相对路径（从当前工作目录向上三级）
- * hasClaudeAgents({ rootDir: '../../../' })
- *
- * // 手动指定绝对路径
- * hasClaudeAgents({ rootDir: '/path/to/monorepo' })
- */
-export function hasClaudeAgents(options?: { rootDir?: string }): boolean {
-	const root = resolveRootDir(options?.rootDir);
-	const claudeAgentsPath = path.join(root, ".claude/agents");
-	const exists = fs.existsSync(claudeAgentsPath);
-
-	if (!exists) {
-		consola.log("检测的根目录为：", root);
-		consola.warn("该根目录不存在 .claude/agents 文件夹");
-	}
-
-	return exists;
-}
-
-/**
- * 将 .claude/agents 文件夹复制到指定位置的配置选项
- */
-export interface CopyClaudeAgentsOptions {
-	/**
-	 * 目标文件夹路径（必须是相对路径，相对于当前工作目录）
-	 * @description
-	 * **重要**：此参数仅接受相对路径，不接受绝对路径（禁止以 `/` 或盘符如 `C:\` 开头）。
-	 * 使用绝对路径会抛出错误，这是为了防止意外覆盖系统目录。
-	 *
-	 * 该地址是写相对路径的 不能写绝对路径，容易导致意外。
-	 * vitepress 命令运行在 apps/admin 目录内，该地址是相对于该运行目录的。
-	 * 比如期望将 `.claude/agents` 复制到 `apps/admin/src/docs/prompts/agents` 文件夹。
-	 * 则写 `src/docs/prompts/agents` 即可。
-	 *
-	 * @throws {Error} 当传入绝对路径时抛出错误
-	 * @example
-	 * // ✅ 正确：相对路径
-	 * "src/docs/prompts/agents"
-	 * "dist/agents"
-	 * "./public/claude"
-	 *
-	 * @example
-	 * // ❌ 错误：绝对路径（会抛出错误）
-	 * "/var/www/agents"           // Unix 绝对路径
-	 * "C:\\Users\\agents"         // Windows 绝对路径
-	 */
-	target: string;
-
-	/**
-	 * 可选的根目录路径，支持相对路径（如 `../../../` 表示向上三级目录）
-	 * @description
-	 * - 如果不传入，将自动向上查找包含 pnpm-workspace.yaml 的 monorepo 根目录
-	 * - 相对路径会基于当前工作目录 (process.cwd()) 解析为绝对路径
-	 * - 绝对路径将直接使用
-	 * @example
-	 * // 相对路径：向上三级目录
-	 * '../../../'
-	 *
-	 * // 绝对路径
-	 * '/absolute/path/to/monorepo'
-	 */
-	rootDir?: string;
-}
-
-/**
- * 将 .claude/agents 文件夹复制到指定位置
- * @param options - 配置选项
- * @throws {Error} 当 `options.target` 为绝对路径时抛出错误
- * @description
- * 该函数相当于实现 `cpx .claude/agents <target>` 命令。
- * 从根目录的 .claude/agents 复制到目标位置。
- *
- * **安全限制**：`target` 参数必须是相对路径，禁止使用绝对路径，以防止意外覆盖系统目录。
- *
- * @example
- * // ✅ 自动检测 monorepo 根目录，复制到当前目录的 dist 文件夹
- * copyClaudeAgents({ target: 'dist' })
- *
- * // ✅ 手动指定根目录为向上三级，复制到 build 文件夹
- * copyClaudeAgents({
- *   target: 'build',
- *   rootDir: '../../../'
- * })
- *
- * // ✅ 使用绝对路径指定根目录（rootDir 允许绝对路径）
- * copyClaudeAgents({
- *   target: 'dist',  // target 必须是相对路径
- *   rootDir: '/absolute/path/to/monorepo'  // rootDir 可以是绝对路径
- * })
- *
- * @example
- * // ❌ 错误用法：target 使用绝对路径会抛出错误
- * copyClaudeAgents({ target: '/var/www/agents' })  // 抛出 Error
- * copyClaudeAgents({ target: 'C:\\Windows\\agents' })  // 抛出 Error
- */
-export function copyClaudeAgents(options: CopyClaudeAgentsOptions): void {
-	// 验证 target 不能是绝对路径
-	if (path.isAbsolute(options.target)) {
-		const errorMessage = [
-			`target 参数不允许使用绝对路径，这可能导致意外的文件覆盖。`,
-			`当前传入的路径: "${options.target}"`,
-			`请使用相对路径，例如: "src/docs/prompts/agents"`,
-		].join("\n");
-
-		consola.error(errorMessage);
-		throw new Error(errorMessage);
-	}
-
-	// 检查源目录是否存在
-	if (!hasClaudeAgents({ rootDir: options.rootDir })) {
-		return;
-	}
-
-	const root = resolveRootDir(options.rootDir);
-	const source = path.join(root, ".claude/agents");
-	const destination = path.resolve(process.cwd(), options.target);
-
-	// 确保目标文件夹的父目录存在
-	fs.mkdirSync(path.dirname(destination), { recursive: true });
-
-	// 递归复制文件夹
-	fs.cpSync(source, destination, { recursive: true });
-
-	consola.success(`已成功复制 .claude/agents 到 ${destination}`);
-}

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

@@ -1,58 +0,0 @@
-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);
-}