@ruan-cat/utils 4.0.0 → 4.1.0

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

@@ -0,0 +1,26 @@
+import fs from "node:fs";
+import path from "node:path";
+import consola from "consola";
+
+/** 检查当前运行的根目录 是否存在 CHANGELOG.md 文件 */
+export function hasChangelogMd() {
+	consola.log("当前项目根目录为：", process.cwd());
+	consola.warn("当前项目根目录不存在 CHANGELOG.md 文件");
+	return fs.existsSync(path.resolve(process.cwd(), "CHANGELOG.md"));
+}
+
+/**
+ * 将 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/yaml-to-md.ts

@@ -0,0 +1,69 @@
+import { readFileSync, writeFileSync } from "node:fs";
+
+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;
+
+	/** 被插入到md头部的数据 */
+	data: T;
+}
+
+/**
+ * 将YAML数据写入到MD文件内
+ */
+export function writeYaml2md<T>(params: WriteYaml2mdParams<T>) {
+	consola.info(` 当前运行的地址为： ${process.cwd()} `);
+	const { mdPath, data } = params;
+
+	if (isUndefined(mdPath)) {
+		consola.error(" 请提供md文件的地址 ");
+		process.exit(1);
+	}
+
+	// Check if file exists
+	try {
+		readFileSync(mdPath, "utf-8");
+	} catch (error) {
+		consola.error(` 文件 ${mdPath} 不存在 `);
+		process.exit(1);
+	}
+
+	// Read the existing MD file
+	const mdContent = readFileSync(mdPath, "utf-8");
+
+	// Convert data to YAML
+	const yamlContent = yaml.dump(data);
+
+	// Combine YAML with MD content
+	const newContent = `---\n${yamlContent}---\n\n${mdContent}`;
+
+	// 警告 暂不考虑使用本函数内的prettier功能 避免打包体积太大
+	// Format with prettier using project config
+	// const formattedContent = await prettier.format(newContent, {
+	// 	parser: "markdown",
+	// 	...prettierConfig,
+	// });
+
+	// Write back to file
+	// writeFileSync(mdPath, formattedContent, "utf-8");
+	writeFileSync(mdPath, newContent, "utf-8");
+
+	consola.success(` 已将YAML数据写入到 ${mdPath} `);
+}