@rspress/plugin-typedoc 2.0.0-rc.1 → 2.0.0-rc.3

package/dist/es/index.js

@@ -1,5 +1,6 @@
 import path from "path";
-import { Application, TSConfigReader } from "typedoc";
+import { cwd } from "process";
+import { Application } from "typedoc";
 import { load } from "typedoc-plugin-markdown";
 import promises from "fs/promises";
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
@@ -28,36 +29,10 @@ function _async_to_generator(fn) {
         });
     };
 }
-function patchLinks(outputDir) {
-    return _async_to_generator(function*() {
-        const normalizeLinksInFile = (filePath)=>_async_to_generator(function*() {
-                const content = yield promises.readFile(filePath, 'utf-8');
-                const newContent = content.replace(/\[([^\]]+)\]\(([^)]+)\)/g, (_match, p1, p2)=>{
-                    if ([
-                        '/',
-                        '.'
-                    ].includes(p2[0]) || p2.startsWith('http://') || p2.startsWith('https://')) return `[${p1}](${p2})`;
-                    return `[${p1}](./${p2})`;
-                });
-                yield promises.writeFile(filePath, newContent);
-            })();
-        const traverse = (dir)=>_async_to_generator(function*() {
-                const files = yield promises.readdir(dir);
-                const filePaths = files.map((file)=>path.join(dir, file));
-                const stats = yield Promise.all(filePaths.map((fp)=>promises.stat(fp)));
-                yield Promise.all(stats.map((stat, index)=>{
-                    const file = files[index];
-                    const filePath = filePaths[index];
-                    if (stat.isDirectory()) return traverse(filePath);
-                    if (stat.isFile() && /\.mdx?/.test(file)) return normalizeLinksInFile(filePath);
-                }));
-            })();
-        yield traverse(outputDir);
-    })();
-}
 function generateMetaJson(absoluteApiDir) {
     return _async_to_generator(function*() {
         const metaJsonPath = path.join(absoluteApiDir, '_meta.json');
+        if (yield promises.access(metaJsonPath).then(()=>true).catch(()=>false)) return;
         const files = yield promises.readdir(absoluteApiDir);
         const filePaths = files.map((file)=>path.join(absoluteApiDir, file));
         const stats = yield Promise.all(filePaths.map((fp)=>promises.stat(fp)));
@@ -70,13 +45,11 @@ function generateMetaJson(absoluteApiDir) {
         yield promises.writeFile(metaJsonPath, JSON.stringify([
             'index',
             ...meta
-        ]));
+        ], null, 2));
     })();
 }
 function patchGeneratedApiDocs(absoluteApiDir) {
     return _async_to_generator(function*() {
-        yield patchLinks(absoluteApiDir);
-        yield promises.rename(path.join(absoluteApiDir, 'README.md'), path.join(absoluteApiDir, 'index.md'));
         yield generateMetaJson(absoluteApiDir);
     })();
 }
@@ -107,21 +80,22 @@ function src_async_to_generator(fn) {
     };
 }
 function pluginTypeDoc(options) {
-    let docRoot;
-    const { entryPoints = [], outDir = "api" } = options;
+    const { entryPoints: userEntryPoints = [], outDir = "api", setup = ()=>{} } = options;
+    const entryPoints = userEntryPoints.map((entryPath)=>{
+        if (!path.isAbsolute(entryPath)) return entryPath;
+        const cwdPosix = cwd().replace(/\\/g, '/');
+        const entryPosix = entryPath.replace(/\\/g, '/');
+        return path.posix.relative(cwdPosix, entryPosix);
+    });
     return {
         name: '@rspress/plugin-typedoc',
         config (config) {
             return src_async_to_generator(function*() {
-                const app = new Application();
-                docRoot = config.root;
-                app.options.addReader(new TSConfigReader());
-                load(app);
-                app.bootstrap({
+                let app = yield Application.bootstrapWithPlugins({
                     name: config.title,
                     entryPoints,
-                    theme: 'markdown',
                     disableSources: true,
+                    router: 'kind',
                     readme: 'none',
                     githubPages: false,
                     requiredToBeDocumented: [
@@ -130,16 +104,24 @@ function pluginTypeDoc(options) {
                         'Interface'
                     ],
                     plugin: [
-                        'typedoc-plugin-markdown'
+                        load
                     ],
+                    entryFileName: 'index',
+                    hidePageHeader: true,
                     hideBreadcrumbs: true,
-                    hideMembersSymbol: true,
-                    allReflectionsHaveOwnDocument: true
+                    pageTitleTemplates: {
+                        module: '{kind}: {name}'
+                    },
+                    cleanOutputDir: false
                 });
-                const project = app.convert();
+                app = (yield setup(app)) || app;
+                const project = yield app.convert();
                 if (project) {
-                    const absoluteApiDir = path.join(docRoot, outDir);
-                    yield app.generateDocs(project, absoluteApiDir);
+                    const absoluteApiDir = path.join(config.root, outDir);
+                    yield app.outputs.writeOutput({
+                        name: 'markdown',
+                        path: absoluteApiDir
+                    }, project);
                     yield patchGeneratedApiDocs(absoluteApiDir);
                 }
                 return config;

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import { Application } from 'typedoc';
 import type { RspressPlugin } from '@rspress/core';
 
 export declare function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin;
@@ -13,6 +14,11 @@ export declare interface PluginTypeDocOptions {
      * @default 'api'
      */
     outDir?: string;
+    /**
+     * A function to setup the TypeDoc Application.
+     * @param app
+     */
+    setup?: (app: Application) => Promise<Application> | Promise<void> | void;
 }
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-typedoc",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.3",
   "description": "A plugin for rspress to integrate typedoc",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -28,22 +28,22 @@
     "dist"
   ],
   "dependencies": {
-    "typedoc": "0.24.8",
-    "typedoc-plugin-markdown": "3.17.1"
+    "typedoc": "0.28.15",
+    "typedoc-plugin-markdown": "4.9.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.55.0",
-    "@rslib/core": "0.17.2",
+    "@microsoft/api-extractor": "^7.55.2",
+    "@rslib/core": "0.18.5",
     "@types/node": "^22.8.1",
-    "@types/react": "^19.2.5",
+    "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3",
-    "react": "^19.2.0",
+    "react": "^19.2.3",
     "rsbuild-plugin-publint": "^0.3.3",
     "typescript": "^5.8.2",
     "@rspress/config": "1.0.0"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.0-rc.1"
+    "@rspress/core": "^2.0.0-rc.3"
   },
   "engines": {
     "node": ">=18.0.0"