@rspress/plugin-typedoc 1.42.0 → 1.42.1-canary-20240226

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-typedoc",
-  "version": "1.42.0",
+  "version": "1.42.1-canary-20240226",
   "description": "A plugin for rspress to integrate typedoc",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -19,23 +19,22 @@
   "module": "./dist/es/index.js",
   "types": "./dist/types/index.d.ts",
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "dependencies": {
     "typedoc": "0.24.8",
     "typedoc-plugin-markdown": "3.17.1",
-    "@rspress/shared": "1.42.0"
+    "@rspress/shared": "1.42.1-canary-20240226"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.49.2",
-    "@modern-js/tsconfig": "2.64.0",
-    "@rslib/core": "0.4.1",
+    "@rslib/core": "0.5.2",
     "@types/node": "^18.11.17",
     "@types/react": "^18.3.18",
     "@types/react-dom": "^18.3.5",
     "react": "^18.3.1",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.3",
+    "@rspress/config": "1.0.0"
   },
   "peerDependencies": {
     "rspress": "^1.42.0"
@@ -48,7 +47,6 @@
     "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
-  "jsnext:source": "./src/index.ts",
   "scripts": {
     "build": "rslib build",
     "dev": "rslib build -w",

package/src/constants.ts

@@ -1 +0,0 @@
-export const API_DIR = 'api';

package/src/env.d.ts

@@ -1 +0,0 @@
-/// <reference types='@rslib/core/types' />

package/src/index.ts

@@ -1,103 +0,0 @@
-import path from 'node:path';
-import type { NavItem, RspressPlugin } from '@rspress/shared';
-import { Application, TSConfigReader } from 'typedoc';
-import { load } from 'typedoc-plugin-markdown';
-import { API_DIR } from './constants';
-import { patchGeneratedApiDocs } from './patch';
-
-export interface PluginTypeDocOptions {
-  /**
-   * The entry points of modules.
-   * @default []
-   */
-  entryPoints: string[];
-  /**
-   * The output directory.
-   * @default 'api'
-   */
-  outDir?: string;
-}
-
-export function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {
-  let docRoot: string | undefined;
-  const { entryPoints = [], outDir = API_DIR } = options;
-  const apiPageRoute = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`; // e.g: /api/
-  return {
-    name: '@rspress/plugin-typedoc',
-    async addPages() {
-      return [
-        {
-          routePath: apiPageRoute,
-          filepath: path.join(docRoot!, outDir, 'README.md'),
-        },
-      ];
-    },
-    async config(config) {
-      const app = new Application();
-      docRoot = config.root;
-      app.options.addReader(new TSConfigReader());
-      load(app);
-      app.bootstrap({
-        name: config.title,
-        entryPoints,
-        theme: 'markdown',
-        disableSources: true,
-        readme: 'none',
-        githubPages: false,
-        requiredToBeDocumented: ['Class', 'Function', 'Interface'],
-        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 = path.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: NavItem[]) {
-          return navList.some(item => {
-            if (
-              'link' in item &&
-              typeof item.link === 'string' &&
-              item.link.startsWith(
-                apiPageRoute.slice(0, apiPageRoute.length - 1), // /api
-              )
-            ) {
-              return true;
-            }
-            return false;
-          });
-        }
-
-        // Note: TypeDoc does not support i18n
-        if (Array.isArray(nav)) {
-          if (!isApiAlreadyInNav(nav)) {
-            nav.push({
-              text: 'API',
-              link: apiPageRoute,
-            });
-          }
-        } else if ('default' in nav) {
-          if (!isApiAlreadyInNav(nav.default)) {
-            nav.default.push({
-              text: 'API',
-              link: apiPageRoute,
-            });
-          }
-        }
-      }
-      return config;
-    },
-  };
-}

package/src/patch.ts

@@ -1,72 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-
-async function patchLinks(outputDir: string) {
-  // 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 normalizeLinksInFile = async (filePath: string) => {
-    const content = await fs.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 (['/', '.'].includes(p2[0])) {
-          return `[${p1}](${p2})`;
-        }
-        return `[${p1}](./${p2})`;
-      },
-    );
-    await fs.writeFile(filePath, newContent);
-  };
-
-  const traverse = async (dir: string) => {
-    const files = await fs.readdir(dir);
-    const filePaths = files.map(file => path.join(dir, file));
-    const stats = await Promise.all(filePaths.map(fp => fs.stat(fp)));
-
-    await 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);
-        }
-      }),
-    );
-  };
-  await traverse(outputDir);
-}
-
-async function generateMetaJson(absoluteApiDir: string) {
-  const metaJsonPath = path.join(absoluteApiDir, '_meta.json');
-
-  const files = await fs.readdir(absoluteApiDir);
-  const filePaths = files.map(file => path.join(absoluteApiDir, file));
-  const stats = await Promise.all(filePaths.map(fp => fs.stat(fp)));
-  const dirs = stats
-    .map((stat, index) => (stat.isDirectory() ? files[index] : null))
-    .filter(Boolean) as string[];
-
-  const meta = dirs.map(dir => ({
-    type: 'dir',
-    label: dir.slice(0, 1).toUpperCase() + dir.slice(1),
-    name: dir,
-  }));
-  await fs.writeFile(metaJsonPath, JSON.stringify(['index', ...meta]));
-}
-
-export async function patchGeneratedApiDocs(absoluteApiDir: string) {
-  await patchLinks(absoluteApiDir);
-  await fs.rename(
-    path.join(absoluteApiDir, 'README.md'),
-    path.join(absoluteApiDir, 'index.md'),
-  );
-  await generateMetaJson(absoluteApiDir);
-}

package/src/utils.ts

@@ -1,3 +0,0 @@
-export function transformModuleName(name: string) {
-  return name.replace(/\//g, '_').replace(/-/g, '_');
-}