@rspress/plugin-api-docgen 1.43.11 → 2.0.0-alpha-canary-202504162001

package/dist/index.js

@@ -15,12 +15,8 @@ function __webpack_require__(moduleId) {
     return module.exports;
 }
 (()=>{
-    __webpack_require__.n = function(module) {
-        var getter = module && module.__esModule ? function() {
-            return module['default'];
-        } : function() {
-            return module;
-        };
+    __webpack_require__.n = (module)=>{
+        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
         __webpack_require__.d(getter, {
             a: getter
         });
@@ -28,7 +24,7 @@ function __webpack_require__(moduleId) {
     };
 })();
 (()=>{
-    __webpack_require__.d = function(exports1, definition) {
+    __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]
@@ -36,12 +32,10 @@ function __webpack_require__(moduleId) {
     };
 })();
 (()=>{
-    __webpack_require__.o = function(obj, prop) {
-        return Object.prototype.hasOwnProperty.call(obj, prop);
-    };
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
 })();
 (()=>{
-    __webpack_require__.r = function(exports1) {
+    __webpack_require__.r = (exports1)=>{
         if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
             value: 'Module'
         });
@@ -60,10 +54,10 @@ var __webpack_exports__ = {};
     var external_node_fs_default = /*#__PURE__*/ __webpack_require__.n(external_node_fs_namespaceObject);
     const external_node_path_namespaceObject = require("node:path");
     var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
+    const logger_namespaceObject = require("@rspress/shared/logger");
     external_node_path_default().join(__dirname, '..');
     const apiDocMap = {};
     const shared_namespaceObject = require("@rspress/shared");
-    const logger_namespaceObject = require("@rspress/shared/logger");
     const external_chokidar_namespaceObject = require("chokidar");
     var external_chokidar_default = /*#__PURE__*/ __webpack_require__.n(external_chokidar_namespaceObject);
     const external_react_docgen_typescript_namespaceObject = require("react-docgen-typescript");
@@ -138,7 +132,7 @@ var __webpack_exports__ = {};
                             ...parseToolOptions.documentation
                         });
                         const apiDoc = await documentation.formats.md(documentationRes, {
-                            noReferenceLinks: (null === (_parseToolOptions_documentation = parseToolOptions.documentation) || void 0 === _parseToolOptions_documentation ? void 0 : _parseToolOptions_documentation.noReferenceLinks) ?? true
+                            noReferenceLinks: (null == (_parseToolOptions_documentation = parseToolOptions.documentation) ? void 0 : _parseToolOptions_documentation.noReferenceLinks) ?? true
                         });
                         apiDocMap[key] = apiDoc;
                     } else {
@@ -272,9 +266,7 @@ var __webpack_exports__ = {};
             },
             async beforeBuild (config, isProd) {
                 var _config_themeConfig_locales, _config_themeConfig, _config_locales;
-                const languages = ((null === (_config_themeConfig = config.themeConfig) || void 0 === _config_themeConfig ? void 0 : null === (_config_themeConfig_locales = _config_themeConfig.locales) || void 0 === _config_themeConfig_locales ? void 0 : _config_themeConfig_locales.map((locale)=>locale.lang)) || (null === (_config_locales = config.locales) || void 0 === _config_locales ? void 0 : _config_locales.map((locale)=>locale.lang)) || [
-                    config.lang || 'en'
-                ]).filter((lang)=>[
+                const languages = ((null == (_config_themeConfig = config.themeConfig) ? void 0 : null == (_config_themeConfig_locales = _config_themeConfig.locales) ? void 0 : _config_themeConfig_locales.map((locale)=>locale.lang)) || (null == (_config_locales = config.locales) ? void 0 : _config_locales.map((locale)=>locale.lang)) || []).filter((lang)=>[
                         'zh',
                         'en',
                         'ru'
@@ -293,14 +285,15 @@ var __webpack_exports__ = {};
                 await Promise.all(pages.map(async (page)=>{
                     const { _filepath, lang } = page;
                     let content = await external_node_fs_default().promises.readFile(_filepath, 'utf-8');
-                    let matchResult = new RegExp(apiCompRegExp).exec(content);
+                    let matchResult = apiCompRegExp.exec(content);
                     if (!matchResult) return;
                     while(null !== matchResult){
                         const matchContent = matchResult[0];
                         const moduleName = matchResult[2] ?? matchResult[5] ?? '';
-                        const apiDoc = apiDocMap[moduleName] ?? apiDocMap[`${moduleName}-${lang}`] ?? '';
+                        const apiDoc = apiDocMap[moduleName] ?? apiDocMap[`${moduleName}-${lang ? lang : 'en'}`] ?? '';
+                        if (matchContent && !apiDoc) logger_namespaceObject.logger.warn(`No api doc found for module: ${moduleName} in lang: ${lang ?? 'en'}`);
                         content = content.replace(matchContent, apiDoc);
-                        matchResult = new RegExp(apiCompRegExp).exec(content);
+                        matchResult = apiCompRegExp.exec(content);
                     }
                     page.content = content;
                 }));
@@ -318,8 +311,10 @@ var __webpack_exports__ = {};
         };
     }
 })();
-var __webpack_export_target__ = exports;
-for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
-if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
+exports.pluginApiDocgen = __webpack_exports__.pluginApiDocgen;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "pluginApiDocgen"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
     value: true
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-api-docgen",
-  "version": "1.43.11",
+  "version": "2.0.0-alpha-canary-202504162001",
   "description": "A plugin for rspress to generate api doc.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -21,29 +21,29 @@
     "chokidar": "^3.6.0",
     "documentation": "14.0.3",
     "react-docgen-typescript": "2.2.2",
-    "react-markdown": "8.0.7",
-    "remark-gfm": "3.0.1",
-    "@rspress/shared": "1.43.11"
+    "react-markdown": "^10.1.0",
+    "remark-gfm": "^4.0.1",
+    "@rspress/shared": "2.0.0-alpha-canary-202504162001"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.49.2",
-    "@rslib/core": "0.5.2",
-    "@types/mdast": "^3.0.15",
+    "@microsoft/api-extractor": "^7.52.3",
+    "@rslib/core": "0.6.3",
+    "@types/mdast": "^4.0.4",
     "@types/node": "^18.11.17",
-    "@types/react": "^18.3.18",
-    "@types/react-dom": "^18.3.5",
+    "@types/react": "^18.3.20",
+    "@types/react-dom": "^18.3.6",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-router-dom": "^6.29.0",
-    "typescript": "^5.5.3",
-    "unified": "^10.1.2",
-    "unist-util-visit": "^4.1.2"
+    "typescript": "^5.8.2",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.0.0"
   },
   "peerDependencies": {
-    "@rspress/core": "^1.43.11",
+    "@rspress/core": "^2.0.0-alpha-canary-202504162001",
     "react": ">=17.0.0",
     "react-router-dom": "^6.8.1",
-    "typescript": "^5.5.3"
+    "typescript": "^5.8.2"
   },
   "peerDependenciesMeta": {
     "typescript": {

package/static/global-components/API.css

@@ -0,0 +1,9 @@
+.rspress-plugin-api-docgen table {
+  table-layout: fixed;
+  width: 100%;
+}
+
+.rspress-plugin-api-docgen table td {
+  /* allow use 
 to break line */
+  white-space: pre-wrap;
+}

package/static/global-components/API.tsx

@@ -4,7 +4,7 @@ import { useLang, usePageData } from '@rspress/core/runtime';
 import { getCustomMDXComponent } from '@rspress/core/theme';
 import ReactMarkdown from 'react-markdown';
 import remarkGfm from 'remark-gfm';
-import './API.scss';
+import './API.css';
 
 export default (props: { moduleName: string }) => {
   const lang = useLang();
@@ -16,13 +16,16 @@ export default (props: { moduleName: string }) => {
   const apiDoc =
     apiDocMap?.[moduleName] || apiDocMap?.[`${moduleName}-${lang}`] || '';
   return (
-    <ReactMarkdown
-      remarkPlugins={[[remarkGfm]]}
-      components={getCustomMDXComponent() as Record<string, React.ElementType>}
-      skipHtml={true}
-      className="rspress-plugin-api-docgen"
-    >
-      {apiDoc}
-    </ReactMarkdown>
+    <div className="rspress-plugin-api-docgen">
+      <ReactMarkdown
+        remarkPlugins={[[remarkGfm]]}
+        components={
+          getCustomMDXComponent() as Record<string, React.ElementType>
+        }
+        skipHtml={true}
+      >
+        {apiDoc}
+      </ReactMarkdown>
+    </div>
   );
 };

package/static/global-components/API.scss

@@ -1,11 +0,0 @@
-.rspress-plugin-api-docgen {
-  table {
-    table-layout: fixed;
-    width: 100%;
-
-    td {
-      // allow use 
 to break line
-      white-space: pre-wrap;
-    }
-  }
-}