Add optional note feature to plugin docs generator

webpro-nl · Aug 31, 2024 · 9a11e1c · 9a11e1c
1 parent 70bf705
commit 9a11e1c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/packages/docs/scripts/generate-plugin-docs.ts b/packages/docs/scripts/generate-plugin-docs.ts
@@ -47,7 +47,7 @@ for await (const dir of directories) {
     const pluginDir = path.join(pluginsDir, pluginName);
     const plugin: Plugin = (await import(path.join(pluginDir, 'index.ts'))).default;
 
-    const { title, enablers, config, entry, production, project } = plugin;
+    const { title, enablers, note, config, entry, production, project } = plugin;
 
     plugins.push([title, pluginName]);
 
@@ -76,10 +76,13 @@ for await (const dir of directories) {
           ? parseFragment(enablers)
           : [u('paragraph', [u('text', 'N/A')])];
 
+    const n = note ? [u('heading', { depth: 2 }, [u('text', 'Note')]), ...parseFragment(note)] : [];
+
     const tree = u('root', [
       frontmatter,
       u('heading', { depth: 2 }, [u('text', 'Enabled')]),
       ...en,
+      ...n,
       u('heading', { depth: 2 }, [u('text', 'Default configuration')]),
       ...parseFragment('This configuration is added automatically if the plugin is enabled:'),
       u('code', {

diff --git a/packages/knip/src/types/plugins.ts b/packages/knip/src/types/plugins.ts
@@ -38,6 +38,7 @@ export type Resolve = (options: PluginOptions) => Promise<string[]> | string[];
 export interface Plugin {
   title: string;
   enablers: IgnorePatterns | string;
+  note?: string;
   packageJsonPath?: string | ((manifest: PackageJson) => string);
   isEnabled: IsPluginEnabled;
   config?: string[];