docusaurus-plugin-typedoc 1.0.0-next.25 → 1.0.0-next.26

package/dist/plugin.d.ts

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

package/dist/plugin.js

@@ -23,7 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeDir = exports.normalizePath = exports.writeFileSync = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const typedoc_1 = require("typedoc");
@@ -45,8 +44,7 @@ async function pluginDocusaurus(context, opts) {
                 .command('generate-typedoc')
                 .description(`[${PLUGIN_NAME}] Generate TypeDoc docs independently of the Docusaurus build process.`)
                 .action(async () => {
-                var _a;
-                (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.plugins.forEach((pluginConfig) => {
+                context.siteConfig?.plugins.forEach((pluginConfig) => {
                     // Check PluginConfig is typed to [string, PluginOptions]
                     if (pluginConfig && typeof pluginConfig[1] === 'object') {
                         generateTypedoc(context, pluginConfig[1]);
@@ -61,33 +59,27 @@ exports.default = pluginDocusaurus;
  * Initiates a new typedoc Application bootstraped with plugin options
  */
 async function generateTypedoc(context, opts) {
-    var _a, _b, _c;
     const { siteDir } = context;
     const options = (0, options_1.getPluginOptions)(opts);
     const { id, sidebar, ...optionsPassedToTypeDoc } = options;
     const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
     app.renderer.defineTheme('docusaurus', theme_1.DocusuaurusTheme);
     const outputDir = app.options.getValue('out');
-    if (options.cleanOutputDir) {
-        removeDir(outputDir);
-    }
-    if (((_b = (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.markdown) === null || _b === void 0 ? void 0 : _b.format) !== 'mdx') {
+    if (context.siteConfig?.markdown?.format !== 'mdx') {
         app.renderer.on(typedoc_1.PageEvent.END, (event) => {
-            var _a;
-            event.contents = (_a = event.contents) === null || _a === void 0 ? void 0 : _a.replace(/\\</g, '<');
+            event.contents = event.contents?.replace(/\\</g, '<');
         });
     }
-    if (sidebar === null || sidebar === void 0 ? void 0 : sidebar.autoConfiguration) {
-        const docsPreset = (_c = context.siteConfig) === null || _c === void 0 ? void 0 : _c.presets.find((preset) => { var _a; return Boolean((_a = preset[1]) === null || _a === void 0 ? void 0 : _a.docs); });
+    if (sidebar?.autoConfiguration) {
+        const docsPreset = context.siteConfig?.presets?.find((preset) => Boolean(preset[1]?.docs));
         app.renderer.postRenderAsyncJobs.push(async (output) => {
-            var _a, _b;
             const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
             const baseDir = path
                 .relative(siteDir, outputDir)
                 .split(path.sep)
                 .slice(1)
                 .join(path.sep);
-            const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, baseDir, sidebar.filteredIds, (_b = (_a = docsPreset[1]) === null || _a === void 0 ? void 0 : _a.docs) === null || _b === void 0 ? void 0 : _b.numberPrefixParser);
+            const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, baseDir, sidebar.filteredIds, docsPreset ? docsPreset[1]?.docs?.numberPrefixParser : null);
             fs.writeFileSync(sidebarPath, `// @ts-check
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const typedocSidebar = { items: ${JSON.stringify(sidebarJson, null, sidebar.pretty ? 2 : 0)}};
@@ -112,32 +104,3 @@ module.exports = typedocSidebar.items;`);
         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;
-function removeDir(path) {
-    if (fs.existsSync(path)) {
-        const files = fs.readdirSync(path);
-        if (files.length > 0) {
-            files.forEach(function (filename) {
-                if (fs.statSync(path + '/' + filename).isDirectory()) {
-                    removeDir(path + '/' + filename);
-                }
-                else {
-                    fs.unlinkSync(path + '/' + filename);
-                }
-            });
-            fs.rmdirSync(path);
-        }
-        else {
-            fs.rmdirSync(path);
-        }
-    }
-}
-exports.removeDir = removeDir;

package/dist/sidebar.js

@@ -8,14 +8,13 @@ function getSidebar(navigation, basePath, filteredIds = [], numberPrefixParser)
 }
 exports.getSidebar = getSidebar;
 function getNavigationItem(navigationItem, basePath, filteredIds, numberPrefixParser) {
-    var _a, _b;
     const parsedUrl = numberPrefixParser === false
         ? navigationItem.url
-        : (_a = navigationItem.url) === null || _a === void 0 ? void 0 : _a.replace(/\d+\-/g, '');
+        : navigationItem.url?.replace(/\d+\-/g, '');
     const id = navigationItem.url
         ? `${basePath}/${parsedUrl}`.replace(/(.*).md/, '$1')
         : null;
-    if ((_b = navigationItem.children) === null || _b === void 0 ? void 0 : _b.length) {
+    if (navigationItem.children?.length) {
         return {
             type: 'category',
             label: navigationItem.title,

package/dist/theme.js

@@ -13,12 +13,15 @@ class DocusuaurusThemeThemeRenderContext extends typedoc_plugin_markdown_1.Markd
     constructor() {
         super(...arguments);
         // adds space around type arguments as docusaurus generates broken links without it in certain use-cases (see https://github.com/facebook/docusaurus/issues/9518)
-        this.typeArguments = (typeArguments) => {
-            return `\\< ${typeArguments
-                .map((typeArgument) => typeArgument instanceof typedoc_1.ReflectionType
-                ? this.reflectionType(typeArgument)
-                : this.someType(typeArgument))
-                .join(', ')} \\>`;
+        this.partials = {
+            ...this.partials,
+            typeArguments: (typeArguments) => {
+                return `\\< ${typeArguments
+                    .map((typeArgument) => typeArgument instanceof typedoc_1.ReflectionType
+                    ? this.partials.reflectionType(typeArgument)
+                    : this.partials.someType(typeArgument))
+                    .join(', ')} \\>`;
+            },
         };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.25",
+  "version": "1.0.0-next.26",
   "description": "A Docusaurus plugin to integrate TypeDoc into a Docusaurus project.",
   "main": "dist/index.js",
   "files": [
@@ -16,13 +16,15 @@
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.0.0-next.40"
+    "typedoc-plugin-markdown": ">=4.0.0-next.44"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
     "prepublishOnly": "npm run lint && npm run build",
     "build": "rm -rf ./dist && tsc",
-    "task:docs": "node ./tasks/docs.mjs"
+    "build-and-test": "npm run build && npm run test",
+    "test": "jest",
+    "test:update": "npm test -- -u"
   },
   "author": "Thomas Grey",
   "license": "MIT",
@@ -35,6 +37,6 @@
     "api"
   ],
   "devDependencies": {
-    "@docusaurus/types": "^3.0.0"
+    "@docusaurus/types": "^3.1.1"
   }
 }