node-esm

接口

AddChangelog2docOptions<T>

定义于: 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

---

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<T>

定义于: 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 命令

---

getRuanCatPkgInfo()

function getRuanCatPkgInfo(): Promise<PackageInfo[]>

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

获得阮喵喵全部的包信息

返回

Promise<PackageInfo[]>

Description

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

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

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

---

hasChangelogMd()

function hasChangelogMd(): boolean

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

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

返回

boolean

---

writeYaml2md()

function writeYaml2md<T>(params): void

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

将YAML数据写入到MD文件内

类型参数

类型参数
T

参数

参数	类型
params	WriteYaml2mdParams<T>

返回

void

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史