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

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",
   // 侧边栏需要折叠
@@ -36,8 +37,8 @@ function setGenerateSidebar(options) {
   return generateSidebar(getMergeSidebarOptions(options));
 }
 var defaultUserConfig = {
-  title: "10wms\u524D\u7AEF\u7EC4\u6280\u672F\u6587\u6863",
-  description: "\u672C\u524D\u7AEF\u9879\u76EE\u5185\u7684\u7EC4\u4EF6\u4F7F\u7528\u3001api\u3001\u7C7B\u578B\u4EE5\u53CA\u4F7F\u7528\u6587\u6863",
+  title: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u6807\u9898",
+  description: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u63CF\u8FF0",
   lang: "zh",
   // 暂不需要
   // srcDir: "./src",
@@ -47,12 +48,7 @@ var defaultUserConfig = {
       provider: "local"
     },
     // https://vitepress.dev/reference/default-theme-config
-    nav: [
-      { text: "\u9996\u9875", link: "/" },
-      { text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" }
-      // TODO: 未来项目结束时，在此补充配置
-      // { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
-    ],
+    nav: [{ text: "\u9996\u9875", link: "/" }],
     outline: {
       label: "\u672C\u9875\u76EE\u5F55",
       level: "deep"
@@ -62,7 +58,7 @@ var defaultUserConfig = {
     socialLinks: [
       {
         icon: "github",
-        link: "https://github.com/ruan-cat/vercel-monorepo-test/blob/dev/packages/docs-01-star/docs/index.md"
+        link: "https://github.com/ruan-cat"
       }
     ]
   },
@@ -103,8 +99,23 @@ 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: "\u66F4\u65B0\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,8 +1,8 @@
 {
   "name": "@ruan-cat/vitepress-preset-config",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
-  "homepage": "https://utils.ruancat6312.top",
+  "homepage": "https://vitepress-preset.ruancat6312.top",
   "types": "./src/config.mts",
   "main": "./src/config.mts",
   "dependencies": {
@@ -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/.vitepress/config.mts

@@ -2,6 +2,7 @@
 // import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "@ruan-cat/vitepress-preset-config/config";
 // @ts-ignore
 import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "../../src/config.mts";
+import { description } from "../../package.json";
 
 addChangelog2doc({
 	target: "./src",
@@ -13,7 +14,18 @@ addChangelog2doc({
 /**
  * 本文档的渲染配置
  */
-const thisDocUserConfig = setUserConfig();
+const thisDocUserConfig = setUserConfig({
+	title: "vitepress预设配置",
+	description,
+	themeConfig: {
+		socialLinks: [
+			{
+				icon: "github",
+				link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/main/packages/vitepress-preset-config",
+			},
+		],
+	},
+});
 // @ts-ignore
 thisDocUserConfig.themeConfig.sidebar = setGenerateSidebar({
 	documentRootPath: "./src",

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",
@@ -63,8 +66,8 @@ export function setGenerateSidebar(options?: VitePressSidebarOptions) {
 
 /** 默认用户配置 */
 const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
-	title: "10wms前端组技术文档",
-	description: "本前端项目内的组件使用、api、类型以及使用文档",
+	title: "请填写有意义的标题",
+	description: "请填写有意义的描述",
 
 	lang: "zh",
 	// 暂不需要
@@ -78,12 +81,7 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 		},
 
 		// https://vitepress.dev/reference/default-theme-config
-		nav: [
-			{ text: "首页", link: "/" },
-			{ text: "更新日志", link: "/CHANGELOG.md" },
-			// TODO: 未来项目结束时，在此补充配置
-			// { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
-		],
+		nav: [{ text: "首页", link: "/" }],
 
 		outline: {
 			label: "本页目录",
@@ -96,7 +94,7 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
 		socialLinks: [
 			{
 				icon: "github",
-				link: "https://github.com/ruan-cat/vercel-monorepo-test/blob/dev/packages/docs-01-star/docs/index.md",
+				link: "https://github.com/ruan-cat",
 			},
 		],
 	},
@@ -145,13 +143,37 @@ 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;
+}