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

Author: slusarz

.vitepress/config.js

@@ -107,6 +107,12 @@ export default defineConfig({
 
 		/* Dovecot VitePress paths. */
 		dovecot: {
+			man_includes: [
+				'docs/core/man/include/*.inc'
+			],
+			man_paths: [
+				'docs/core/man/*.[[:digit:]].md'
+			],
 			watch_paths: [
 				'docs/**/*.md',
 				'docs/**/*.inc',

.vitepress/local.js.dist

@@ -13,14 +13,6 @@ export const data_paths = {
 	// doveadm: '../data/doveadm.js',
 }
 
-// A listing of paths containing man files.
-// Paths are relative to project base.
-//
-// Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
-//
-// Default: [ 'docs/core/man/*.[[:digit:]].md' ]
-export const man_paths = []
-
 // A listing of paths containing plugin files.
 // Paths are relative to project base.
 //

README.md

@@ -164,6 +164,18 @@ Additional configuration options required for VitePress static generation are
 defined using the `dovecot` object in the `themeConfig` VitePress
 configuration setting.
 
+#### man_includes
+
+A list of additional paths (other than the `include/` directory of the man
+folder) where include files can live.
+
+#### man_paths
+
+A listing of paths containing man files.
+Paths are relative to project base.
+
+Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
+
 #### watch_paths
 
 An array of file patterns to watch to refresh data loaders in dev mode.

lib/markdown.js

@@ -3,7 +3,7 @@ import fg from 'fast-glob'
 import deflistPlugin from 'markdown-it-deflist'
 import path from 'path'
 import { createMarkdownRenderer } from 'vitepress'
-import { frontmatterIter, loadData, manFiles, markdownExtension, pluginFiles, resolveURL } from './utility.js'
+import { dovecotSetting, frontmatterIter, loadData, markdownExtension, pluginFiles, resolveURL } from './utility.js'
 
 let md_conf = null
 export async function initDovecotMd(base) {
@@ -17,12 +17,6 @@ export async function initDovecotMd(base) {
 			doveadm: (await loadData('doveadm')).doveadm,
 			events: (await loadData('events')).events,
 			linkoverrides: (await loadData('links_overrides')).links_overrides,
-			man: (await manFiles()).flatMap((x) => {
-				return fg.sync(x).map((y) => {
-					const str = path.basename(y)
-					return str.substring(0, str.indexOf('.'))
-				})
-			}),
 			plugins: (await pluginFiles()).flatMap((x) =>
 				fg.sync(x).map((y) => path.basename(y, '.md'))
 			),
@@ -219,6 +213,8 @@ function dovecot_markdown(md, opts) {
 			hash = parts[2] ? parts[2] : false;
 			env.args = parts[3] ? parts[3] : 1;
 
+			initManFiles()
+
 			if (!opts.man.includes(env.inner)) {
 				handle_error('man link missing: ' + env.inner)
 				return '<a><code>'
@@ -426,6 +422,17 @@ function dovecot_markdown(md, opts) {
 		opts.dovecotlinks = { ...links, ...opts.linkoverrides }
 	}
 
+	function initManFiles() {
+		if (!opts.man) {
+			opts.man = dovecotSetting('man_paths').flatMap((x) => {
+				return fg.sync(x).map((y) => {
+					const str = path.basename(y)
+					return str.substring(0, str.indexOf('.'))
+				})
+			})
+		}
+	}
+
 	md.inline.ruler.after('emphasis', 'dovecot_brackets', process_brackets)
 	md.renderer.rules.dovecot_open = dovecot_open
 	md.renderer.rules.dovecot_body = dovecot_body

lib/utility.js

@@ -66,28 +66,18 @@ export async function loadData(id) {
 	}
 }
 
-export function addWatchPaths(obj) {
-	const paths = globalThis.VITEPRESS_CONFIG.userConfig.themeConfig.dovecot?.watch_paths
+export function dovecotSetting(name) {
+	const setting = globalThis.VITEPRESS_CONFIG.userConfig.themeConfig.dovecot?.[name]
 
-	if (!paths) {
-		throw new Error("Missing 'watch_paths' setting")
+	if (!setting) {
+		throw new Error("Missing '" + name + "' setting")
 	}
 
-	return { ...obj, ...{ watch: paths } }
-}
-
-export async function manFiles() {
-	/* Check for config override file. */
-	const lconf = await loadLocalConf()
-
-	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() {

util/generate_man.js

@@ -14,7 +14,7 @@ import matter from 'gray-matter'
 import pdc from 'pdc'
 import path from 'path'
 import { VFile } from 'vfile'
-import { manFiles, manIncludes } from '../lib/utility.js'
+import { dovecotSetting } from '../lib/utility.js'
 import remarkDeflist from 'remark-definition-list'
 import remarkMan from 'remark-man'
 import remarkParse from 'remark-parse'
@@ -126,8 +126,8 @@ const main = async (component, outPath) => {
 	}
 
 	/* Generate list of man files. */
-	const files = (await manFiles()).flatMap((x) => fg.sync(x))
-	const includes = (await manIncludes()).flatMap((x) => fg.sync(x))
+	const files = dovecotSetting('man_paths').flatMap((x) => fg.sync(x))
+	const includes = dovecotSetting('man_includes').flatMap((x) => fg.sync(x))
 
 	/* Get hash of last git commit. */
 	const gitHash = gitCommitInfo().shortHash