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

Author: slusarz

.vitepress/config.js

@@ -113,6 +113,9 @@ export default defineConfig({
 			man_paths: [
 				'docs/core/man/*.[[:digit:]].md'
 			],
+			plugin_paths: [
+				'docs/core/plugins/*.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 plugin files.
-// Paths are relative to project base.
-//
-// Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
-//
-// Default: [ 'docs/core/plugins/*.md' ]
-export const plugin_paths = []
-
 // Enable additional labels to support in Dovecot-specific markdown
 // processing (i.e. [[xyz,...]]).
 export const markdown_extend = {

README.md

@@ -176,6 +176,13 @@ Paths are relative to project base.
 
 Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
 
+#### plugin_paths
+
+A listing of paths containing plugin 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 { dovecotSetting, frontmatterIter, loadData, markdownExtension, pluginFiles, resolveURL } from './utility.js'
+import { dovecotSetting, frontmatterIter, loadData, markdownExtension, resolveURL } from './utility.js'
 
 let md_conf = null
 export async function initDovecotMd(base) {
@@ -17,9 +17,6 @@ export async function initDovecotMd(base) {
 			doveadm: (await loadData('doveadm')).doveadm,
 			events: (await loadData('events')).events,
 			linkoverrides: (await loadData('links_overrides')).links_overrides,
-			plugins: (await pluginFiles()).flatMap((x) =>
-				fg.sync(x).map((y) => path.basename(y, '.md'))
-			),
 			settings: (await loadData('settings')).settings,
 			updates: (await loadData('updates')).updates
 		},
@@ -229,6 +226,8 @@ function dovecot_markdown(md, opts) {
 			env.args = parts[2] ? parts[2] : undefined
 			const plugin = env.inner.replaceAll('-', '_')
 
+			initPluginFiles()
+
 			if (!opts.plugins.includes(plugin)) {
 				handle_error('plugin link missing: ' + env.inner)
 				return '<a>'
@@ -433,6 +432,14 @@ function dovecot_markdown(md, opts) {
 		}
 	}
 
+	function initPluginFiles() {
+		if (!opts.plugins) {
+			opts.plugins = dovecotSetting('plugin_paths').flatMap((x) =>
+				fg.sync(x).map((y) => path.basename(y, '.md'))
+			)
+		}
+	}
+
 	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

@@ -80,14 +80,6 @@ export function addWatchPaths(obj) {
 	return { ...obj, ...{ watch: dovecotSetting('watch_paths') } }
 }
 
-export async function pluginFiles() {
-	/* Check for config override file. */
-	const lconf = await loadLocalConf()
-
-	return lconf?.plugin_paths ??
-		[ 'docs/core/plugins/*.md' ]
-}
-
 export function getExcludes(srcDirs = [ 'docs' ]) {
 	const excludes = []