@ruan-cat/utils 4.13.0 → 4.15.0

package/dist/node-cjs/index.d.cts

@@ -37,7 +37,7 @@ declare const defPrintCurrentCommand: SpawnSyncSimpleParams["printCurrentCommand
  * 之前封装的是 execa 函数
  * @version 2
  */
-declare function generateSpawnSync(spawnSyncSimpleParams: SpawnSyncSimpleParams): (...args: any) => Promise<child_process.SpawnSyncReturns<Buffer<ArrayBufferLike>>>;
+declare function generateSpawnSync(spawnSyncSimpleParams: SpawnSyncSimpleParams): (...args: any) => Promise<child_process.SpawnSyncReturns<NonSharedBuffer>>;
 
 type Condition = (...args: unknown[]) => boolean;
 /** @deprecated 没必要 */

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

@@ -30,124 +30,6 @@ declare function clean(
  */
 targets?: string[]): Promise<void>;
 
-/** 检查当前运行的根目录 是否存在 CHANGELOG.md 文件 */
-declare function hasChangelogMd(): boolean;
-/**
- * 将 CHANGELOG.md 文件移动到指定要求的位置内
- * @description
- * 该函数相当于实现 `cpx CHANGELOG.md docs` 命令
- */
-declare function copyChangelogMd(/** 目标文件夹 */ target: string): void;
-
-/**
- * 检查指定根目录是否存在 .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' })
- */
-declare function hasClaudeAgents(options?: {
-    rootDir?: string;
-}): boolean;
-/**
- * 将 .claude/agents 文件夹复制到指定位置的配置选项
- */
-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
- */
-declare function copyClaudeAgents(options: CopyClaudeAgentsOptions): void;
-
-/** 检查当前运行的根目录 是否存在文件名大写的 `README.md` 文件 */
-declare function hasCapitalReadmeMd(): boolean;
-/** 检查当前运行的根目录 是否存在文件名小写的 `readme.md` 文件 */
-declare function hasLowerCaseReadmeMd(): boolean;
-/** 检查当前运行的根目录 是否存在任意一个大小写命名的 README.md 文件 */
-declare function hasReadmeMd(): boolean;
-/**
- * 将 README.md 文件移动到指定要求的位置内，并重命名为 index.md
- * @description
- * 该函数相当于实现 `cpx README.md docs` 命令
- */
-declare function copyReadmeMd(/** 目标文件夹 */ target: string): void;
-
 interface WriteYaml2mdParams<T = Record<string, any>> {
     /** 目标md文件地址 */
     mdPath: string;
@@ -156,16 +38,9 @@ interface WriteYaml2mdParams<T = Record<string, any>> {
 }
 /**
  * 将YAML数据写入到MD文件内
+ * @deprecated
+ * 请使用 gray-matter 库来实现相关的更改，不使用 `writeYaml2md` 函数了。
  */
 declare function writeYaml2md<T>(params: WriteYaml2mdParams<T>): void;
 
-interface AddChangelog2docOptions<T = Record<string, any>> {
-    /** 目标文件夹 */
-    target: string;
-    /** 被插入到md头部的数据 */
-    data: T;
-}
-/** 将变更日志添加到指定的文档目录内 并提供参数 */
-declare function addChangelog2doc<T>(options: AddChangelog2docOptions<T>): void;
-
-export { type AddChangelog2docOptions, type CopyClaudeAgentsOptions, type PackageInfo, type WriteYaml2mdParams, addChangelog2doc, clean, copyChangelogMd, copyClaudeAgents, copyReadmeMd, defaultCleanTargets, getRuanCatPkgInfo, hasCapitalReadmeMd, hasChangelogMd, hasClaudeAgents, hasLowerCaseReadmeMd, hasReadmeMd, writeYaml2md };
+export { type PackageInfo, type WriteYaml2mdParams, clean, defaultCleanTargets, getRuanCatPkgInfo, writeYaml2md };

package/dist/node-esm/index.js

@@ -80,11 +80,6 @@ function generateSpawnSync(spawnSyncSimpleParams) {
   });
 }
 
-// src/conditions.ts
-function isConditionsSome(conditions) {
-  return conditions.some((condition) => condition());
-}
-
 // src/print.ts
 import { isPlainObject, isArray } from "lodash-es";
 import consola2 from "consola";
@@ -116,130 +111,9 @@ async function clean(targets) {
   await doClean();
 }
 
-// src/node-esm/scripts/copy-changelog.ts
-import fs from "fs";
-import path from "path";
-import consola3 from "consola";
-function hasChangelogMd() {
-  const res = fs.existsSync(path.resolve(process.cwd(), "CHANGELOG.md"));
-  if (!res) {
-    consola3.log("\u5F53\u524D\u9879\u76EE\u6839\u76EE\u5F55\u4E3A\uFF1A", process.cwd());
-    consola3.warn("\u5F53\u524D\u9879\u76EE\u6839\u76EE\u5F55\u4E0D\u5B58\u5728 CHANGELOG.md \u6587\u4EF6");
-  }
-  return res;
-}
-function copyChangelogMd(target) {
-  if (!hasChangelogMd()) {
-    return;
-  }
-  const source = path.resolve(process.cwd(), "CHANGELOG.md");
-  const destination = path.resolve(process.cwd(), target, "CHANGELOG.md");
-  fs.copyFileSync(source, destination);
-}
-
-// src/node-esm/scripts/copy-claude-agents.ts
-import fs2 from "fs";
-import path2 from "path";
-import consola4 from "consola";
-function findMonorepoRoot() {
-  let currentDir = process.cwd();
-  const root = path2.parse(currentDir).root;
-  while (currentDir !== root) {
-    const workspaceFile2 = path2.join(currentDir, "pnpm-workspace.yaml");
-    if (fs2.existsSync(workspaceFile2)) {
-      return currentDir;
-    }
-    currentDir = path2.dirname(currentDir);
-  }
-  const workspaceFile = path2.join(root, "pnpm-workspace.yaml");
-  if (fs2.existsSync(workspaceFile)) {
-    return root;
-  }
-  return null;
-}
-function resolveRootDir(rootDir) {
-  if (rootDir) {
-    return path2.resolve(process.cwd(), rootDir);
-  }
-  const monorepoRoot = findMonorepoRoot();
-  if (monorepoRoot) {
-    return monorepoRoot;
-  }
-  return process.cwd();
-}
-function hasClaudeAgents(options) {
-  const root = resolveRootDir(options?.rootDir);
-  const claudeAgentsPath = path2.join(root, ".claude/agents");
-  const exists = fs2.existsSync(claudeAgentsPath);
-  if (!exists) {
-    consola4.log("\u68C0\u6D4B\u7684\u6839\u76EE\u5F55\u4E3A\uFF1A", root);
-    consola4.warn("\u8BE5\u6839\u76EE\u5F55\u4E0D\u5B58\u5728 .claude/agents \u6587\u4EF6\u5939");
-  }
-  return exists;
-}
-function copyClaudeAgents(options) {
-  if (path2.isAbsolute(options.target)) {
-    const errorMessage = [
-      `target \u53C2\u6570\u4E0D\u5141\u8BB8\u4F7F\u7528\u7EDD\u5BF9\u8DEF\u5F84\uFF0C\u8FD9\u53EF\u80FD\u5BFC\u81F4\u610F\u5916\u7684\u6587\u4EF6\u8986\u76D6\u3002`,
-      `\u5F53\u524D\u4F20\u5165\u7684\u8DEF\u5F84: "${options.target}"`,
-      `\u8BF7\u4F7F\u7528\u76F8\u5BF9\u8DEF\u5F84\uFF0C\u4F8B\u5982: "src/docs/prompts/agents"`
-    ].join("\n");
-    consola4.error(errorMessage);
-    throw new Error(errorMessage);
-  }
-  if (!hasClaudeAgents({ rootDir: options.rootDir })) {
-    return;
-  }
-  const root = resolveRootDir(options.rootDir);
-  const source = path2.join(root, ".claude/agents");
-  const destination = path2.resolve(process.cwd(), options.target);
-  fs2.mkdirSync(path2.dirname(destination), { recursive: true });
-  fs2.cpSync(source, destination, { recursive: true });
-  consola4.success(`\u5DF2\u6210\u529F\u590D\u5236 .claude/agents \u5230 ${destination}`);
-}
-
-// src/node-esm/scripts/copy-readme.ts
-import fs3 from "fs";
-import path3 from "path";
-import consola5 from "consola";
-var capitalReadmeMd = "README.md";
-var lowerCaseReadmeMd = "readme.md";
-function hasCapitalReadmeMd() {
-  const res = fs3.existsSync(path3.resolve(process.cwd(), capitalReadmeMd));
-  if (!res) {
-    consola5.warn(`\u5F53\u524D\u9879\u76EE\u6839\u76EE\u5F55\u4E0D\u5B58\u5728 ${capitalReadmeMd} \u6587\u4EF6`);
-  }
-  return res;
-}
-function hasLowerCaseReadmeMd() {
-  const res = fs3.existsSync(path3.resolve(process.cwd(), lowerCaseReadmeMd));
-  if (!res) {
-    consola5.log(`\u5F53\u524D\u9879\u76EE\u6839\u76EE\u5F55\u4E0D\u5B58\u5728 ${lowerCaseReadmeMd} \u6587\u4EF6`);
-  }
-  return res;
-}
-function hasReadmeMd() {
-  const res = isConditionsSome([() => hasCapitalReadmeMd(), () => hasCapitalReadmeMd()]);
-  return res;
-}
-function copyReadmeMd(target) {
-  if (!hasReadmeMd()) {
-    return;
-  }
-  let readmeFileName = capitalReadmeMd;
-  if (hasCapitalReadmeMd()) {
-    readmeFileName = capitalReadmeMd;
-  } else if (hasLowerCaseReadmeMd()) {
-    readmeFileName = lowerCaseReadmeMd;
-  }
-  const source = path3.resolve(process.cwd(), readmeFileName);
-  const destination = path3.resolve(process.cwd(), target, "index.md");
-  fs3.copyFileSync(source, destination);
-}
-
-// src/node-esm/scripts/yaml-to-md.ts
+// src/node-esm/yaml-to-md.ts
 import { readFileSync, writeFileSync } from "fs";
-import { consola as consola6 } from "consola";
+import { consola as consola3 } from "consola";
 import { isUndefined } from "lodash-es";
 
 // ../../node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/dist/js-yaml.mjs
@@ -2864,18 +2738,18 @@ var jsYaml = {
 };
 var js_yaml_default = jsYaml;
 
-// src/node-esm/scripts/yaml-to-md.ts
+// src/node-esm/yaml-to-md.ts
 function writeYaml2md(params) {
-  consola6.info(` \u5F53\u524D\u8FD0\u884C\u7684\u5730\u5740\u4E3A\uFF1A ${process.cwd()} `);
+  consola3.info(` \u5F53\u524D\u8FD0\u884C\u7684\u5730\u5740\u4E3A\uFF1A ${process.cwd()} `);
   const { mdPath, data } = params;
   if (isUndefined(mdPath)) {
-    consola6.error(" \u8BF7\u63D0\u4F9Bmd\u6587\u4EF6\u7684\u5730\u5740 ");
+    consola3.error(" \u8BF7\u63D0\u4F9Bmd\u6587\u4EF6\u7684\u5730\u5740 ");
     process.exit(1);
   }
   try {
     readFileSync(mdPath, "utf-8");
   } catch (error) {
-    consola6.error(` \u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728 `);
+    consola3.error(` \u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728 `);
     process.exit(1);
   }
   const mdContent = readFileSync(mdPath, "utf-8");
@@ -2885,36 +2759,12 @@ ${yamlContent}---
 
 ${mdContent}`;
   writeFileSync(mdPath, newContent, "utf-8");
-  consola6.success(` \u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath} `);
-}
-
-// src/node-esm/scripts/add-changelog-to-doc.ts
-import path4 from "path";
-function addChangelog2doc(options) {
-  const { data, target } = options;
-  if (!hasChangelogMd()) {
-    return;
-  }
-  copyChangelogMd(target);
-  const mdPath = path4.resolve(process.cwd(), target, "CHANGELOG.md");
-  writeYaml2md({
-    mdPath,
-    data
-  });
+  consola3.success(` \u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath} `);
 }
 export {
-  addChangelog2doc,
   clean,
-  copyChangelogMd,
-  copyClaudeAgents,
-  copyReadmeMd,
   defaultCleanTargets,
   getRuanCatPkgInfo,
-  hasCapitalReadmeMd,
-  hasChangelogMd,
-  hasClaudeAgents,
-  hasLowerCaseReadmeMd,
-  hasReadmeMd,
   writeYaml2md
 };
 /*! Bundled license information: