docusaurus-plugin-typedoc 1.0.0-next.7 → 1.0.0-next.8

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { default } from './plugin';
+export { default } from './plugin.docusaurus';
+export { load } from './plugin.typedoc';

package/dist/index.js

@@ -3,6 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = void 0;
-var plugin_1 = require("./plugin");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(plugin_1).default; } });
+exports.load = exports.default = void 0;
+var plugin_docusaurus_1 = require("./plugin.docusaurus");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(plugin_docusaurus_1).default; } });
+var plugin_typedoc_1 = require("./plugin.typedoc");
+Object.defineProperty(exports, "load", { enumerable: true, get: function () { return plugin_typedoc_1.load; } });

package/dist/models.d.ts

@@ -15,4 +15,10 @@ export interface SidebarCategory {
     label: string;
     items: SidebarItem[];
 }
+export interface CategoryYamlOptions {
+    path: string;
+    label: string;
+    position: number | null;
+    collapsed: boolean;
+}
 export type SidebarItem = SidebarCategory | string;

package/dist/options.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPluginOptions = void 0;
+const plugin = require.resolve('docusaurus-plugin-typedoc');
 const DEFAULT_PLUGIN_OPTIONS = {
     id: 'default',
     docsRoot: 'docs',
@@ -13,12 +14,11 @@ const DEFAULT_PLUGIN_OPTIONS = {
     },
     hideInPageTOC: true,
     hideBreadcrumbs: true,
-    hidePageTitle: false,
     entryDocument: 'index.md',
     watch: false,
     enableFrontmatter: true,
     numberPrefixOutput: true,
-    theme: 'docusaurus',
+    plugin: [plugin],
 };
 const getPluginOptions = (opts) => {
     const options = {
@@ -28,6 +28,7 @@ const getPluginOptions = (opts) => {
             ...DEFAULT_PLUGIN_OPTIONS.sidebar,
             ...opts.sidebar,
         },
+        plugin: [DEFAULT_PLUGIN_OPTIONS.plugin, ...(opts.plugin || [])],
     };
     return options;
 };

package/dist/{plugin.js → plugin.docusaurus.js}

@@ -27,8 +27,6 @@ const path = __importStar(require("path"));
 const typedoc_1 = require("typedoc");
 const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
 const options_1 = require("./options");
-const render_1 = require("./render");
-const theme_1 = require("./theme");
 const apps = [];
 function pluginDocusaurus(context, opts) {
     return {
@@ -58,13 +56,13 @@ exports.default = pluginDocusaurus;
 async function generateTypedoc(context, opts) {
     const { siteDir } = context;
     const options = (0, options_1.getPluginOptions)(opts);
+    const { id, docsRoot, ...optionsPassedToTypeDoc } = options;
     const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
     const app = new typedoc_1.Application();
-    app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
+    app.options.addReader(new typedoc_1.TypeDocReader());
+    app.options.addReader(new typedoc_1.TSConfigReader());
     (0, typedoc_plugin_markdown_1.load)(app);
-    (0, render_1.addTypedocReaders)(app);
-    (0, render_1.addTypedocDeclarations)(app);
-    await app.bootstrapWithPlugins(options);
+    await app.bootstrapWithPlugins(optionsPassedToTypeDoc);
     const project = app.convert();
     if (!project) {
         return;

package/dist/plugin.typedoc.d.ts

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

package/dist/plugin.typedoc.js

@@ -0,0 +1,79 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.load = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+function load(app) {
+    app.options.addDeclaration({
+        name: 'sidebar',
+        type: typedoc_1.ParameterType.Mixed,
+    });
+    app.renderer.on(typedoc_1.PageEvent.END, (page) => {
+        if (page.contents) {
+            page.contents = page.contents.replace(/\\</g, '<');
+        }
+    });
+    app.renderer.postRenderAsyncJobs.push(async (renderer) => {
+        var _a;
+        const sidebar = app.options.getValue('sidebar');
+        if (sidebar.autoConfiguration) {
+            writeCategoryYaml({
+                path: renderer.outputDirectory,
+                label: sidebar.categoryLabel,
+                position: sidebar.position,
+                collapsed: sidebar.collapsed,
+            });
+        }
+        const urlGroups = (_a = renderer.urls) === null || _a === void 0 ? void 0 : _a.filter((urlMapping) => {
+            return urlMapping.model instanceof typedoc_1.ReflectionGroup;
+        });
+        urlGroups === null || urlGroups === void 0 ? void 0 : urlGroups.forEach((urlGroup) => {
+            const groupUrl = path.join(renderer.outputDirectory, urlGroup.url);
+            writeCategoryYaml({
+                path: groupUrl,
+                label: urlGroup.model.title,
+                position: null,
+                collapsed: sidebar.collapsed,
+            });
+        });
+        app.logger.verbose('[docusaurus-plugin-typedoc] _category_.yml files written' +
+            renderer.outputDirectory);
+    });
+}
+exports.load = load;
+function writeCategoryYaml(categoryYamlOptions) {
+    const yaml = [`label: "${categoryYamlOptions.label}"`];
+    if (categoryYamlOptions.position !== null) {
+        yaml.push(`position: ${categoryYamlOptions.position}`);
+    }
+    if (!categoryYamlOptions.collapsed) {
+        yaml.push(`collapsed: false`);
+    }
+    if (fs.existsSync(categoryYamlOptions.path)) {
+        fs.writeFileSync(categoryYamlOptions.path + '/_category_.yml', yaml.join('\n'));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.7",
+  "version": "1.0.0-next.8",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -16,7 +16,7 @@
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.0.0-next.8"
+    "typedoc-plugin-markdown": ">=4.0.0-next.9"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",

package/dist/render.d.ts

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

package/dist/render.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addTypedocDeclarations = exports.addTypedocReaders = void 0;
-const typedoc_1 = require("typedoc");
-function addTypedocReaders(app) {
-    app.options.addReader(new typedoc_1.TypeDocReader());
-    app.options.addReader(new typedoc_1.TSConfigReader());
-}
-exports.addTypedocReaders = addTypedocReaders;
-function addTypedocDeclarations(app) {
-    app.options.addDeclaration({
-        name: 'id',
-    });
-    app.options.addDeclaration({
-        name: 'docsRoot',
-    });
-    app.options.addDeclaration({
-        name: 'globalsTitle',
-    });
-    app.options.addDeclaration({
-        name: 'sidebar',
-        type: typedoc_1.ParameterType.Mixed,
-    });
-}
-exports.addTypedocDeclarations = addTypedocDeclarations;

package/dist/theme.d.ts

@@ -1,11 +0,0 @@
-import { DeclarationReflection, PageEvent, Renderer, RendererEvent } from 'typedoc';
-import { MarkdownTheme } from 'typedoc-plugin-markdown';
-import { SidebarOptions } from './models';
-export declare class DocusaurusTheme extends MarkdownTheme {
-    sidebar: SidebarOptions;
-    constructor(renderer: Renderer);
-    onPageEnd(page: PageEvent<DeclarationReflection>): void;
-    onRendererEnd(renderer: RendererEvent): void;
-    loopAndWriteCategories(path: string, level?: number): void;
-    writeCategoryYaml: (categoryPath: string, label: string, position: number | null, collapsed: boolean, generatedIndex: boolean) => void;
-}

package/dist/theme.js

@@ -1,95 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocusaurusTheme = void 0;
-const fs = __importStar(require("fs"));
-const typedoc_1 = require("typedoc");
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
-    constructor(renderer) {
-        super(renderer);
-        this.writeCategoryYaml = (categoryPath, label, position, collapsed, generatedIndex) => {
-            const yaml = [`label: "${label}"`];
-            if (position !== null) {
-                yaml.push(`position: ${position}`);
-            }
-            if (!collapsed) {
-                yaml.push(`collapsed: false`);
-            }
-            if (generatedIndex) {
-                yaml.push(`link:
-  type: "generated-index"
-  title: "${label}"`);
-            }
-            if (fs.existsSync(categoryPath)) {
-                fs.writeFileSync(categoryPath + '/_category_.yml', yaml.join('\n'));
-            }
-        };
-        this.listenTo(this.application.renderer, {
-            [typedoc_1.PageEvent.END]: this.onPageEnd,
-            [typedoc_1.RendererEvent.END]: this.onRendererEnd,
-        });
-    }
-    onPageEnd(page) {
-        if (page.contents) {
-            page.contents = page.contents.replace(/\\</g, '<');
-        }
-    }
-    onRendererEnd(renderer) {
-        if (this.sidebar.autoConfiguration) {
-            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed, false);
-            this.loopAndWriteCategories(renderer.outputDirectory);
-        }
-    }
-    loopAndWriteCategories(path, level = 0) {
-        const directory = fs.readdirSync(path);
-        directory.forEach((segment) => {
-            const fullPath = `${path}/${segment}`;
-            const isDirectory = fs.lstatSync(fullPath).isDirectory();
-            if (isDirectory) {
-                const mapping = Object.entries(this.mappings)
-                    .filter((entry) => {
-                    return entry[1].directory === segment.slice(3);
-                })
-                    .map((entry) => entry[1])[0];
-                const subdirectory = fs.readdirSync(fullPath);
-                if (mapping && !subdirectory.includes(`${mapping === null || mapping === void 0 ? void 0 : mapping.directory}.md`)) {
-                    this.writeCategoryYaml(fullPath, typedoc_1.ReflectionKind.pluralString(mapping.kind), null, true, true);
-                }
-                this.loopAndWriteCategories(fullPath);
-            }
-        });
-    }
-}
-__decorate([
-    (0, typedoc_1.BindOption)('sidebar')
-], DocusaurusTheme.prototype, "sidebar", void 0);
-exports.DocusaurusTheme = DocusaurusTheme;