@ruan-cat/vitepress-preset-config 2.6.0 → 2.7.0

package/dist/config.mjs

@@ -2,7 +2,19 @@
 import { defineConfig } from "vitepress";
 import { generateSidebar } from "vitepress-sidebar";
 import { vitepressDemoPlugin } from "vitepress-demo-plugin";
-import { merge as merge2, isUndefined as isUndefined2, cloneDeep as cloneDeep2 } from "lodash-es";
+import { merge as merge3, isUndefined as isUndefined3, cloneDeep as cloneDeep2 } from "lodash-es";
+
+// src/config/page-order-config.ts
+var pageOrderConfig = {
+  /** 提示词页面排序 */
+  prompts: {
+    order: 8e3
+  },
+  /** 变更日志页面排序 */
+  changelog: {
+    order: 9e3
+  }
+};
 
 // src/config/copy-readme.ts
 import fs from "fs";
@@ -195,9 +207,136 @@ function handleChangeLog(userConfig) {
   nav.push({ text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" });
 }
 
+// src/config/prompts-nav.ts
+import fs4 from "fs";
+import path5 from "path";
+import consola5 from "consola";
+import { isUndefined as isUndefined2, merge } from "lodash-es";
+import matter from "gray-matter";
+var PROMPTS_INDEX_MD_PATH = "prompts/index.md";
+function getProjectRootFromArgs() {
+  const args = process.argv;
+  const vitepressIndex = args.findIndex((arg) => arg.includes("vitepress"));
+  if (vitepressIndex === -1) {
+    return null;
+  }
+  for (let i = vitepressIndex + 1; i < args.length; i++) {
+    const arg = args[i];
+    if (arg === "dev" || arg === "build" || arg === "serve" || arg === "preview") {
+      continue;
+    }
+    if (arg.startsWith("-")) {
+      if (arg.startsWith("--") && !arg.includes("=")) {
+        i++;
+      }
+      continue;
+    }
+    return path5.resolve(process.cwd(), arg);
+  }
+  return null;
+}
+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);
+      return projectRootFromArgs;
+    }
+  }
+  let currentDir = process.cwd();
+  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);
+      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);
+    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);
+  return fallbackDir;
+}
+function getVitepressSourceDirectory(userConfig) {
+  const projectRoot = getVitepressProjectRoot();
+  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);
+    return sourceDirectory;
+  }
+  consola5.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));
+  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`);
+  }
+  return res;
+}
+function writeYaml2PromptsIndexMd(userConfig, data) {
+  const newData = data ?? pageOrderConfig.prompts;
+  const sourceDir = getVitepressSourceDirectory(userConfig);
+  const mdPath = path5.resolve(sourceDir, PROMPTS_INDEX_MD_PATH);
+  try {
+    let fileContent = "";
+    let existingData = {};
+    if (fs4.existsSync(mdPath)) {
+      fileContent = fs4.readFileSync(mdPath, "utf-8");
+      const parsed = matter(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");
+      } else {
+        consola5.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}`);
+    } else {
+      consola5.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 });
+      }
+      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}`);
+    }
+  } catch (error) {
+    consola5.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 `);
+    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);
+    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}` });
+}
+
 // src/config/teek.ts
 import { defineTeekConfig } from "vitepress-theme-teek/config";
-import { merge, cloneDeep } from "lodash-es";
+import { merge as merge2, cloneDeep } from "lodash-es";
 var defaultTeekConfig = {
   /**
    * 启用侧边栏展开/折叠触发器
@@ -260,7 +399,7 @@ var defaultTeekConfig = {
 };
 function handleTeekConfig(userConfig, extraConfig) {
   const { teekConfig = defaultTeekConfig } = extraConfig ?? {};
-  userConfig.extends = defineTeekConfig(merge({}, cloneDeep(defaultTeekConfig), teekConfig));
+  userConfig.extends = defineTeekConfig(merge2({}, cloneDeep(defaultTeekConfig), teekConfig));
 }
 
 // src/config.mts
@@ -294,7 +433,7 @@ var defaultSidebarOptions = {
   debugPrint: false
 };
 function getMergeSidebarOptions(options) {
-  return merge2({}, cloneDeep2(defaultSidebarOptions), isUndefined2(options) ? {} : options);
+  return merge3({}, cloneDeep2(defaultSidebarOptions), isUndefined3(options) ? {} : options);
 }
 function setGenerateSidebar(options) {
   return generateSidebar(getMergeSidebarOptions(options));
@@ -372,7 +511,8 @@ var defaultUserConfig = {
   }
 };
 function setUserConfig(config, extraConfig) {
-  const resUserConfig = merge2({}, cloneDeep2(defaultUserConfig), isUndefined2(config) ? {} : config);
+  const resUserConfig = merge3({}, cloneDeep2(defaultUserConfig), isUndefined3(config) ? {} : config);
+  handlePrompts(resUserConfig);
   handleChangeLog(resUserConfig);
   handlePlugins(resUserConfig, extraConfig);
   handleTeekConfig(resUserConfig, extraConfig);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
@@ -10,6 +10,7 @@
     "@nolebase/vitepress-plugin-git-changelog": "^2.18.2",
     "@shikijs/vitepress-twoslash": "^3.13.0",
     "consola": "^3.4.2",
+    "gray-matter": "^4.0.3",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
     "markdown-it-async": "^2.2.0",

package/src/config/index.ts

@@ -6,4 +6,5 @@ export * from "./copy-claude-agents";
 export * from "./add-changelog-to-doc";
 export * from "./plugins";
 export * from "./changelog-nav";
+export * from "./prompts-nav";
 export * from "./teek";

package/src/config/prompts-nav.ts

@@ -0,0 +1,241 @@
+import { type UserConfig, type DefaultTheme } from "vitepress";
+import fs from "node:fs";
+import path from "node:path";
+import consola from "consola";
+import { isUndefined, merge } from "lodash-es";
+import matter from "gray-matter";
+
+import { pageOrderConfig } from "./page-order-config";
+
+/** 提示词索引文件的相对路径 */
+const PROMPTS_INDEX_MD_PATH = "prompts/index.md" as const;
+
+/**
+ * 从命令行参数中获取 VitePress 项目根目录
+ * @description
+ * 解析命令行参数，查找 vitepress dev/build 命令后的第一个路径参数
+ * @private 目前仅设计为内部使用
+ */
+function getProjectRootFromArgs(): string | null {
+	const args = process.argv;
+
+	// 查找 vitepress 命令的索引
+	const vitepressIndex = args.findIndex((arg) => arg.includes("vitepress"));
+
+	if (vitepressIndex === -1) {
+		return null;
+	}
+
+	// 查找 dev 或 build 命令后的第一个非选项参数（不以 - 或 -- 开头）
+	for (let i = vitepressIndex + 1; i < args.length; i++) {
+		const arg = args[i];
+
+		// 跳过命令本身（dev, build等）和选项参数
+		if (arg === "dev" || arg === "build" || arg === "serve" || arg === "preview") {
+			continue;
+		}
+
+		// 跳过选项和选项值
+		if (arg.startsWith("-")) {
+			// 如果是 --port 这样的选项，也跳过下一个值
+			if (arg.startsWith("--") && !arg.includes("=")) {
+				i++; // 跳过选项值
+			}
+			continue;
+		}
+
+		// 找到路径参数，解析为绝对路径
+		return path.resolve(process.cwd(), arg);
+	}
+
+	return null;
+}
+
+/**
+ * 获得 vitepress 项目的 `项目根目录 (project root)`
+ * @description
+ * 检查出当前运行vitepress build 命令时，所使用的项目根目录，并对外返回该目录。
+ * @see https://vitepress.dev/zh/guide/routing#root-and-source-directory
+ * @private 目前仅设计为内部使用
+ */
+function getVitepressProjectRoot(): string {
+	// 首先尝试从命令行参数获取
+	const projectRootFromArgs = getProjectRootFromArgs();
+	if (projectRootFromArgs) {
+		const vitepressDir = path.join(projectRootFromArgs, ".vitepress");
+		if (fs.existsSync(vitepressDir)) {
+			consola.log("从命令行参数获取到 VitePress 项目根目录：", projectRootFromArgs);
+			return projectRootFromArgs;
+		}
+	}
+
+	// 如果命令行参数没有提供或无效，尝试向上查找 .vitepress 目录
+	let currentDir = process.cwd();
+	const root = path.parse(currentDir).root;
+
+	while (currentDir !== root) {
+		const vitepressDir = path.join(currentDir, ".vitepress");
+		if (fs.existsSync(vitepressDir)) {
+			consola.log("通过向上查找获取到 VitePress 项目根目录：", currentDir);
+			return currentDir;
+		}
+		currentDir = path.dirname(currentDir);
+	}
+
+	// 检查根目录本身
+	const vitepressDir = path.join(root, ".vitepress");
+	if (fs.existsSync(vitepressDir)) {
+		consola.log("在文件系统根目录找到 VitePress 项目根目录：", root);
+		return root;
+	}
+
+	// 如果找不到 .vitepress 目录，回退到当前工作目录
+	const fallbackDir = process.cwd();
+	consola.warn("未找到 .vitepress 目录，回退到当前工作目录：", fallbackDir);
+	return fallbackDir;
+}
+
+/**
+ * 获取vitepress项目的源目录
+ * @description
+ * 获取vitepress项目的源目录 并对外返回该目录。
+ *
+ * 源目录的计算规则：
+ * 1. 如果配置中指定了 srcDir，则源目录 = 项目根目录 + srcDir
+ * 2. 如果没有指定 srcDir，则源目录 = 项目根目录
+ *
+ * @param userConfig - VitePress 用户配置对象
+ * @see https://vitepress.dev/zh/guide/routing#source-directory
+ * @private 目前仅设计为内部使用
+ */
+function getVitepressSourceDirectory(userConfig: UserConfig<DefaultTheme.Config>): string {
+	// 获取项目根目录
+	const projectRoot = getVitepressProjectRoot();
+
+	// 读取配置中的 srcDir（如果有）
+	const srcDir = (userConfig as any).srcDir as string | undefined;
+
+	// 如果配置了 srcDir，将其与项目根目录拼接；否则返回项目根目录
+	if (srcDir) {
+		const sourceDirectory = path.resolve(projectRoot, srcDir);
+		consola.log("从配置中获取到 srcDir:", srcDir);
+		consola.log("VitePress 源目录为：", sourceDirectory);
+		return sourceDirectory;
+	}
+
+	// 默认情况下，源目录等于项目根目录
+	consola.log("配置中未指定 srcDir，源目录等于项目根目录：", projectRoot);
+	return projectRoot;
+}
+
+/**
+ * 检查当前运行的 `源目录` 是否存在 `prompts/index.md` 文件
+ * @description
+ * 检查当前运行的 `源目录` 是否存在 `prompts/index.md` 文件，并对外返回检查结果。
+ * @private 目前仅设计为内部使用·
+ */
+function hasPromptsIndexMd(userConfig: UserConfig<DefaultTheme.Config>) {
+	const sourceDir = getVitepressSourceDirectory(userConfig);
+	const res = fs.existsSync(path.resolve(sourceDir, PROMPTS_INDEX_MD_PATH));
+	if (!res) {
+		consola.log("当前项目的vitepress源目录为：", sourceDir);
+		consola.warn(`当前项目的vitepress源目录不存在 ${PROMPTS_INDEX_MD_PATH} 文件`);
+	}
+	return res;
+}
+
+/**
+ * 将YAML数据写入到提示词索引文件内
+ * @description
+ * - 读取 markdown 文件
+ * - 检查是否已经包含了预先准备好的 yaml 信息
+ * - 如果有 yaml 信息，就用提供的数据做数据拓展（使用 lodash merge）
+ * - 如果没有 yaml 信息，就写入顶部 yaml 信息
+ *
+ * @param userConfig - VitePress 用户配置对象
+ * @param data - 要写入或合并的 YAML 数据
+ * @private 目前仅设计为内部使用
+ */
+function writeYaml2PromptsIndexMd(userConfig: UserConfig<DefaultTheme.Config>, data?: Record<string, any>) {
+	// 获取要写入的数据
+	const newData = data ?? pageOrderConfig.prompts;
+
+	// 获取文件路径
+	const sourceDir = getVitepressSourceDirectory(userConfig);
+	const mdPath = path.resolve(sourceDir, PROMPTS_INDEX_MD_PATH);
+
+	try {
+		// 读取 markdown 文件
+		let fileContent = "";
+		let existingData: Record<string, any> = {};
+
+		if (fs.existsSync(mdPath)) {
+			fileContent = fs.readFileSync(mdPath, "utf-8");
+
+			// 使用 gray-matter 解析文件
+			const parsed = matter(fileContent);
+
+			// 如果有 frontmatter，获取已有数据
+			if (parsed.data && Object.keys(parsed.data).length > 0) {
+				existingData = parsed.data;
+				consola.log("检测到已有 YAML frontmatter，将进行数据合并");
+			} else {
+				consola.log("文件存在但没有 YAML frontmatter，将写入新的 frontmatter");
+			}
+
+			// 使用 lodash merge 合并数据
+			// merge 会深度合并对象，新数据会覆盖旧数据
+			const mergedData = merge({}, existingData, newData);
+
+			// 使用 gray-matter 的 stringify 方法生成新的文件内容
+			const newContent = matter.stringify(parsed.content, mergedData);
+
+			// 写入文件
+			fs.writeFileSync(mdPath, newContent, "utf-8");
+			consola.success(`已将YAML数据写入到 ${mdPath}`);
+		} else {
+			// 文件不存在，创建新文件
+			consola.warn(`文件 ${mdPath} 不存在，将创建新文件`);
+
+			// 确保目录存在
+			const dir = path.dirname(mdPath);
+			if (!fs.existsSync(dir)) {
+				fs.mkdirSync(dir, { recursive: true });
+			}
+
+			// 创建带有 frontmatter 的空文件
+			const newContent = matter.stringify("", newData);
+			fs.writeFileSync(mdPath, newContent, "utf-8");
+			consola.success(`已创建文件并写入YAML数据到 ${mdPath}`);
+		}
+	} catch (error) {
+		consola.error(`写入 YAML 数据到 ${mdPath} 时发生错误:`, error);
+		throw error;
+	}
+}
+
+/**
+ * 处理提示词文件
+ * @description
+ * - 检查当前文档的运行目录内 是否包含有约定格式的提示词文档。
+ * - 如果存在 就给目标文件增加一个顶部yaml信息，做排序使用。
+ * - 并且文档的顶部导航栏内，增加一个固定的提示词入口。
+ */
+export function handlePrompts(userConfig: UserConfig<DefaultTheme.Config>) {
+	if (!hasPromptsIndexMd(userConfig)) {
+		consola.warn(` 未找到提示词索引文件，不添加提示词导航栏。 `);
+		return;
+	}
+
+	// 给提示词索引文件 写入排序值
+	writeYaml2PromptsIndexMd(userConfig);
+
+	const nav = userConfig?.themeConfig?.nav;
+
+	if (isUndefined(nav)) {
+		consola.error(` 当前的用户配置为： `, userConfig);
+		throw new Error(` nav 默认提供的导航栏配置为空。不符合默认配置，请检查。 `);
+	}
+
+	nav.push({ text: "提示词", link: `/${PROMPTS_INDEX_MD_PATH}` });
+}

package/src/config.mts

@@ -17,7 +17,7 @@ import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 
 import llmstxt, { copyOrDownloadAsMarkdownButtons } from "vitepress-plugin-llms";
 
-import { defaultTeekConfig, handleTeekConfig, handlePlugins, handleChangeLog } from "./config/index.ts";
+import { defaultTeekConfig, handleTeekConfig, handlePlugins, handleChangeLog, handlePrompts } from "./config/index.ts";
 
 /** @see https://vitepress-ext.leelaa.cn/Mermaid.html#扩展-md-插件 */
 import { MermaidPlugin } from "@leelaa/vitepress-plugin-extended";
@@ -183,7 +183,10 @@ export function setUserConfig(
 	/** 最终的用户数据 */
 	const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
 
-	// 增加导航栏
+	// 处理提示词导航栏
+	handlePrompts(resUserConfig);
+
+	// 处理变更日志导航栏
 	handleChangeLog(resUserConfig);
 
 	// 设置插件