docusaurus-plugin-typedoc 1.0.0-next.13 → 1.0.0-next.15

package/dist/frontmatter.d.ts

@@ -0,0 +1,3 @@
+import { Application } from 'typedoc';
+import { SidebarOptions } from './models';
+export declare function loadFrontmatter(app: Application, sidebar: SidebarOptions): void;

package/dist/frontmatter.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadFrontmatter = void 0;
+const typedoc_plugin_frontmatter_1 = require("typedoc-plugin-frontmatter");
+function loadFrontmatter(app, sidebar) {
+    app.renderer.on(typedoc_plugin_frontmatter_1.FrontmatterEvent.PREPARE_FRONTMATTER, (event) => {
+        var _a, _b, _c, _d, _e, _f;
+        const hasReadme = !app.options.getValue('readme').endsWith('none');
+        const entryPage = app.options.getValue('entryFileName');
+        const indexPage = app.options.getValue('indexFileName');
+        const model = (_a = event.page) === null || _a === void 0 ? void 0 : _a.model;
+        const sidebarLabel = model === null || model === void 0 ? void 0 : model.name;
+        let pluginFrontmatter = {};
+        if (sidebar.autoConfiguration) {
+            if (((_b = event.page) === null || _b === void 0 ? void 0 : _b.url) === app.options.getValue('entryFileName')) {
+                if (sidebar.categoryLabel) {
+                    pluginFrontmatter = {
+                        ...pluginFrontmatter,
+                        sidebar_label: sidebar.categoryLabel,
+                    };
+                }
+            }
+            if (hasReadme) {
+                if (((_c = event.page) === null || _c === void 0 ? void 0 : _c.url) === entryPage) {
+                    pluginFrontmatter = {
+                        ...pluginFrontmatter,
+                        ...(sidebar.readmeLabel && {
+                            sidebar_label: sidebar.readmeLabel,
+                        }),
+                        sidebar_position: 0,
+                    };
+                }
+                if (((_d = event.page) === null || _d === void 0 ? void 0 : _d.url) === `01-${indexPage}`) {
+                    pluginFrontmatter = {
+                        ...pluginFrontmatter,
+                        ...(sidebar.indexLabel && { sidebar_label: sidebar.indexLabel }),
+                    };
+                }
+            }
+            // Add sidebar labels to all pages
+            if (!(((_e = event.page) === null || _e === void 0 ? void 0 : _e.url) === entryPage) &&
+                !(((_f = event.page) === null || _f === void 0 ? void 0 : _f.url) === `01-${indexPage}`)) {
+                pluginFrontmatter = {
+                    ...pluginFrontmatter,
+                    sidebar_label: sidebarLabel,
+                };
+            }
+        }
+        event.frontmatter = {
+            ...pluginFrontmatter,
+            ...event.frontmatter,
+        };
+    });
+}
+exports.loadFrontmatter = loadFrontmatter;

package/dist/options.d.ts

@@ -1,3 +1,3 @@
 import { Application } from 'typedoc';
 export declare function getPluginOptions(opts: Record<string, any>): Record<string, any>;
-export declare function loadOptions(app: Application): void;
+export declare function setOptions(app: Application, options: any): void;

package/dist/options.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadOptions = exports.getPluginOptions = void 0;
-const typedoc_1 = require("typedoc");
+exports.setOptions = exports.getPluginOptions = void 0;
 const DEFAULT_PLUGIN_OPTIONS = {
     id: 'default',
     docsRoot: 'docs',
@@ -15,6 +14,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
     sidebar: {
         autoConfiguration: true,
     },
+    plugin: ['typedoc-plugin-markdown', 'typedoc-plugin-frontmatter'],
 };
 function getPluginOptions(opts) {
     const options = {
@@ -24,31 +24,16 @@ function getPluginOptions(opts) {
             ...DEFAULT_PLUGIN_OPTIONS.sidebar,
             ...opts.sidebar,
         },
+        plugin: [
+            ...new Set([...DEFAULT_PLUGIN_OPTIONS.plugin, ...(opts.plugin || [])]),
+        ],
     };
     return options;
 }
 exports.getPluginOptions = getPluginOptions;
-function loadOptions(app) {
-    app.options.addReader(new typedoc_1.PackageJsonReader());
-    app.options.addReader(new typedoc_1.TypeDocReader());
-    app.options.addReader(new typedoc_1.TSConfigReader());
-    app.options.addDeclaration({
-        name: 'sidebar',
-        type: typedoc_1.ParameterType.Mixed,
-    });
-    app.options.addReader(new (class {
-        constructor() {
-            this.name = 'docusaurus-options';
-            this.order = 900;
-            this.supportsPackages = false;
-        }
-        read(container) {
-            const plugins = container.getValue('plugin');
-            container.setValue('plugin', plugins === null || plugins === void 0 ? void 0 : plugins.filter((plugin) => ![
-                'typedoc-plugin-markdown',
-                'typedoc-plugin-frontmatter',
-            ].includes(plugin)));
-        }
-    })());
+function setOptions(app, options) {
+    for (const [key, val] of Object.entries(options)) {
+        app.options.setValue(key, val);
+    }
 }
-exports.loadOptions = loadOptions;
+exports.setOptions = setOptions;

package/dist/plugin.d.ts

@@ -4,3 +4,5 @@ export default function pluginDocusaurus(context: any, opts: Partial<PluginOptio
     loadContent(): Promise<void>;
     extendCli(cli: any): void;
 };
+export declare function writeFileSync(fileName: string, data: string): void;
+export declare function normalizePath(path: string): string;

package/dist/plugin.js

@@ -23,12 +23,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePath = exports.writeFileSync = void 0;
+const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const typedoc_1 = require("typedoc");
-const typedoc_plugin_frontmatter_1 = require("typedoc-plugin-frontmatter");
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
+const frontmatter_1 = require("./frontmatter");
 const options_1 = require("./options");
-const renderer_1 = require("./renderer");
 // store list of plugin ids when running multiple instances
 const apps = [];
 function pluginDocusaurus(context, opts) {
@@ -37,7 +37,7 @@ function pluginDocusaurus(context, opts) {
         async loadContent() {
             if (opts.id && !apps.includes(opts.id)) {
                 apps.push(opts.id);
-                generateTypedoc(context, opts);
+                await generateTypedoc(context, opts);
             }
         },
         extendCli(cli) {
@@ -63,15 +63,11 @@ exports.default = pluginDocusaurus;
 async function generateTypedoc(context, opts) {
     const { siteDir } = context;
     const options = (0, options_1.getPluginOptions)(opts);
-    const { id, docsRoot, ...optionsPassedToTypeDoc } = options;
+    const { id, docsRoot, sidebar, ...optionsPassedToTypeDoc } = options;
     const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
-    const app = new typedoc_1.Application();
-    (0, options_1.loadOptions)(app);
-    (0, renderer_1.loadRenderer)(app);
-    (0, typedoc_plugin_markdown_1.load)(app);
-    (0, typedoc_plugin_frontmatter_1.load)(app);
-    await app.bootstrapWithPlugins(optionsPassedToTypeDoc);
-    const project = app.convert();
+    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    (0, frontmatter_1.loadFrontmatter)(app, options.sidebar);
+    const project = await app.convert();
     // if project is undefined typedoc has a problem - error logging will be supplied by typedoc.
     if (!project) {
         if (app.options.getValue('skipErrorChecking')) {
@@ -89,3 +85,12 @@ async function generateTypedoc(context, opts) {
         await app.generateDocs(project, outputDir);
     }
 }
+function writeFileSync(fileName, data) {
+    fs.mkdirSync(path.dirname(normalizePath(fileName)), { recursive: true });
+    fs.writeFileSync(normalizePath(fileName), data);
+}
+exports.writeFileSync = writeFileSync;
+function normalizePath(path) {
+    return path.replace(/\\/g, '/');
+}
+exports.normalizePath = normalizePath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.13",
+  "version": "1.0.0-next.15",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -15,17 +15,13 @@
     "directory": "packages/docusaurus-plugin-typedoc"
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
-  "dependencies": {
-    "typedoc-plugin-frontmatter": ">=0.0.2"
-  },
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.0.0-next.14"
+    "typedoc-plugin-markdown": ">=4.0.0-next.19"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
     "prepublishOnly": "npm run lint && npm run build",
-    "build": "rm -rf ./dist && tsc",
-    "build-and-test": "npm run build && npm run test"
+    "build": "rm -rf ./dist && tsc"
   },
   "author": "Thomas Grey",
   "license": "MIT",
@@ -36,5 +32,8 @@
     "markdown",
     "typescript",
     "api"
-  ]
+  ],
+  "dependencies": {
+    "@docusaurus/types": "^2.4.1"
+  }
 }

package/dist/renderer.d.ts

@@ -1,2 +0,0 @@
-import { Application } from 'typedoc';
-export declare function loadRenderer(app: Application): void;

package/dist/renderer.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadRenderer = void 0;
-const typedoc_1 = require("typedoc");
-const typedoc_plugin_frontmatter_1 = require("typedoc-plugin-frontmatter");
-function loadRenderer(app) {
-    app.renderer.on(typedoc_1.PageEvent.END, (page) => {
-        if (page.contents) {
-            page.contents = page.contents.replace(/\\</g, '<');
-        }
-    });
-    app.renderer.on(typedoc_plugin_frontmatter_1.FrontmatterEvent.PREPARE_FRONTMATTER, (event) => {
-        loadFrontmatter(app, event);
-    });
-}
-exports.loadRenderer = loadRenderer;
-function loadFrontmatter(app, event) {
-    var _a, _b, _c, _d, _e, _f, _g;
-    const hasReadme = !app.options.getValue('readme').endsWith('none');
-    const entryPage = app.options.getValue('entryFileName');
-    const indexPage = app.options.getValue('indexFileName');
-    const sidebar = app.options.getValue('sidebar');
-    const model = (_a = event.page) === null || _a === void 0 ? void 0 : _a.model;
-    const sidebarLabel = model === null || model === void 0 ? void 0 : model.name;
-    let pluginFrontmatter = {};
-    if (sidebar.autoConfiguration) {
-        if (((_b = event.page) === null || _b === void 0 ? void 0 : _b.url) === app.options.getValue('entryFileName')) {
-            if (sidebar.categoryLabel) {
-                pluginFrontmatter = {
-                    ...pluginFrontmatter,
-                    sidebar_label: sidebar.categoryLabel,
-                };
-            }
-        }
-        if (hasReadme) {
-            if (((_c = event.page) === null || _c === void 0 ? void 0 : _c.url) === entryPage) {
-                pluginFrontmatter = {
-                    ...pluginFrontmatter,
-                    ...(sidebar.readmeLabel && { sidebar_label: sidebar.readmeLabel }),
-                    sidebar_position: 0,
-                };
-            }
-            if (((_d = event.page) === null || _d === void 0 ? void 0 : _d.url) === `01-${indexPage}`) {
-                pluginFrontmatter = {
-                    ...pluginFrontmatter,
-                    ...(sidebar.indexLabel && { sidebar_label: sidebar.indexLabel }),
-                };
-            }
-        }
-        else {
-            if (((_e = event.page) === null || _e === void 0 ? void 0 : _e.url) === entryPage) {
-                pluginFrontmatter = {
-                    ...pluginFrontmatter,
-                    ...(sidebar.indexLabel && { sidebar_label: sidebar.indexLabel }),
-                    sidebar_position: 0,
-                };
-            }
-        }
-        // Add sidebar labels to all pages
-        if (!(((_f = event.page) === null || _f === void 0 ? void 0 : _f.url) === entryPage) &&
-            !(((_g = event.page) === null || _g === void 0 ? void 0 : _g.url) === `01-${indexPage}`)) {
-            pluginFrontmatter = {
-                ...pluginFrontmatter,
-                sidebar_label: sidebarLabel,
-            };
-        }
-    }
-    event.frontmatter = {
-        ...pluginFrontmatter,
-        ...event.frontmatter,
-    };
-}