node-esm

接口

AddChangelog2docOptions

定义于: node-esm/scripts/add-changelog-to-doc.ts:6

类型参数

类型参数	默认类型
T	Record<string, any>

属性

属性	类型	描述	定义于
data	T	被插入到md头部的数据	node-esm/scripts/add-changelog-to-doc.ts:11
target	string	目标文件夹	node-esm/scripts/add-changelog-to-doc.ts:8

---

CopyClaudeAgentsOptions

定义于: node-esm/scripts/copy-claude-agents.ts:92

将 .claude/agents 文件夹复制到指定位置的配置选项

属性

属性	类型	描述	定义于
rootDir?	string	可选的根目录路径，支持相对路径（如 ../../../ 表示向上三级目录） Description - 如果不传入，将自动向上查找包含 pnpm-workspace.yaml 的 monorepo 根目录 - 相对路径会基于当前工作目录 (process.cwd()) 解析为绝对路径 - 绝对路径将直接使用 示例 // 相对路径：向上三级目录 '../../../' // 绝对路径 '/absolute/path/to/monorepo'	node-esm/scripts/copy-claude-agents.ts:131
target	string	目标文件夹路径（必须是相对路径，相对于当前工作目录） Description 重要：此参数仅接受相对路径，不接受绝对路径（禁止以 / 或盘符如 C: 开头）。 使用绝对路径会抛出错误，这是为了防止意外覆盖系统目录。 该地址是写相对路径的 不能写绝对路径，容易导致意外。 vitepress 命令运行在 apps/admin 目录内，该地址是相对于该运行目录的。 比如期望将 .claude/agents 复制到 apps/admin/src/docs/prompts/agents 文件夹。 则写 src/docs/prompts/agents 即可。 抛出 当传入绝对路径时抛出错误 Examples // ✅ 正确：相对路径 "src/docs/prompts/agents" "dist/agents" "./public/claude" // ❌ 错误：绝对路径（会抛出错误） "/var/www/agents" // Unix 绝对路径 "C:\\Users\\agents" // Windows 绝对路径	node-esm/scripts/copy-claude-agents.ts:116

---

PackageInfo

定义于: node-esm/ruan-cat-pkg-info.ts:4

包的信息

属性

属性	类型	描述	定义于
description	string	包的描述	node-esm/ruan-cat-pkg-info.ts:8
name	string	包名	node-esm/ruan-cat-pkg-info.ts:6
url	`https://npm.im/${string}`	带有包名的官方镜像源地址	node-esm/ruan-cat-pkg-info.ts:10

---

WriteYaml2mdParams

定义于: node-esm/scripts/yaml-to-md.ts:20

类型参数

类型参数	默认类型
T	Record<string, any>

属性

属性	类型	描述	定义于
data	T	被插入到md头部的数据	node-esm/scripts/yaml-to-md.ts:25
mdPath	string	目标md文件地址	node-esm/scripts/yaml-to-md.ts:22

变量

defaultCleanTargets

const defaultCleanTargets: readonly ["node_modules", "yarn.lock", "pnpm-lock.yaml", "package-lock.json", "dist", ".turbo", ".vercel", ".cache", ".temp"];

定义于: node-esm/scripts/clean.ts:5

函数

addChangelog2doc()

function addChangelog2doc<T>(options): void;

定义于: node-esm/scripts/add-changelog-to-doc.ts:15

将变更日志添加到指定的文档目录内 并提供参数

类型参数

类型参数
T

参数

参数	类型
options	AddChangelog2docOptions<T>

返回

void

---

clean()

function clean(targets?): Promise<void>;

定义于: node-esm/scripts/clean.ts:28

删除node项目的依赖项便于重新安装依赖，也包括常见的各种垃圾文件。

参数

参数	类型	描述
targets?	string[]	被清除的目标文件夹 也包括文件

返回

Promise<void>

Description

---

copyChangelogMd()

function copyChangelogMd(target): void;

定义于: node-esm/scripts/copy-changelog.ts:20

将 CHANGELOG.md 文件移动到指定要求的位置内

参数

参数	类型
target	string

返回

void

Description

该函数相当于实现 cpx CHANGELOG.md docs 命令

---

copyClaudeAgents()

function copyClaudeAgents(options): void;

定义于: node-esm/scripts/copy-claude-agents.ts:165

将 .claude/agents 文件夹复制到指定位置

参数

参数	类型	描述
options	CopyClaudeAgentsOptions	配置选项

返回

void

抛出

当 options.target 为绝对路径时抛出错误

Description

该函数相当于实现 cpx .claude/agents <target> 命令。
从根目录的 .claude/agents 复制到目标位置。

安全限制：target 参数必须是相对路径，禁止使用绝对路径，以防止意外覆盖系统目录。

Examples

// ✅ 自动检测 monorepo 根目录，复制到当前目录的 dist 文件夹
copyClaudeAgents({ target: 'dist' })

// ✅ 手动指定根目录为向上三级，复制到 build 文件夹
copyClaudeAgents({
  target: 'build',
  rootDir: '../../../'
})

// ✅ 使用绝对路径指定根目录（rootDir 允许绝对路径）
copyClaudeAgents({
  target: 'dist',  // target 必须是相对路径
  rootDir: '/absolute/path/to/monorepo'  // rootDir 可以是绝对路径
})

// ❌ 错误用法：target 使用绝对路径会抛出错误
copyClaudeAgents({ target: '/var/www/agents' })  // 抛出 Error
copyClaudeAgents({ target: 'C:\\Windows\\agents' })  // 抛出 Error

---

copyReadmeMd()

function copyReadmeMd(target): void;

定义于: node-esm/scripts/copy-readme.ts:42

将 README.md 文件移动到指定要求的位置内，并重命名为 index.md

参数

参数	类型
target	string

返回

void

Description

该函数相当于实现 cpx README.md docs 命令

---

getRuanCatPkgInfo()

function getRuanCatPkgInfo(): Promise<PackageInfo[]>;

定义于: node-esm/ruan-cat-pkg-info.ts:23

获得阮喵喵全部的包信息

返回

Promise<PackageInfo[]>

Description

这是一个node环境下的函数，用于获取阮喵喵的所有包的信息。

使用的是node的child_process模块，调用pnpm命令获取包信息。

• 默认仅考虑pnpm包
• 在node环境下运行

---

hasCapitalReadmeMd()

function hasCapitalReadmeMd(): boolean;

定义于: node-esm/scripts/copy-readme.ts:14

检查当前运行的根目录 是否存在文件名大写的 README.md 文件

返回

boolean

---

hasChangelogMd()

function hasChangelogMd(): boolean;

定义于: node-esm/scripts/copy-changelog.ts:6

检查当前运行的根目录 是否存在 CHANGELOG.md 文件

返回

boolean

---

hasClaudeAgents()

function hasClaudeAgents(options?): boolean;

定义于: node-esm/scripts/copy-claude-agents.ts:76

检查指定根目录是否存在 .claude/agents 文件夹

参数

参数	类型	描述
options?	{ rootDir?: string; }	配置选项
options.rootDir?	string	可选的根目录路径，支持相对路径（如 ../../../ 表示向上三级目录）。 如果不传入，将自动向上查找包含 pnpm-workspace.yaml 的 monorepo 根目录。 相对路径会基于当前工作目录 (process.cwd()) 解析为绝对路径。

返回

boolean

是否存在 .claude/agents 文件夹

示例

// 自动检测 monorepo 根目录
hasClaudeAgents()

// 手动指定相对路径（从当前工作目录向上三级）
hasClaudeAgents({ rootDir: '../../../' })

// 手动指定绝对路径
hasClaudeAgents({ rootDir: '/path/to/monorepo' })

---

hasLowerCaseReadmeMd()

function hasLowerCaseReadmeMd(): boolean;

定义于: node-esm/scripts/copy-readme.ts:23

检查当前运行的根目录 是否存在文件名小写的 readme.md 文件

返回

boolean

---

hasReadmeMd()

function hasReadmeMd(): boolean;

定义于: node-esm/scripts/copy-readme.ts:32

检查当前运行的根目录 是否存在任意一个大小写命名的 README.md 文件

返回

boolean

---

writeYaml2md()

function writeYaml2md<T>(params): void;

定义于: node-esm/scripts/yaml-to-md.ts:31

将YAML数据写入到MD文件内

类型参数

类型参数
T

参数

参数	类型
params	WriteYaml2mdParams<T>

返回

void

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史