local.js: Move watch paths out of local config file

Author: slusarz

.vitepress/config.js

@@ -103,6 +103,15 @@ export default defineConfig({
 		gitrev: {
 			align: 'right',
 			hash: gitCommitInfo().shortHash,
+		},
+
+		/* Dovecot VitePress paths. */
+		dovecot: {
+			watch_paths: [
+				'docs/**/*.md',
+				'docs/**/*.inc',
+				'data/**/*'
+			]
 		}
 	},
 

.vitepress/local.js.dist

@@ -13,15 +13,6 @@ export const data_paths = {
 	// doveadm: '../data/doveadm.js',
 }
 
-// A listing of files to watch to refresh data loaders in dev mode.
-// See: https://vitepress.dev/guide/data-loading#data-from-local-files
-// Paths are relative to project base.
-//
-// Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
-//
-// Default: [ 'docs/**/*.md', 'docs/**/*.inc', 'data/**/*' ]
-export const watch_paths = []
-
 // A listing of paths containing man files.
 // Paths are relative to project base.
 //

README.md

@@ -158,6 +158,20 @@ The data files live in the base `/data` directory. Each file attempts to be
 self-documenting, but they are all essentially large JSON objects. Developers
 should need to know basically no JavaScript to be able to edit the files.
 
+### Dovecot VitePress Configuration
+
+Additional configuration options required for VitePress static generation are
+defined using the `dovecot` object in the `themeConfig` VitePress
+configuration setting.
+
+#### watch_paths
+
+An array of file patterns to watch to refresh data loaders in dev mode.
+See: https://vitepress.dev/guide/data-loading#data-from-local-files
+Paths are relative to project base.
+
+Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
+
 ### Dovecot Markdown Extensions
 
 Markdown has been extended to allow various Dovecot-specific tasks to be

lib/data/doveadm.data.js

@@ -1,6 +1,6 @@
 import { doveadm_arg_types, doveadm_flag_types, getDoveadmCmdLine } from '../doveadm.js'
 import { getVitepressMd } from '../markdown.js'
-import { loadData, normalizeArrayData, watchFiles } from '../utility.js'
+import { addWatchPaths, loadData, normalizeArrayData } from '../utility.js'
 import slugify from '@sindresorhus/slugify'
 
 const doveadm_userargs = {
@@ -147,11 +147,10 @@ async function normalizeDoveadm(doveadm) {
 	}
 }
 
-export default {
-	watch: await watchFiles(),
+export default addWatchPaths({
 	async load() {
 		return await normalizeDoveadm(
 			structuredClone((await loadData('doveadm')).doveadm)
 		)
 	}
-}
+})

lib/data/event_categories.data.js

@@ -1,5 +1,5 @@
 import { getVitepressMd } from '../markdown.js'
-import { loadData, watchFiles } from '../utility.js'
+import { addWatchPaths, loadData } from '../utility.js'
 
 async function normalizeEventCategories(categories) {
 	const md = await getVitepressMd()
@@ -11,11 +11,10 @@ async function normalizeEventCategories(categories) {
 	return categories
 }
 
-export default {
-	watch: await watchFiles(),
+export default addWatchPaths({
 	async load() {
 		return await normalizeEventCategories(
 			structuredClone((await loadData('event_categories')).categories)
 		)
 	}
-}
+})

lib/data/event_reasons.data.js

@@ -1,5 +1,5 @@
 import { getVitepressMd } from '../markdown.js'
-import { loadData, watchFiles } from '../utility.js'
+import { addWatchPaths, loadData } from '../utility.js'
 
 async function normalizeEventReasons(reasons) {
 	const md = await getVitepressMd()
@@ -11,11 +11,10 @@ async function normalizeEventReasons(reasons) {
 	return reasons
 }
 
-export default {
-	watch: await watchFiles(),
+export default addWatchPaths({
 	async load() {
 		return await normalizeEventReasons(
 			structuredClone((await loadData('event_reasons')).reasons)
 		)
 	}
-}
+})

lib/data/events.data.js

@@ -1,4 +1,4 @@
-import { loadData, normalizeArrayData, watchFiles } from '../utility.js'
+import { addWatchPaths, loadData, normalizeArrayData } from '../utility.js'
 import { getVitepressMd } from '../markdown.js'
 
 /* Take the events list and normalize entries and process inheritance. */
@@ -124,8 +124,7 @@ async function normalizeEvents(events, global_inherits, inherits) {
 	return events
 }
 
-export default {
-	watch: await watchFiles(),
+export default addWatchPaths({
 	async load() {
 		const data = await loadData('events')
 		return await normalizeEvents(
@@ -134,4 +133,4 @@ export default {
 			structuredClone(data.inherits)
 		)
 	}
-}
+})

lib/data/lua.data.js

@@ -1,5 +1,5 @@
 import { getVitepressMd } from '../markdown.js'
-import { loadData, watchFiles } from '../utility.js'
+import { addWatchPaths, loadData } from '../utility.js'
 
 async function normalizeLuaConstants(lua) {
 	const md = await getVitepressMd()
@@ -62,8 +62,7 @@ async function normalizeLuaVariables(lua) {
 	return out
 }
 
-export default {
-	watch: await watchFiles(),
+export default addWatchPaths({
 	async load() {
 		const data = await(loadData('lua'))
 
@@ -73,4 +72,4 @@ export default {
 			variables: await normalizeLuaVariables(data.lua_variables)
 		}
 	}
-}
+})

lib/data/settings.data.js

@@ -1,4 +1,4 @@
-import { loadData, normalizeArrayData, watchFiles } from '../utility.js'
+import { addWatchPaths, loadData, normalizeArrayData } from '../utility.js'
 import { getVitepressMd } from '../markdown.js'
 
 async function normalizeSettings(settings) {
@@ -69,11 +69,10 @@ async function normalizeSettings(settings) {
 	return data
 }
 
-export default {
-	watch: await watchFiles(),
+export default addWatchPaths({
 	async load() {
 		return await normalizeSettings(
 			structuredClone((await loadData('settings')).settings)
 		)
 	}
-}
+})

lib/utility.js

@@ -66,26 +66,18 @@ export async function loadData(id) {
 	}
 }
 
-export async function watchFiles() {
-	/* Check for config override file. */
-	const lconf = await loadLocalConf()
-
-	return lconf?.watch_paths ??
-		[ 'docs/**/*.md', 'docs/**/*.inc', 'data/**/*' ]
-}
+export function dovecotSetting(name) {
+	const setting = globalThis.VITEPRESS_CONFIG.userConfig.themeConfig.dovecot?.[name]
 
-export async function manFiles() {
-	/* Check for config override file. */
-	const lconf = await loadLocalConf()
+	if (setting === undefined) {
+		throw new Error("Missing '" + name + "' setting")
+	}
 
-	return lconf?.man_paths ??
-		[ 'docs/core/man/*.[[:digit:]].md' ]
+	return setting
 }
 
-export async function manIncludes() {
-	const lconf = await loadLocalConf()
-	return lconf?.man_includes ??
-		[ 'docs/core/man/include/*.inc' ]
+export function addWatchPaths(obj) {
+	return { ...obj, ...{ watch: dovecotSetting('watch_paths') } }
 }
 
 export async function pluginFiles() {