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

package/dist/models.d.ts

@@ -0,0 +1,18 @@
+import { TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
+export interface PluginOptions extends TypedocPluginMarkdownOptions {
+    id: string;
+    docsRoot: string;
+    sidebar: SidebarOptions;
+}
+export interface SidebarOptions {
+    categoryLabel: string;
+    collapsed: boolean;
+    position: number | null;
+    autoConfiguration: boolean;
+}
+export interface SidebarCategory {
+    type: string;
+    label: string;
+    items: SidebarItem[];
+}
+export type SidebarItem = SidebarCategory | string;

package/dist/options.d.ts

@@ -1,2 +1,2 @@
-import { PluginOptions } from './types';
+import { PluginOptions } from './models';
 export declare const getPluginOptions: (opts: Partial<PluginOptions>) => PluginOptions;

package/dist/options.js

@@ -5,12 +5,9 @@ const DEFAULT_PLUGIN_OPTIONS = {
     id: 'default',
     docsRoot: 'docs',
     out: 'api',
-    cleanOutputDir: true,
     sidebar: {
-        fullNames: false,
         categoryLabel: 'API',
         collapsed: true,
-        indexLabel: 'Overview',
         position: null,
         autoConfiguration: true,
     },
@@ -18,10 +15,10 @@ const DEFAULT_PLUGIN_OPTIONS = {
     hideBreadcrumbs: true,
     hidePageTitle: false,
     entryDocument: 'index.md',
-    plugin: ['none'],
     watch: false,
-    theme: 'docusaurus',
     enableFrontmatter: true,
+    numberPrefixOutput: true,
+    theme: 'docusaurus',
 };
 const getPluginOptions = (opts) => {
     const options = {

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
-import { PluginOptions } from './types';
+import { PluginOptions } from './models';
 export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): {
     name: string;
     loadContent(): Promise<void>;

package/dist/plugin.js

@@ -59,13 +59,12 @@ async function generateTypedoc(context, opts) {
     const { siteDir } = context;
     const options = (0, options_1.getPluginOptions)(opts);
     const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
-    if (opts.cleanOutputDir) {
-        (0, render_1.removeDir)(outputDir);
-    }
     const app = new typedoc_1.Application();
     app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
     (0, typedoc_plugin_markdown_1.load)(app);
-    (0, render_1.bootstrap)(app, options);
+    (0, render_1.addTypedocReaders)(app);
+    (0, render_1.addTypedocDeclarations)(app);
+    await app.bootstrapWithPlugins(options);
     const project = app.convert();
     if (!project) {
         return;

package/dist/render.d.ts

@@ -1,5 +1,3 @@
-import { Application, ProjectReflection } from 'typedoc';
-import { PluginOptions } from './types';
-export declare const bootstrap: (app: Application, options: PluginOptions) => void;
-export declare function render(project: ProjectReflection, outputDirectory: string): Promise<void>;
-export declare function removeDir(path: string): void;
+import { Application } from 'typedoc';
+export declare function addTypedocReaders(app: Application): void;
+export declare function addTypedocDeclarations(app: Application): void;

package/dist/render.js

@@ -1,72 +1,19 @@
 "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.removeDir = exports.render = exports.bootstrap = void 0;
-const fs = __importStar(require("fs"));
+exports.addTypedocDeclarations = exports.addTypedocReaders = void 0;
 const typedoc_1 = require("typedoc");
-const bootstrap = (app, options) => {
-    addTypedocReaders(app);
-    addTypedocDeclarations(app);
-    app.renderer.render = render;
-    app.bootstrap(options);
-};
-exports.bootstrap = bootstrap;
-async function render(project, outputDirectory) {
-    var _a;
-    if (!this.prepareTheme()) {
-        return;
-    }
-    const output = new typedoc_1.RendererEvent(typedoc_1.RendererEvent.BEGIN, outputDirectory, project);
-    output.urls = this.theme.getUrls(project);
-    this.trigger(output);
-    await Promise.all(this.preRenderAsyncJobs.map((job) => job(output)));
-    this.preRenderAsyncJobs = [];
-    if (!output.isDefaultPrevented) {
-        (_a = output.urls) === null || _a === void 0 ? void 0 : _a.forEach((mapping) => {
-            this.renderDocument(...output.createPageEvent(mapping));
-        });
-        await Promise.all(this.postRenderAsyncJobs.map((job) => job(output)));
-        this.postRenderAsyncJobs = [];
-        this.trigger(typedoc_1.RendererEvent.END, output);
-    }
-}
-exports.render = render;
-const addTypedocReaders = (app) => {
+function addTypedocReaders(app) {
     app.options.addReader(new typedoc_1.TypeDocReader());
     app.options.addReader(new typedoc_1.TSConfigReader());
-};
-const addTypedocDeclarations = (app) => {
+}
+exports.addTypedocReaders = addTypedocReaders;
+function addTypedocDeclarations(app) {
     app.options.addDeclaration({
         name: 'id',
     });
     app.options.addDeclaration({
         name: 'docsRoot',
     });
-    app.options.addDeclaration({
-        name: 'siteDir',
-    });
     app.options.addDeclaration({
         name: 'globalsTitle',
     });
@@ -74,8 +21,5 @@ const addTypedocDeclarations = (app) => {
         name: 'sidebar',
         type: typedoc_1.ParameterType.Mixed,
     });
-};
-function removeDir(path) {
-    fs.rmSync(path, { recursive: true, force: true });
 }
-exports.removeDir = removeDir;
+exports.addTypedocDeclarations = addTypedocDeclarations;

package/dist/theme.d.ts

@@ -1,11 +1,11 @@
 import { DeclarationReflection, PageEvent, Renderer, RendererEvent } from 'typedoc';
 import { MarkdownTheme } from 'typedoc-plugin-markdown';
-import { SidebarOptions } from './types';
+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): void;
-    writeCategoryYaml: (categoryPath: string, label: string, position: number | null, collapsed: boolean) => void;
+    loopAndWriteCategories(path: string, level?: number): void;
+    writeCategoryYaml: (categoryPath: string, label: string, position: number | null, collapsed: boolean, generatedIndex: boolean) => void;
 }

package/dist/theme.js

@@ -33,11 +33,10 @@ exports.DocusaurusTheme = void 0;
 const fs = __importStar(require("fs"));
 const typedoc_1 = require("typedoc");
 const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-const navigation_1 = require("./navigation");
 class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
     constructor(renderer) {
         super(renderer);
-        this.writeCategoryYaml = (categoryPath, label, position, collapsed) => {
+        this.writeCategoryYaml = (categoryPath, label, position, collapsed, generatedIndex) => {
             const yaml = [`label: "${label}"`];
             if (position !== null) {
                 yaml.push(`position: ${position}`);
@@ -45,6 +44,11 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
             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'));
             }
@@ -61,16 +65,11 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
     }
     onRendererEnd(renderer) {
         if (this.sidebar.autoConfiguration) {
-            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed);
+            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed, false);
             this.loopAndWriteCategories(renderer.outputDirectory);
-            const globalsFile = this.getRenderContext().globalsFile;
-            const globalsPath = `${renderer.outputDirectory}/${this.getRenderContext().globalsFile}`;
-            if (fs.existsSync(globalsPath)) {
-                fs.renameSync(globalsPath, `${renderer.outputDirectory}/01-${globalsFile}`);
-            }
         }
     }
-    loopAndWriteCategories(path) {
+    loopAndWriteCategories(path, level = 0) {
         const directory = fs.readdirSync(path);
         directory.forEach((segment) => {
             const fullPath = `${path}/${segment}`;
@@ -78,14 +77,12 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
             if (isDirectory) {
                 const mapping = Object.entries(this.mappings)
                     .filter((entry) => {
-                    return entry[1].directory === segment;
+                    return entry[1].directory === segment.slice(3);
                 })
                     .map((entry) => entry[1])[0];
                 const subdirectory = fs.readdirSync(fullPath);
-                const containsDir = subdirectory.some((item) => fs.lstatSync(`${fullPath}/${item}`).isDirectory());
-                if ((mapping && !containsDir) ||
-                    (mapping === null || mapping === void 0 ? void 0 : mapping.kind) === typedoc_1.ReflectionKind.Namespace) {
-                    this.writeCategoryYaml(fullPath, (0, navigation_1.getKindPlural)(mapping.kind), navigation_1.CATEGORY_POSITION[mapping.kind], true);
+                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);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.4",
+  "version": "1.0.0-next.7",
   "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.5"
+    "typedoc-plugin-markdown": ">=4.0.0-next.8"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",

package/dist/navigation.d.ts

@@ -1,13 +0,0 @@
-import { ReflectionKind } from 'typedoc';
-export declare const CATEGORY_POSITION: {
-    2: number;
-    4: number;
-    8: number;
-    128: number;
-    256: number;
-    4194304: number;
-    32: number;
-    64: number;
-    2097152: number;
-};
-export declare function getKindPlural(kind: ReflectionKind): string;

package/dist/navigation.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKindPlural = exports.CATEGORY_POSITION = void 0;
-const typedoc_1 = require("typedoc");
-const PLURALS = {
-    [typedoc_1.ReflectionKind.Class]: 'Classes',
-    [typedoc_1.ReflectionKind.Property]: 'Properties',
-    [typedoc_1.ReflectionKind.Enum]: 'Enumerations',
-    [typedoc_1.ReflectionKind.EnumMember]: 'Enumeration members',
-    [typedoc_1.ReflectionKind.Namespace]: 'Namespaces',
-    [typedoc_1.ReflectionKind.TypeAlias]: 'Type aliases',
-};
-exports.CATEGORY_POSITION = {
-    [typedoc_1.ReflectionKind.Module]: 1,
-    [typedoc_1.ReflectionKind.Namespace]: 1,
-    [typedoc_1.ReflectionKind.Enum]: 2,
-    [typedoc_1.ReflectionKind.Class]: 3,
-    [typedoc_1.ReflectionKind.Interface]: 4,
-    [typedoc_1.ReflectionKind.TypeAlias]: 5,
-    [typedoc_1.ReflectionKind.Variable]: 6,
-    [typedoc_1.ReflectionKind.Function]: 7,
-    [typedoc_1.ReflectionKind.ObjectLiteral]: 8,
-};
-function getKindPlural(kind) {
-    if (kind in PLURALS) {
-        return PLURALS[kind];
-    }
-    else {
-        return getKindString(kind) + 's';
-    }
-}
-exports.getKindPlural = getKindPlural;
-function getKindString(kind) {
-    let str = typedoc_1.ReflectionKind[kind];
-    str = str.replace(/(.)([A-Z])/g, (_m, a, b) => a + ' ' + b.toLowerCase());
-    return str;
-}

package/dist/types.d.ts

@@ -1,36 +0,0 @@
-export interface PluginOptions {
-    id: string;
-    docsRoot: string;
-    out: string;
-    sidebar: SidebarOptions;
-    readmeTitle?: string;
-    globalsTitle?: string;
-    plugin: string[];
-    readme?: string;
-    disableOutputCheck?: boolean;
-    cleanOutputDir?: boolean;
-    entryPoints?: string[];
-    watch: boolean;
-    hideInPageTOC: boolean;
-    hideBreadcrumbs: boolean;
-    hidePageTitle: boolean;
-    entryDocument: string;
-    includeExtension?: boolean;
-    theme?: string;
-    enableFrontmatter: boolean;
-}
-export type FrontMatter = Record<string, string | boolean | number | null> | undefined;
-export interface SidebarOptions {
-    fullNames?: boolean;
-    categoryLabel: string;
-    collapsed: boolean;
-    indexLabel?: string;
-    position: number | null;
-    autoConfiguration: boolean;
-}
-export interface SidebarCategory {
-    type: string;
-    label: string;
-    items: SidebarItem[];
-}
-export type SidebarItem = SidebarCategory | string;