@rspress/plugin-typedoc 2.0.0-beta.0 → 2.0.0-beta.10

package/README.md

@@ -2,4 +2,4 @@
 
 > Typedoc integration plugin for rspress
 
-[Documentation](https://rspress.dev/plugin/official-plugins/typedoc)
+[Documentation](https://rspress.rs/plugin/official-plugins/typedoc)

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@rspress/plugin-typedoc",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.10",
   "description": "A plugin for rspress to integrate typedoc",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/web-infra-dev/rspress",
+    "url": "git+https://github.com/web-infra-dev/rspress.git",
     "directory": "packages/plugin-typedoc"
   },
   "license": "MIT",
@@ -15,7 +15,13 @@
     "*.sass",
     "*.scss"
   ],
-  "main": "./dist/lib/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/es/index.js"
+    }
+  },
   "module": "./dist/es/index.js",
   "types": "./dist/types/index.d.ts",
   "files": [
@@ -24,23 +30,24 @@
   "dependencies": {
     "typedoc": "0.24.8",
     "typedoc-plugin-markdown": "3.17.1",
-    "@rspress/shared": "2.0.0-beta.0"
+    "@rspress/shared": "2.0.0-beta.10"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.4",
-    "@rslib/core": "0.6.5",
-    "@types/node": "^18.11.17",
-    "@types/react": "^18.3.20",
-    "@types/react-dom": "^18.3.6",
+    "@microsoft/api-extractor": "^7.52.8",
+    "@rslib/core": "0.8.0",
+    "@types/node": "^22.8.1",
+    "@types/react": "^18.3.22",
+    "@types/react-dom": "^18.3.7",
     "react": "^19.1.0",
+    "rsbuild-plugin-publint": "^0.3.2",
     "typescript": "^5.8.2",
     "@rspress/config": "1.0.0"
   },
   "peerDependencies": {
-    "rspress": "^2.0.0-beta.0"
+    "rspress": "^2.0.0-beta.10"
   },
   "engines": {
-    "node": ">=14.17.6"
+    "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public",

package/dist/lib/index.js

@@ -1,165 +0,0 @@
-"use strict";
-var __webpack_require__ = {};
-(()=>{
-    __webpack_require__.n = (module)=>{
-        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
-        __webpack_require__.d(getter, {
-            a: getter
-        });
-        return getter;
-    };
-})();
-(()=>{
-    __webpack_require__.d = (exports1, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
-            enumerable: true,
-            get: definition[key]
-        });
-    };
-})();
-(()=>{
-    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
-})();
-(()=>{
-    __webpack_require__.r = (exports1)=>{
-        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
-            value: 'Module'
-        });
-        Object.defineProperty(exports1, '__esModule', {
-            value: true
-        });
-    };
-})();
-var __webpack_exports__ = {};
-__webpack_require__.r(__webpack_exports__);
-__webpack_require__.d(__webpack_exports__, {
-    pluginTypeDoc: ()=>pluginTypeDoc
-});
-const external_node_path_namespaceObject = require("node:path");
-var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
-const external_typedoc_namespaceObject = require("typedoc");
-const external_typedoc_plugin_markdown_namespaceObject = require("typedoc-plugin-markdown");
-const API_DIR = 'api';
-const promises_namespaceObject = require("node:fs/promises");
-var promises_default = /*#__PURE__*/ __webpack_require__.n(promises_namespaceObject);
-async function patchLinks(outputDir) {
-    const normalizeLinksInFile = async (filePath)=>{
-        const content = await promises_default().readFile(filePath, 'utf-8');
-        const newContent = content.replace(/\[([^\]]+)\]\(([^)]+)\)/g, (_match, p1, p2)=>{
-            if ([
-                '/',
-                '.'
-            ].includes(p2[0])) return `[${p1}](${p2})`;
-            return `[${p1}](./${p2})`;
-        });
-        await promises_default().writeFile(filePath, newContent);
-    };
-    const traverse = async (dir)=>{
-        const files = await promises_default().readdir(dir);
-        const filePaths = files.map((file)=>external_node_path_default().join(dir, file));
-        const stats = await Promise.all(filePaths.map((fp)=>promises_default().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) {
-    const metaJsonPath = external_node_path_default().join(absoluteApiDir, '_meta.json');
-    const files = await promises_default().readdir(absoluteApiDir);
-    const filePaths = files.map((file)=>external_node_path_default().join(absoluteApiDir, file));
-    const stats = await Promise.all(filePaths.map((fp)=>promises_default().stat(fp)));
-    const dirs = stats.map((stat, index)=>stat.isDirectory() ? files[index] : null).filter(Boolean);
-    const meta = dirs.map((dir)=>({
-            type: 'dir',
-            label: dir.slice(0, 1).toUpperCase() + dir.slice(1),
-            name: dir
-        }));
-    await promises_default().writeFile(metaJsonPath, JSON.stringify([
-        'index',
-        ...meta
-    ]));
-}
-async function patchGeneratedApiDocs(absoluteApiDir) {
-    await patchLinks(absoluteApiDir);
-    await promises_default().rename(external_node_path_default().join(absoluteApiDir, 'README.md'), external_node_path_default().join(absoluteApiDir, 'index.md'));
-    await generateMetaJson(absoluteApiDir);
-}
-function pluginTypeDoc(options) {
-    let docRoot;
-    const { entryPoints = [], outDir = API_DIR } = options;
-    const apiPageRoute = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`;
-    return {
-        name: '@rspress/plugin-typedoc',
-        async addPages () {
-            return [
-                {
-                    routePath: apiPageRoute,
-                    filepath: external_node_path_default().join(docRoot, outDir, 'README.md')
-                }
-            ];
-        },
-        async config (config) {
-            const app = new external_typedoc_namespaceObject.Application();
-            docRoot = config.root;
-            app.options.addReader(new external_typedoc_namespaceObject.TSConfigReader());
-            (0, external_typedoc_plugin_markdown_namespaceObject.load)(app);
-            app.bootstrap({
-                name: config.title,
-                entryPoints,
-                theme: 'markdown',
-                disableSources: true,
-                readme: 'none',
-                githubPages: false,
-                requiredToBeDocumented: [
-                    'Class',
-                    'Function',
-                    'Interface'
-                ],
-                plugin: [
-                    'typedoc-plugin-markdown'
-                ],
-                hideBreadcrumbs: true,
-                hideMembersSymbol: true,
-                allReflectionsHaveOwnDocument: true
-            });
-            const project = app.convert();
-            if (project) {
-                const absoluteApiDir = external_node_path_default().join(docRoot, outDir);
-                await app.generateDocs(project, absoluteApiDir);
-                await patchGeneratedApiDocs(absoluteApiDir);
-                config.themeConfig = config.themeConfig || {};
-                config.themeConfig.nav = config.themeConfig.nav || [];
-                const { nav } = config.themeConfig;
-                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;
-                    });
-                }
-                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;
-        }
-    };
-}
-exports.pluginTypeDoc = __webpack_exports__.pluginTypeDoc;
-for(var __webpack_i__ in __webpack_exports__)if (-1 === [
-    "pluginTypeDoc"
-].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
-Object.defineProperty(exports, '__esModule', {
-    value: true
-});