@ruan-cat/vitepress-preset-config 0.0.1 → 0.0.2

package/dist/config.d.mts

@@ -4,6 +4,7 @@ export { defineConfig } from 'vitepress';
 import { generateSidebar } from 'vitepress-sidebar';
 export { addChangelog2doc } from '@ruan-cat/utils/node-esm';
 
+type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 /**
  * 设置自动生成侧边栏的配置
  * @see https://vitepress-sidebar.cdget.com/zhHans/guide/options
@@ -11,6 +12,5 @@ export { addChangelog2doc } from '@ruan-cat/utils/node-esm';
 declare function setGenerateSidebar(options?: VitePressSidebarOptions): vitepress_sidebar_types.Sidebar;
 /** 设置vitepress主配置 */
 declare function setUserConfig(config?: UserConfig<DefaultTheme.Config>): UserConfig<DefaultTheme.Config>;
-type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
 
 export { setGenerateSidebar, setUserConfig };

package/dist/config.mjs

@@ -4,7 +4,8 @@ import { generateSidebar } from "vitepress-sidebar";
 import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-plugin-git-changelog/vite";
 import { vitepressDemoPlugin } from "vitepress-demo-plugin";
 import { merge, isUndefined, cloneDeep } from "lodash-es";
-import { addChangelog2doc } from "@ruan-cat/utils/node-esm";
+import consola from "consola";
+import { addChangelog2doc, hasChangelogMd } from "@ruan-cat/utils/node-esm";
 var defaultSidebarOptions = {
   // documentRootPath: "src",
   // 侧边栏需要折叠
@@ -103,8 +104,26 @@ var defaultUserConfig = {
     }
   }
 };
+function handleChangeLog(userConfig) {
+  var _a;
+  if (!hasChangelogMd()) {
+    consola.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)) {
+    consola.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: "\u53D8\u66F4\u65E5\u5FD7",
+    link: "/CHANGELOG.md"
+  });
+}
 function setUserConfig(config) {
-  return merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
+  const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
+  handleChangeLog(resUserConfig);
+  return resUserConfig;
 }
 export {
   addChangelog2doc,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
   "homepage": "https://utils.ruancat6312.top",
   "types": "./src/config.mts",
@@ -10,12 +10,13 @@
     "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.15.1",
     "@nolebase/vitepress-plugin-git-changelog": "^2.15.1",
     "@nolebase/vitepress-plugin-highlight-targeted-heading": "^2.15.1",
+    "consola": "^3.4.0",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
     "vitepress-demo-plugin": "^1.3.1",
     "vitepress-sidebar": "^1.31.1",
     "vue": "^3.5.13",
-    "@ruan-cat/utils": "^4.1.0"
+    "@ruan-cat/utils": "^4.1.1"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",

package/src/config.mts

@@ -7,10 +7,13 @@ import { GitChangelog, GitChangelogMarkdownSection } from "@nolebase/vitepress-p
 import { vitepressDemoPlugin } from "vitepress-demo-plugin";
 
 import { merge, isUndefined, cloneDeep } from "lodash-es";
+import consola from "consola";
 
-import { addChangelog2doc } from "@ruan-cat/utils/node-esm";
+import { addChangelog2doc, hasChangelogMd } from "@ruan-cat/utils/node-esm";
 export { addChangelog2doc };
 
+type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
+
 /** 默认侧边栏配置 */
 const defaultSidebarOptions: VitePressSidebarOptions = {
 	// documentRootPath: "src",
@@ -145,13 +148,40 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 	},
 };
 
+/**
+ * 设置导航栏的变更日志
+ * @description
+ * 在导航栏内添加一行 变更日志 的入口
+ *
+ * 直接修改外部传递进来的配置对象即可
+ * @private 内部使用即可
+ */
+function handleChangeLog(userConfig: UserConfig<DefaultTheme.Config>) {
+	if (!hasChangelogMd()) {
+		consola.warn(` 未找到变更日志文件，不添加变更日志导航栏。 `);
+		return;
+	}
+
+	const nav = userConfig?.themeConfig?.nav;
+
+	if (isUndefined(nav)) {
+		consola.error(` 当前的用户配置为： `, userConfig);
+		throw new Error(` nav 默认提供的导航栏配置为空。不符合默认配置，请检查。 `);
+	}
+
+	nav.push({
+		text: "变更日志",
+		link: "/CHANGELOG.md",
+	});
+}
+
 /** 设置vitepress主配置 */
 export function setUserConfig(config?: UserConfig<DefaultTheme.Config>) {
-	return merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
-}
+	/** 最终的用户数据 */
+	const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
 
-type VitePressSidebarOptions = Parameters<typeof generateSidebar>[0];
+	// 增加导航栏
+	handleChangeLog(resUserConfig);
 
-// TODO:
-/** 设置导航栏的变更日志 */
-function handleChangeLog() {}
+	return resUserConfig;
+}