@ruan-cat/utils 4.0.0 → 4.1.1

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

@@ -30,4 +30,33 @@ declare function clean(
  */
 targets?: string[]): Promise<void>;
 
-export { type PackageInfo, clean, defaultCleanTargets, getRuanCatPkgInfo };
+/** 检查当前运行的根目录 是否存在 CHANGELOG.md 文件 */
+declare function hasChangelogMd(): boolean;
+/**
+ * 将 CHANGELOG.md 文件移动到指定要求的位置内
+ * @description
+ * 该函数相当于实现 `cpx CHANGELOG.md docs` 命令
+ */
+declare function copyChangelogMd(/** 目标文件夹 */ target: string): void;
+
+interface WriteYaml2mdParams<T = Record<string, any>> {
+    /** 目标md文件地址 */
+    mdPath: string;
+    /** 被插入到md头部的数据 */
+    data: T;
+}
+/**
+ * 将YAML数据写入到MD文件内
+ */
+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 PackageInfo, type WriteYaml2mdParams, addChangelog2doc, clean, copyChangelogMd, defaultCleanTargets, getRuanCatPkgInfo, hasChangelogMd, writeYaml2md };