@ruan-cat/vitepress-preset-config 2.8.0 → 2.10.0

package/dist/config.d.mts

@@ -127,14 +127,14 @@ interface CopyClaudeAgentsOptions {
  */
 declare function copyClaudeAgents(options: CopyClaudeAgentsOptions): void;
 
-interface AddChangelog2docOptions<T = Record<string, any>> {
+interface AddChangelog2docOptions<T extends Record<string, any> = Record<string, any>> {
     /** 目标文件夹 */
     target: string;
     /** 被插入到md头部的数据 */
-    data: T;
+    data?: T;
 }
 /** 将变更日志添加到指定的文档目录内 并提供参数 */
-declare function addChangelog2doc<T>(options: AddChangelog2docOptions<T>): void;
+declare function addChangelog2doc<T extends Record<string, any>>(options: AddChangelog2docOptions<T>): void;
 
 type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 /**

package/dist/config.mjs

@@ -119,6 +119,9 @@ function copyClaudeAgents(options) {
 
 // src/config/add-changelog-to-doc.ts
 import path4 from "path";
+import fs4 from "fs";
+import consola4 from "consola";
+import matter from "gray-matter";
 
 // src/utils/copy-changelog.ts
 import fs3 from "fs";
@@ -142,18 +145,27 @@ function copyChangelogMd(target) {
 }
 
 // src/config/add-changelog-to-doc.ts
-import { writeYaml2md } from "@ruan-cat/utils/node-esm";
 function addChangelog2doc(options) {
-  const { data, target } = options;
+  const { data = pageOrderConfig.changelog, target } = options;
   if (!hasChangelogMd()) {
     return;
   }
   copyChangelogMd(target);
   const mdPath = path4.resolve(process.cwd(), target, "CHANGELOG.md");
-  writeYaml2md({
-    mdPath,
-    data
-  });
+  try {
+    if (fs4.existsSync(mdPath)) {
+      const fileContent = fs4.readFileSync(mdPath, "utf-8");
+      const parsed = matter(fileContent);
+      const newContent = matter.stringify(parsed.content, data);
+      fs4.writeFileSync(mdPath, newContent, "utf-8");
+      consola4.success(`\u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath}`);
+    } else {
+      consola4.warn(`\u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728\uFF0C\u65E0\u6CD5\u5199\u5165 YAML frontmatter`);
+    }
+  } catch (error) {
+    consola4.error(`\u5199\u5165 YAML \u6570\u636E\u5230 ${mdPath} \u65F6\u53D1\u751F\u9519\u8BEF:`, error);
+    throw error;
+  }
 }
 
 // src/config/plugins.ts
@@ -191,28 +203,28 @@ function handlePlugins(userConfig, extraConfig) {
 }
 
 // src/config/changelog-nav.ts
-import consola4 from "consola";
+import consola5 from "consola";
 import { isUndefined } from "lodash-es";
 function handleChangeLog(userConfig) {
   var _a;
   if (!hasChangelogMd()) {
-    consola4.warn(` \u672A\u627E\u5230\u53D8\u66F4\u65E5\u5FD7\u6587\u4EF6\uFF0C\u4E0D\u6DFB\u52A0\u53D8\u66F4\u65E5\u5FD7\u5BFC\u822A\u680F\u3002 `);
+    consola5.warn(` \u672A\u627E\u5230\u53D8\u66F4\u65E5\u5FD7\u6587\u4EF6\uFF0C\u4E0D\u6DFB\u52A0\u53D8\u66F4\u65E5\u5FD7\u5BFC\u822A\u680F\u3002 `);
     return;
   }
   const nav = (_a = userConfig == null ? void 0 : userConfig.themeConfig) == null ? void 0 : _a.nav;
   if (isUndefined(nav)) {
-    consola4.error(` \u5F53\u524D\u7684\u7528\u6237\u914D\u7F6E\u4E3A\uFF1A `, userConfig);
+    consola5.error(` \u5F53\u524D\u7684\u7528\u6237\u914D\u7F6E\u4E3A\uFF1A `, userConfig);
     throw new Error(` nav \u9ED8\u8BA4\u63D0\u4F9B\u7684\u5BFC\u822A\u680F\u914D\u7F6E\u4E3A\u7A7A\u3002\u4E0D\u7B26\u5408\u9ED8\u8BA4\u914D\u7F6E\uFF0C\u8BF7\u68C0\u67E5\u3002 `);
   }
   nav.push({ text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" });
 }
 
 // src/config/prompts-nav.ts
-import fs4 from "fs";
+import fs5 from "fs";
 import path5 from "path";
-import consola5 from "consola";
+import consola6 from "consola";
 import { isUndefined as isUndefined2, merge } from "lodash-es";
-import matter from "gray-matter";
+import matter2 from "gray-matter";
 var PROMPTS_INDEX_MD_PATH = "prompts/index.md";
 function getProjectRootFromArgs() {
   const args = process.argv;
@@ -239,8 +251,8 @@ function getVitepressProjectRoot() {
   const projectRootFromArgs = getProjectRootFromArgs();
   if (projectRootFromArgs) {
     const vitepressDir2 = path5.join(projectRootFromArgs, ".vitepress");
-    if (fs4.existsSync(vitepressDir2)) {
-      consola5.log("\u4ECE\u547D\u4EE4\u884C\u53C2\u6570\u83B7\u53D6\u5230 VitePress \u9879\u76EE\u6839\u76EE\u5F55\uFF1A", projectRootFromArgs);
+    if (fs5.existsSync(vitepressDir2)) {
+      consola6.log("\u4ECE\u547D\u4EE4\u884C\u53C2\u6570\u83B7\u53D6\u5230 VitePress \u9879\u76EE\u6839\u76EE\u5F55\uFF1A", projectRootFromArgs);
       return projectRootFromArgs;
     }
   }
@@ -248,19 +260,19 @@ function getVitepressProjectRoot() {
   const root = path5.parse(currentDir).root;
   while (currentDir !== root) {
     const vitepressDir2 = path5.join(currentDir, ".vitepress");
-    if (fs4.existsSync(vitepressDir2)) {
-      consola5.log("\u901A\u8FC7\u5411\u4E0A\u67E5\u627E\u83B7\u53D6\u5230 VitePress \u9879\u76EE\u6839\u76EE\u5F55\uFF1A", currentDir);
+    if (fs5.existsSync(vitepressDir2)) {
+      consola6.log("\u901A\u8FC7\u5411\u4E0A\u67E5\u627E\u83B7\u53D6\u5230 VitePress \u9879\u76EE\u6839\u76EE\u5F55\uFF1A", currentDir);
       return currentDir;
     }
     currentDir = path5.dirname(currentDir);
   }
   const vitepressDir = path5.join(root, ".vitepress");
-  if (fs4.existsSync(vitepressDir)) {
-    consola5.log("\u5728\u6587\u4EF6\u7CFB\u7EDF\u6839\u76EE\u5F55\u627E\u5230 VitePress \u9879\u76EE\u6839\u76EE\u5F55\uFF1A", root);
+  if (fs5.existsSync(vitepressDir)) {
+    consola6.log("\u5728\u6587\u4EF6\u7CFB\u7EDF\u6839\u76EE\u5F55\u627E\u5230 VitePress \u9879\u76EE\u6839\u76EE\u5F55\uFF1A", root);
     return root;
   }
   const fallbackDir = process.cwd();
-  consola5.warn("\u672A\u627E\u5230 .vitepress \u76EE\u5F55\uFF0C\u56DE\u9000\u5230\u5F53\u524D\u5DE5\u4F5C\u76EE\u5F55\uFF1A", fallbackDir);
+  consola6.warn("\u672A\u627E\u5230 .vitepress \u76EE\u5F55\uFF0C\u56DE\u9000\u5230\u5F53\u524D\u5DE5\u4F5C\u76EE\u5F55\uFF1A", fallbackDir);
   return fallbackDir;
 }
 function getVitepressSourceDirectory(userConfig) {
@@ -268,19 +280,19 @@ function getVitepressSourceDirectory(userConfig) {
   const srcDir = userConfig.srcDir;
   if (srcDir) {
     const sourceDirectory = path5.resolve(projectRoot, srcDir);
-    consola5.log("\u4ECE\u914D\u7F6E\u4E2D\u83B7\u53D6\u5230 srcDir:", srcDir);
-    consola5.log("VitePress \u6E90\u76EE\u5F55\u4E3A\uFF1A", sourceDirectory);
+    consola6.log("\u4ECE\u914D\u7F6E\u4E2D\u83B7\u53D6\u5230 srcDir:", srcDir);
+    consola6.log("VitePress \u6E90\u76EE\u5F55\u4E3A\uFF1A", sourceDirectory);
     return sourceDirectory;
   }
-  consola5.log("\u914D\u7F6E\u4E2D\u672A\u6307\u5B9A srcDir\uFF0C\u6E90\u76EE\u5F55\u7B49\u4E8E\u9879\u76EE\u6839\u76EE\u5F55\uFF1A", projectRoot);
+  consola6.log("\u914D\u7F6E\u4E2D\u672A\u6307\u5B9A srcDir\uFF0C\u6E90\u76EE\u5F55\u7B49\u4E8E\u9879\u76EE\u6839\u76EE\u5F55\uFF1A", projectRoot);
   return projectRoot;
 }
 function hasPromptsIndexMd(userConfig) {
   const sourceDir = getVitepressSourceDirectory(userConfig);
-  const res = fs4.existsSync(path5.resolve(sourceDir, PROMPTS_INDEX_MD_PATH));
+  const res = fs5.existsSync(path5.resolve(sourceDir, PROMPTS_INDEX_MD_PATH));
   if (!res) {
-    consola5.log("\u5F53\u524D\u9879\u76EE\u7684vitepress\u6E90\u76EE\u5F55\u4E3A\uFF1A", sourceDir);
-    consola5.warn(`\u5F53\u524D\u9879\u76EE\u7684vitepress\u6E90\u76EE\u5F55\u4E0D\u5B58\u5728 ${PROMPTS_INDEX_MD_PATH} \u6587\u4EF6`);
+    consola6.log("\u5F53\u524D\u9879\u76EE\u7684vitepress\u6E90\u76EE\u5F55\u4E3A\uFF1A", sourceDir);
+    consola6.warn(`\u5F53\u524D\u9879\u76EE\u7684vitepress\u6E90\u76EE\u5F55\u4E0D\u5B58\u5728 ${PROMPTS_INDEX_MD_PATH} \u6587\u4EF6`);
   }
   return res;
 }
@@ -291,44 +303,44 @@ function writeYaml2PromptsIndexMd(userConfig, data) {
   try {
     let fileContent = "";
     let existingData = {};
-    if (fs4.existsSync(mdPath)) {
-      fileContent = fs4.readFileSync(mdPath, "utf-8");
-      const parsed = matter(fileContent);
+    if (fs5.existsSync(mdPath)) {
+      fileContent = fs5.readFileSync(mdPath, "utf-8");
+      const parsed = matter2(fileContent);
       if (parsed.data && Object.keys(parsed.data).length > 0) {
         existingData = parsed.data;
-        consola5.log("\u68C0\u6D4B\u5230\u5DF2\u6709 YAML frontmatter\uFF0C\u5C06\u8FDB\u884C\u6570\u636E\u5408\u5E76");
+        consola6.log("\u68C0\u6D4B\u5230\u5DF2\u6709 YAML frontmatter\uFF0C\u5C06\u8FDB\u884C\u6570\u636E\u5408\u5E76");
       } else {
-        consola5.log("\u6587\u4EF6\u5B58\u5728\u4F46\u6CA1\u6709 YAML frontmatter\uFF0C\u5C06\u5199\u5165\u65B0\u7684 frontmatter");
+        consola6.log("\u6587\u4EF6\u5B58\u5728\u4F46\u6CA1\u6709 YAML frontmatter\uFF0C\u5C06\u5199\u5165\u65B0\u7684 frontmatter");
       }
       const mergedData = merge({}, existingData, newData);
-      const newContent = matter.stringify(parsed.content, mergedData);
-      fs4.writeFileSync(mdPath, newContent, "utf-8");
-      consola5.success(`\u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath}`);
+      const newContent = matter2.stringify(parsed.content, mergedData);
+      fs5.writeFileSync(mdPath, newContent, "utf-8");
+      consola6.success(`\u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath}`);
     } else {
-      consola5.warn(`\u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728\uFF0C\u5C06\u521B\u5EFA\u65B0\u6587\u4EF6`);
+      consola6.warn(`\u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728\uFF0C\u5C06\u521B\u5EFA\u65B0\u6587\u4EF6`);
       const dir = path5.dirname(mdPath);
-      if (!fs4.existsSync(dir)) {
-        fs4.mkdirSync(dir, { recursive: true });
+      if (!fs5.existsSync(dir)) {
+        fs5.mkdirSync(dir, { recursive: true });
       }
-      const newContent = matter.stringify("", newData);
-      fs4.writeFileSync(mdPath, newContent, "utf-8");
-      consola5.success(`\u5DF2\u521B\u5EFA\u6587\u4EF6\u5E76\u5199\u5165YAML\u6570\u636E\u5230 ${mdPath}`);
+      const newContent = matter2.stringify("", newData);
+      fs5.writeFileSync(mdPath, newContent, "utf-8");
+      consola6.success(`\u5DF2\u521B\u5EFA\u6587\u4EF6\u5E76\u5199\u5165YAML\u6570\u636E\u5230 ${mdPath}`);
     }
   } catch (error) {
-    consola5.error(`\u5199\u5165 YAML \u6570\u636E\u5230 ${mdPath} \u65F6\u53D1\u751F\u9519\u8BEF:`, error);
+    consola6.error(`\u5199\u5165 YAML \u6570\u636E\u5230 ${mdPath} \u65F6\u53D1\u751F\u9519\u8BEF:`, error);
     throw error;
   }
 }
 function handlePrompts(userConfig) {
   var _a;
   if (!hasPromptsIndexMd(userConfig)) {
-    consola5.warn(` \u672A\u627E\u5230\u63D0\u793A\u8BCD\u7D22\u5F15\u6587\u4EF6\uFF0C\u4E0D\u6DFB\u52A0\u63D0\u793A\u8BCD\u5BFC\u822A\u680F\u3002 `);
+    consola6.warn(` \u672A\u627E\u5230\u63D0\u793A\u8BCD\u7D22\u5F15\u6587\u4EF6\uFF0C\u4E0D\u6DFB\u52A0\u63D0\u793A\u8BCD\u5BFC\u822A\u680F\u3002 `);
     return;
   }
   writeYaml2PromptsIndexMd(userConfig);
   const nav = (_a = userConfig == null ? void 0 : userConfig.themeConfig) == null ? void 0 : _a.nav;
   if (isUndefined2(nav)) {
-    consola5.error(` \u5F53\u524D\u7684\u7528\u6237\u914D\u7F6E\u4E3A\uFF1A `, userConfig);
+    consola6.error(` \u5F53\u524D\u7684\u7528\u6237\u914D\u7F6E\u4E3A\uFF1A `, userConfig);
     throw new Error(` nav \u9ED8\u8BA4\u63D0\u4F9B\u7684\u5BFC\u822A\u680F\u914D\u7F6E\u4E3A\u7A7A\u3002\u4E0D\u7B26\u5408\u9ED8\u8BA4\u914D\u7F6E\uFF0C\u8BF7\u68C0\u67E5\u3002 `);
   }
   nav.push({ text: "\u63D0\u793A\u8BCD", link: `/${PROMPTS_INDEX_MD_PATH}` });
@@ -408,7 +420,7 @@ import { copyOrDownloadAsMarkdownButtons } from "vitepress-plugin-llms";
 import { MermaidPlugin } from "@leelaa/vitepress-plugin-extended";
 import { defineTeekConfig as defineTeekConfig2 } from "vitepress-theme-teek/config";
 var defaultSidebarOptions = {
-  // documentRootPath: "src",
+  // documentRootPath: "./src",
   // 侧边栏需要折叠
   collapsed: true,
   // 不需要配置折叠嵌套深度

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
@@ -19,7 +19,7 @@
     "vitepress-sidebar": "^1.33.0",
     "vitepress-theme-teek": "^1.4.6",
     "vue": "^3.5.21",
-    "@ruan-cat/utils": "^4.15.0"
+    "@ruan-cat/utils": "^4.16.0"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
@@ -87,13 +87,15 @@
   },
   "files": [
     "!**/.vercel/**",
-    "dist",
+    "!**/.vitepress/**",
     "src",
-    "!src/docs/**",
-    "!src/**/tests",
-    "!src/**/*.md",
-    "!src/.vitepress/cache",
-    "!src/.vitepress/dist"
+    "dist/**",
+    "tsconfig.json",
+    "README.md",
+    "!src/**/docs/**",
+    "!src/**/tests/**",
+    "!*.test.*",
+    "!src/**/*.md"
   ],
   "scripts": {
     "docs:dev": "vitepress dev src/docs --port 8080",

package/src/config/add-changelog-to-doc.ts

@@ -1,19 +1,22 @@
 import path from "node:path";
+import fs from "node:fs";
+import consola from "consola";
+import matter from "gray-matter";
 
 import { copyChangelogMd, hasChangelogMd } from "../utils/copy-changelog";
-import { writeYaml2md } from "@ruan-cat/utils/node-esm";
+import { pageOrderConfig } from "./page-order-config";
 
-export interface AddChangelog2docOptions<T = Record<string, any>> {
+export interface AddChangelog2docOptions<T extends Record<string, any> = Record<string, any>> {
 	/** 目标文件夹 */
 	target: string;
 
 	/** 被插入到md头部的数据 */
-	data: T;
+	data?: T;
 }
 
 /** 将变更日志添加到指定的文档目录内 并提供参数 */
-export function addChangelog2doc<T>(options: AddChangelog2docOptions<T>) {
-	const { data, target } = options;
+export function addChangelog2doc<T extends Record<string, any>>(options: AddChangelog2docOptions<T>) {
+	const { data = pageOrderConfig.changelog, target } = options;
 
 	if (!hasChangelogMd()) {
 		return;
@@ -22,8 +25,27 @@ export function addChangelog2doc<T>(options: AddChangelog2docOptions<T>) {
 	copyChangelogMd(target);
 
 	const mdPath = path.resolve(process.cwd(), target, "CHANGELOG.md");
-	writeYaml2md({
-		mdPath,
-		data,
-	});
+
+	try {
+		if (fs.existsSync(mdPath)) {
+			// 读取 markdown 文件
+			const fileContent = fs.readFileSync(mdPath, "utf-8");
+
+			// 使用 gray-matter 解析文件
+			const parsed = matter(fileContent);
+
+			// 使用 gray-matter 的 stringify 方法生成新的文件内容
+			// 直接使用提供的 data，覆盖原有的 frontmatter
+			const newContent = matter.stringify(parsed.content, data);
+
+			// 写入文件
+			fs.writeFileSync(mdPath, newContent, "utf-8");
+			consola.success(`已将YAML数据写入到 ${mdPath}`);
+		} else {
+			consola.warn(`文件 ${mdPath} 不存在，无法写入 YAML frontmatter`);
+		}
+	} catch (error) {
+		consola.error(`写入 YAML 数据到 ${mdPath} 时发生错误:`, error);
+		throw error;
+	}
 }

package/src/config.mts

@@ -29,7 +29,7 @@ type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 
 /** 默认侧边栏配置 */
 const defaultSidebarOptions: VitePressSidebarOptions = {
-	// documentRootPath: "src",
+	// documentRootPath: "./src",
 
 	// 侧边栏需要折叠
 	collapsed: true,