docusaurus-plugin-typedoc 0.18.0 → 0.19.1

package/dist/theme.js

@@ -1,194 +1,194 @@
-"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 path = __importStar(require("path"));
-const typedoc_1 = require("typedoc");
-const groups_1 = require("typedoc-plugin-markdown/dist/groups");
-const theme_1 = require("typedoc-plugin-markdown/dist/theme");
-const front_matter_1 = require("typedoc-plugin-markdown/dist/utils/front-matter");
-const 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,
-};
-class DocusaurusTheme extends theme_1.MarkdownTheme {
-    constructor(renderer) {
-        super(renderer);
-        this.listenTo(this.application.renderer, {
-            [typedoc_1.PageEvent.END]: this.onPageEnd,
-            [typedoc_1.RendererEvent.END]: this.onRendererEnd,
-        });
-    }
-    getRelativeUrl(url) {
-        const re = new RegExp(this.includeExtension === 'true' ? '' : '.md', 'g');
-        const relativeUrl = super.getRelativeUrl(url).replace(re, '');
-        if (path.basename(relativeUrl).startsWith('index')) {
-            return relativeUrl.replace('index', '').replace('.md', '');
-        }
-        return relativeUrl;
-    }
-    onPageEnd(page) {
-        if (page.contents) {
-            page.contents = (0, front_matter_1.prependYAML)(page.contents, this.getYamlItems(page));
-        }
-    }
-    onRendererEnd(renderer) {
-        if (this.sidebar.autoConfiguration) {
-            writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed);
-            Object.keys(groupUrlsByKind(this.getUrls(renderer.project))).forEach((group) => {
-                const kind = parseInt(group);
-                const mapping = this.mappings.find((mapping) => mapping.kind.includes(kind));
-                if (mapping) {
-                    writeCategoryYaml(renderer.outputDirectory + '/' + mapping.directory, (0, groups_1.getKindPlural)(kind), CATEGORY_POSITION[kind], true);
-                }
-            });
-        }
-    }
-    getYamlItems(page) {
-        const pageId = this.getId(page);
-        const pageTitle = this.getTitle(page);
-        const sidebarLabel = this.getSidebarLabel(page);
-        const sidebarPosition = this.getSidebarPosition(page);
-        let items = {
-            id: pageId,
-            title: pageTitle,
-        };
-        if (page.url === this.entryDocument && this.indexSlug) {
-            items = { ...items, slug: this.indexSlug };
-        }
-        if (this.sidebar.autoConfiguration) {
-            if (sidebarLabel && sidebarLabel !== pageTitle) {
-                items = { ...items, sidebar_label: sidebarLabel };
-            }
-            if (sidebarPosition) {
-                items = { ...items, sidebar_position: parseFloat(sidebarPosition) };
-            }
-        }
-        if (page.url === page.project.url && this.entryPoints.length > 1) {
-            items = { ...items, hide_table_of_contents: true };
-        }
-        items = { ...items, custom_edit_url: null };
-        if (this.frontmatter) {
-            items = { ...items, ...this.frontmatter };
-        }
-        return {
-            ...items,
-        };
-    }
-    getSidebarLabel(page) {
-        const indexLabel = this.sidebar.indexLabel ||
-            (this.entryPoints.length > 1 ? 'Table of Contents' : 'Exports');
-        if (page.url === this.entryDocument) {
-            return page.url === page.project.url
-                ? indexLabel
-                : this.sidebar.readmeLabel;
-        }
-        if (page.url === this.globalsFile) {
-            return indexLabel;
-        }
-        return this.sidebar.fullNames ? page.model.getFullName() : page.model.name;
-    }
-    getSidebarPosition(page) {
-        if (page.url === this.entryDocument) {
-            return page.url === page.project.url ? '0.5' : '0';
-        }
-        if (page.url === this.globalsFile) {
-            return '0.5';
-        }
-        if (page.model.getFullName().split('.').length === 1) {
-            return '0';
-        }
-        return null;
-    }
-    getId(page) {
-        return path.basename(page.url, path.extname(page.url));
-    }
-    getTitle(page) {
-        const readmeTitle = this.readmeTitle || page.project.name;
-        if (page.url === this.entryDocument && page.url !== page.project.url) {
-            return readmeTitle;
-        }
-        return (0, front_matter_1.getPageTitle)(page);
-    }
-    get mappings() {
-        return super.mappings.map((mapping) => {
-            if (mapping.kind.includes(typedoc_1.ReflectionKind.Namespace)) {
-                return {
-                    ...mapping,
-                    directory: 'namespaces',
-                };
-            }
-            return mapping;
-        });
-    }
-    get globalsFile() {
-        return 'modules.md';
-    }
-}
-__decorate([
-    (0, typedoc_1.BindOption)('sidebar')
-], DocusaurusTheme.prototype, "sidebar", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('readmeTitle')
-], DocusaurusTheme.prototype, "readmeTitle", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('indexSlug')
-], DocusaurusTheme.prototype, "indexSlug", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('includeExtension')
-], DocusaurusTheme.prototype, "includeExtension", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('frontmatter')
-], DocusaurusTheme.prototype, "frontmatter", void 0);
-exports.DocusaurusTheme = DocusaurusTheme;
-const writeCategoryYaml = (categoryPath, label, position, collapsed) => {
-    const yaml = [`label: "${label}"`];
-    if (position !== null) {
-        yaml.push(`position: ${position}`);
-    }
-    if (!collapsed) {
-        yaml.push(`collapsed: false`);
-    }
-    if (fs.existsSync(categoryPath)) {
-        fs.writeFileSync(categoryPath + '/_category_.yml', yaml.join('\n'));
-    }
-};
-const groupUrlsByKind = (urls) => {
-    return urls.reduce((r, v, i, a, k = v.model.kind) => ((r[k] || (r[k] = [])).push(v), r), {});
-};
+"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 path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+const groups_1 = require("typedoc-plugin-markdown/dist/groups");
+const theme_1 = require("typedoc-plugin-markdown/dist/theme");
+const front_matter_1 = require("typedoc-plugin-markdown/dist/utils/front-matter");
+const 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,
+};
+class DocusaurusTheme extends theme_1.MarkdownTheme {
+    constructor(renderer) {
+        super(renderer);
+        this.listenTo(this.application.renderer, {
+            [typedoc_1.PageEvent.END]: this.onPageEnd,
+            [typedoc_1.RendererEvent.END]: this.onRendererEnd,
+        });
+    }
+    getRelativeUrl(url) {
+        const re = new RegExp(this.includeExtension === 'true' ? '' : '.md', 'g');
+        const relativeUrl = super.getRelativeUrl(url).replace(re, '');
+        if (path.basename(relativeUrl).startsWith('index')) {
+            return relativeUrl.replace('index', '').replace('.md', '');
+        }
+        return relativeUrl;
+    }
+    onPageEnd(page) {
+        if (page.contents) {
+            page.contents = (0, front_matter_1.prependYAML)(page.contents, this.getYamlItems(page));
+        }
+    }
+    onRendererEnd(renderer) {
+        if (this.sidebar.autoConfiguration) {
+            writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed);
+            Object.keys(groupUrlsByKind(this.getUrls(renderer.project))).forEach((group) => {
+                const kind = parseInt(group);
+                const mapping = this.mappings.find((mapping) => mapping.kind.includes(kind));
+                if (mapping) {
+                    writeCategoryYaml(renderer.outputDirectory + '/' + mapping.directory, (0, groups_1.getKindPlural)(kind), CATEGORY_POSITION[kind], true);
+                }
+            });
+        }
+    }
+    getYamlItems(page) {
+        const pageId = this.getId(page);
+        const pageTitle = this.getTitle(page);
+        const sidebarLabel = this.getSidebarLabel(page);
+        const sidebarPosition = this.getSidebarPosition(page);
+        let items = {
+            id: pageId,
+            title: pageTitle,
+        };
+        if (page.url === this.entryDocument && this.indexSlug) {
+            items = { ...items, slug: this.indexSlug };
+        }
+        if (this.sidebar.autoConfiguration) {
+            if (sidebarLabel && sidebarLabel !== pageTitle) {
+                items = { ...items, sidebar_label: sidebarLabel };
+            }
+            if (sidebarPosition) {
+                items = { ...items, sidebar_position: parseFloat(sidebarPosition) };
+            }
+        }
+        if (page.url === page.project.url && this.entryPoints.length > 1) {
+            items = { ...items, hide_table_of_contents: true };
+        }
+        items = { ...items, custom_edit_url: null };
+        if (this.frontmatter) {
+            items = { ...items, ...this.frontmatter };
+        }
+        return {
+            ...items,
+        };
+    }
+    getSidebarLabel(page) {
+        const indexLabel = this.sidebar.indexLabel ||
+            (this.entryPoints.length > 1 ? 'Table of Contents' : 'Exports');
+        if (page.url === this.entryDocument) {
+            return page.url === page.project.url
+                ? indexLabel
+                : this.sidebar.readmeLabel;
+        }
+        if (page.url === this.globalsFile) {
+            return indexLabel;
+        }
+        return this.sidebar.fullNames ? page.model.getFullName() : page.model.name;
+    }
+    getSidebarPosition(page) {
+        if (page.url === this.entryDocument) {
+            return page.url === page.project.url ? '0.5' : '0';
+        }
+        if (page.url === this.globalsFile) {
+            return '0.5';
+        }
+        if (page.model.getFullName().split('.').length === 1) {
+            return '0';
+        }
+        return null;
+    }
+    getId(page) {
+        return path.basename(page.url, path.extname(page.url));
+    }
+    getTitle(page) {
+        const readmeTitle = this.readmeTitle || page.project.name;
+        if (page.url === this.entryDocument && page.url !== page.project.url) {
+            return readmeTitle;
+        }
+        return (0, front_matter_1.getPageTitle)(page);
+    }
+    get mappings() {
+        return super.mappings.map((mapping) => {
+            if (mapping.kind.includes(typedoc_1.ReflectionKind.Namespace)) {
+                return {
+                    ...mapping,
+                    directory: 'namespaces',
+                };
+            }
+            return mapping;
+        });
+    }
+    get globalsFile() {
+        return 'modules.md';
+    }
+}
+__decorate([
+    (0, typedoc_1.BindOption)('sidebar')
+], DocusaurusTheme.prototype, "sidebar", void 0);
+__decorate([
+    (0, typedoc_1.BindOption)('readmeTitle')
+], DocusaurusTheme.prototype, "readmeTitle", void 0);
+__decorate([
+    (0, typedoc_1.BindOption)('indexSlug')
+], DocusaurusTheme.prototype, "indexSlug", void 0);
+__decorate([
+    (0, typedoc_1.BindOption)('includeExtension')
+], DocusaurusTheme.prototype, "includeExtension", void 0);
+__decorate([
+    (0, typedoc_1.BindOption)('frontmatter')
+], DocusaurusTheme.prototype, "frontmatter", void 0);
+exports.DocusaurusTheme = DocusaurusTheme;
+const writeCategoryYaml = (categoryPath, label, position, collapsed) => {
+    const yaml = [`label: "${label}"`];
+    if (position !== null) {
+        yaml.push(`position: ${position}`);
+    }
+    if (!collapsed) {
+        yaml.push(`collapsed: false`);
+    }
+    if (fs.existsSync(categoryPath)) {
+        fs.writeFileSync(categoryPath + '/_category_.yml', yaml.join('\n'));
+    }
+};
+const groupUrlsByKind = (urls) => {
+    return urls.reduce((r, v, i, a, k = v.model.kind) => ((r[k] || (r[k] = [])).push(v), r), {});
+};

package/dist/types.d.ts

@@ -1,39 +1,39 @@
-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;
-    hideMembersSymbol: boolean;
-    entryDocument: string;
-    includeExtension?: boolean;
-    indexSlug?: string;
-    theme?: string;
-    frontmatter: FrontMatter;
-}
-export type FrontMatter = Record<string, string | boolean | number | null> | undefined;
-export interface SidebarOptions {
-    fullNames?: boolean;
-    categoryLabel: string;
-    collapsed: boolean;
-    indexLabel?: string;
-    readmeLabel?: string;
-    position: number | null;
-    autoConfiguration: boolean;
-}
-export interface SidebarCategory {
-    type: string;
-    label: string;
-    items: SidebarItem[];
-}
-export type SidebarItem = SidebarCategory | string;
+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;
+    hideMembersSymbol: boolean;
+    entryDocument: string;
+    includeExtension?: boolean;
+    indexSlug?: string;
+    theme?: string;
+    frontmatter: FrontMatter;
+}
+export type FrontMatter = Record<string, string | boolean | number | null> | undefined;
+export interface SidebarOptions {
+    fullNames?: boolean;
+    categoryLabel: string;
+    collapsed: boolean;
+    indexLabel?: string;
+    readmeLabel?: string;
+    position: number | null;
+    autoConfiguration: boolean;
+}
+export interface SidebarCategory {
+    type: string;
+    label: string;
+    items: SidebarItem[];
+}
+export type SidebarItem = SidebarCategory | string;

package/dist/types.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,42 +1,42 @@
-{
-  "name": "docusaurus-plugin-typedoc",
-  "version": "0.18.0",
-  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
-  "main": "dist/index.js",
-  "files": [
-    "dist/"
-  ],
-  "bugs": {
-    "url": "https://github.com/tgreyuk/typedoc-plugin-markdown/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tgreyuk/typedoc-plugin-markdown.git",
-    "directory": "packages/docusaurus-plugin-typedoc"
-  },
-  "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
-  "peerDependencies": {
-    "typedoc": ">=0.23.0",
-    "typedoc-plugin-markdown": ">=3.13.0"
-  },
-  "devDependencies": {
-    "typedoc-plugin-markdown": "^3.13.0"
-  },
-  "scripts": {
-    "lint": "eslint ./src --ext .ts",
-    "prepublishOnly": "yarn run lint && yarn run build && yarn run test",
-    "build": "rm -rf ./dist && tsc",
-    "build-and-test": "yarn run build && yarn run test",
-    "test": "jest --colors"
-  },
-  "author": "Thomas Grey",
-  "license": "MIT",
-  "keywords": [
-    "docusaurus",
-    "typedoc",
-    "plugin",
-    "markdown",
-    "typescript",
-    "api"
-  ]
-}
+{
+  "name": "docusaurus-plugin-typedoc",
+  "version": "0.19.1",
+  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
+  "main": "dist/index.js",
+  "files": [
+    "dist/"
+  ],
+  "bugs": {
+    "url": "https://github.com/tgreyuk/typedoc-plugin-markdown/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tgreyuk/typedoc-plugin-markdown.git",
+    "directory": "packages/docusaurus-plugin-typedoc"
+  },
+  "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
+  "peerDependencies": {
+    "typedoc": ">=0.24.0",
+    "typedoc-plugin-markdown": ">=3.15.0"
+  },
+  "devDependencies": {
+    "typedoc-plugin-markdown": "^3.15.0"
+  },
+  "scripts": {
+    "lint": "eslint ./src --ext .ts",
+    "prepublishOnly": "yarn run lint && yarn run build && yarn run test",
+    "build": "rm -rf ./dist && tsc",
+    "build-and-test": "yarn run build && yarn run test",
+    "test": "jest --colors"
+  },
+  "author": "Thomas Grey",
+  "license": "MIT",
+  "keywords": [
+    "docusaurus",
+    "typedoc",
+    "plugin",
+    "markdown",
+    "typescript",
+    "api"
+  ]
+}