@rspress/plugin-typedoc 1.38.0 → 1.39.1

package/dist/es/index.mjs

@@ -4,16 +4,9 @@ import * as __WEBPACK_EXTERNAL_MODULE_typedoc_plugin_markdown__ from "typedoc-pl
 import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_fs_extra__ from "@rspress/shared/fs-extra";
 const API_DIR = 'api';
 async function patchLinks(outputDir) {
-    // Patch links in markdown files
-    // Scan all the markdown files in the output directory
-    // replace
-    // 1. [foo](bar) -> [foo](./bar)
-    // 2. [foo](./bar) -> [foo](./bar) no change
     const normlizeLinksInFile = async (filePath)=>{
         const content = await __WEBPACK_EXTERNAL_MODULE__rspress_shared_fs_extra__["default"].readFile(filePath, 'utf-8');
-        // 1. [foo](bar) -> [foo](./bar)
         const newContent = content.replace(/\[([^\]]+)\]\(([^)]+)\)/g, (_match, p1, p2)=>{
-            // 2. [foo](./bar) -> [foo](./bar) no change
             if ([
                 '/',
                 '.'
@@ -59,7 +52,7 @@ async function patchGeneratedApiDocs(absoluteApiDir) {
 function pluginTypeDoc(options) {
     let docRoot;
     const { entryPoints = [], outDir = API_DIR } = options;
-    const apiPageRoute = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`; // e.g: /api/
+    const apiPageRoute = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`;
     return {
         name: '@rspress/plugin-typedoc',
         async addPages () {
@@ -90,29 +83,24 @@ function pluginTypeDoc(options) {
                 plugin: [
                     'typedoc-plugin-markdown'
                 ],
-                // @ts-expect-error MarkdownTheme has no export
                 hideBreadcrumbs: true,
                 hideMembersSymbol: true,
                 allReflectionsHaveOwnDocument: true
             });
             const project = app.convert();
             if (project) {
-                // 1. Generate doc/api, doc/api/_meta.json by typedoc
                 const absoluteApiDir = __WEBPACK_EXTERNAL_MODULE_node_path__["default"].join(docRoot, outDir);
                 await app.generateDocs(project, absoluteApiDir);
                 await patchGeneratedApiDocs(absoluteApiDir);
-                // 2. Generate "api" nav bar
                 config.themeConfig = config.themeConfig || {};
                 config.themeConfig.nav = config.themeConfig.nav || [];
                 const { nav } = config.themeConfig;
-                // avoid that user config "api" in doc/_meta.json
                 function isApiAlreadyInNav(navList) {
                     return navList.some((item)=>{
                         if ('link' in item && 'string' == typeof item.link && item.link.startsWith(apiPageRoute.slice(0, apiPageRoute.length - 1))) return true;
                         return false;
                     });
                 }
-                // Note: TypeDoc does not support i18n
                 if (Array.isArray(nav)) {
                     if (!isApiAlreadyInNav(nav)) nav.push({
                         text: 'API',

package/dist/lib/index.js

@@ -1,9 +1,6 @@
 "use strict";
-// The require scope
 var __webpack_require__ = {};
-/************************************************************************/ // webpack/runtime/compat_get_default_export
 (()=>{
-    // getDefaultExport function for compatibility with non-ESM modules
     __webpack_require__.n = function(module) {
         var getter = module && module.__esModule ? function() {
             return module['default'];
@@ -16,7 +13,6 @@ var __webpack_require__ = {};
         return getter;
     };
 })();
-// webpack/runtime/define_property_getters
 (()=>{
     __webpack_require__.d = function(exports1, definition) {
         for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
@@ -25,15 +21,12 @@ var __webpack_require__ = {};
         });
     };
 })();
-// webpack/runtime/has_own_property
 (()=>{
     __webpack_require__.o = function(obj, prop) {
         return Object.prototype.hasOwnProperty.call(obj, prop);
     };
 })();
-// webpack/runtime/make_namespace_object
 (()=>{
-    // define __esModule on exports
     __webpack_require__.r = function(exports1) {
         if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
             value: 'Module'
@@ -43,12 +36,10 @@ var __webpack_require__ = {};
         });
     };
 })();
-/************************************************************************/ var __webpack_exports__ = {};
-// ESM COMPAT FLAG
+var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
-// EXPORTS
 __webpack_require__.d(__webpack_exports__, {
-    pluginTypeDoc: ()=>/* binding */ pluginTypeDoc
+    pluginTypeDoc: ()=>pluginTypeDoc
 });
 const external_node_path_namespaceObject = require("node:path");
 var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
@@ -58,16 +49,9 @@ const API_DIR = 'api';
 const fs_extra_namespaceObject = require("@rspress/shared/fs-extra");
 var fs_extra_default = /*#__PURE__*/ __webpack_require__.n(fs_extra_namespaceObject);
 async function patchLinks(outputDir) {
-    // Patch links in markdown files
-    // Scan all the markdown files in the output directory
-    // replace
-    // 1. [foo](bar) -> [foo](./bar)
-    // 2. [foo](./bar) -> [foo](./bar) no change
     const normlizeLinksInFile = async (filePath)=>{
         const content = await fs_extra_default().readFile(filePath, 'utf-8');
-        // 1. [foo](bar) -> [foo](./bar)
         const newContent = content.replace(/\[([^\]]+)\]\(([^)]+)\)/g, (_match, p1, p2)=>{
-            // 2. [foo](./bar) -> [foo](./bar) no change
             if ([
                 '/',
                 '.'
@@ -113,7 +97,7 @@ async function patchGeneratedApiDocs(absoluteApiDir) {
 function pluginTypeDoc(options) {
     let docRoot;
     const { entryPoints = [], outDir = API_DIR } = options;
-    const apiPageRoute = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`; // e.g: /api/
+    const apiPageRoute = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`;
     return {
         name: '@rspress/plugin-typedoc',
         async addPages () {
@@ -144,29 +128,24 @@ function pluginTypeDoc(options) {
                 plugin: [
                     'typedoc-plugin-markdown'
                 ],
-                // @ts-expect-error MarkdownTheme has no export
                 hideBreadcrumbs: true,
                 hideMembersSymbol: true,
                 allReflectionsHaveOwnDocument: true
             });
             const project = app.convert();
             if (project) {
-                // 1. Generate doc/api, doc/api/_meta.json by typedoc
                 const absoluteApiDir = external_node_path_default().join(docRoot, outDir);
                 await app.generateDocs(project, absoluteApiDir);
                 await patchGeneratedApiDocs(absoluteApiDir);
-                // 2. Generate "api" nav bar
                 config.themeConfig = config.themeConfig || {};
                 config.themeConfig.nav = config.themeConfig.nav || [];
                 const { nav } = config.themeConfig;
-                // avoid that user config "api" in doc/_meta.json
                 function isApiAlreadyInNav(navList) {
                     return navList.some((item)=>{
                         if ('link' in item && 'string' == typeof item.link && item.link.startsWith(apiPageRoute.slice(0, apiPageRoute.length - 1))) return true;
                         return false;
                     });
                 }
-                // Note: TypeDoc does not support i18n
                 if (Array.isArray(nav)) {
                     if (!isApiAlreadyInNav(nav)) nav.push({
                         text: 'API',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-typedoc",
-  "version": "1.38.0",
+  "version": "1.39.1",
   "description": "A plugin for rspress to integrate typedoc",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -17,18 +17,18 @@
     "node": ">=14.17.6"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.48.0",
-    "@modern-js/tsconfig": "2.63.1",
-    "@rslib/core": "0.1.3",
+    "@microsoft/api-extractor": "^7.48.1",
+    "@modern-js/tsconfig": "2.63.3",
+    "@rslib/core": "0.1.5",
     "@types/node": "^18.11.17",
-    "@types/react": "^18.3.14",
-    "@types/react-dom": "^18.3.2",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
     "react": "^18.3.1",
     "typescript": "^5.5.3",
     "vitest": "2.1.8"
   },
   "peerDependencies": {
-    "rspress": "^1.38.0"
+    "rspress": "^1.39.1"
   },
   "sideEffects": [
     "*.css",
@@ -48,7 +48,7 @@
   "dependencies": {
     "typedoc": "0.24.8",
     "typedoc-plugin-markdown": "3.17.1",
-    "@rspress/shared": "1.38.0"
+    "@rspress/shared": "1.39.1"
   },
   "scripts": {
     "dev": "rslib build -w",