@rspress/plugin-api-docgen 1.37.4 → 1.39.0

package/dist/index.js

@@ -4,25 +4,17 @@ var __webpack_modules__ = {
         module.exports = import("documentation");
     }
 };
-/************************************************************************/ // The module cache
 var __webpack_module_cache__ = {};
-// The require function
 function __webpack_require__(moduleId) {
-    // Check if module is in cache
     var cachedModule = __webpack_module_cache__[moduleId];
     if (void 0 !== cachedModule) return cachedModule.exports;
-    // Create a new module (and put it into the cache)
     var module = __webpack_module_cache__[moduleId] = {
         exports: {}
     };
-    // Execute the module function
     __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
-    // Return the exports of the module
     return module.exports;
 }
-/************************************************************************/ // 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'];
@@ -35,7 +27,6 @@ function __webpack_require__(moduleId) {
         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, {
@@ -44,15 +35,12 @@ function __webpack_require__(moduleId) {
         });
     };
 })();
-// 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'
@@ -62,12 +50,10 @@ function __webpack_require__(moduleId) {
         });
     };
 })();
-/************************************************************************/ var __webpack_exports__ = {};
-// ESM COMPAT FLAG
+var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
-// EXPORTS
 __webpack_require__.d(__webpack_exports__, {
-    pluginApiDocgen: ()=>/* binding */ pluginApiDocgen
+    pluginApiDocgen: ()=>pluginApiDocgen
 });
 const external_node_path_namespaceObject = require("node:path");
 var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
@@ -141,7 +127,6 @@ const docgen = async ({ entries, languages, apiParseTool, appDir, parseToolOptio
                 } else {
                     const { tsconfigPath, compilerOptions, ...restOptions } = (null == parseToolOptions ? void 0 : parseToolOptions['react-docgen-typescript']) ?? {};
                     const parserOpts = {
-                        // https://github.com/styleguidist/react-docgen-typescript/blob/master/README.md?plain=1#L111
                         propFilter: (prop)=>{
                             if (void 0 !== prop.declarations && prop.declarations.length > 0) {
                                 const hasPropAdditionalDescription = prop.declarations.find((declaration)=>!declaration.fileName.includes('node_modules'));
@@ -243,8 +228,7 @@ function generateTable(componentDoc, language) {
                         return description;
                 }
             };
-            const formattedDescription = getDescription() // allow newline
-            .replace(/\n/g, '
');
+            const formattedDescription = getDescription().replace(/\n/g, '
');
             return `|${[
                 name,
                 formattedDescription,
@@ -260,9 +244,7 @@ function generateTable(componentDoc, language) {
     `;
     }).join('\n');
 }
-/**
- * The plugin is used to generate api doc for files.
- */ function pluginApiDocgen(options) {
+function pluginApiDocgen(options) {
     const { entries = {}, apiParseTool = 'react-docgen-typescript', appDir = process.cwd(), parseToolOptions = {} } = options || {};
     return {
         name: '@modern-js/doc-plugin-api-docgen',
@@ -273,7 +255,6 @@ function generateTable(componentDoc, language) {
         },
         async beforeBuild (config, isProd) {
             var _config_themeConfig_locales, _config_themeConfig, _config_locales;
-            // only support zh and en
             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
             ]).filter((lang)=>'zh' === lang || 'en' === lang);
@@ -287,7 +268,6 @@ function generateTable(componentDoc, language) {
             });
         },
         async modifySearchIndexData (pages) {
-            // Update the search index of module doc which includes `<API moduleName="foo" />` and `<API moduleName="foo" ></API>
             const apiCompRegExp = /(<API\s+moduleName=['"](\S+)['"]\s*(.*)?\/>)|(<API\s+moduleName=['"](\S+)['"]\s*(.*)?>(.*)?<\/API>)/;
             await Promise.all(pages.map(async (page)=>{
                 const { _filepath, lang } = page;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-api-docgen",
-  "version": "1.37.4",
+  "version": "1.39.0",
   "description": "A plugin for rspress to generate api doc.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -21,19 +21,18 @@
     "react-docgen-typescript": "2.2.2",
     "react-markdown": "8.0.7",
     "remark-gfm": "3.0.1",
-    "@rspress/shared": "1.37.4"
+    "@rspress/shared": "1.39.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.48.0",
-    "@rslib/core": "0.1.2",
+    "@microsoft/api-extractor": "^7.48.1",
+    "@rslib/core": "0.1.5",
     "@types/mdast": "^4.0.4",
     "@types/node": "^18.11.17",
-    "@types/react": "^18.3.12",
-    "@types/react-dom": "^18.3.1",
-    "mdast-util-mdxjs-esm": "^1.3.1",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "react-router-dom": "^6.28.0",
+    "react-router-dom": "^6.28.1",
     "typescript": "^5.5.3",
     "unified": "^10.1.2",
     "unist-util-visit": "^4.1.2"
@@ -41,7 +40,7 @@
   "peerDependencies": {
     "react": ">=17.0.0",
     "react-router-dom": "^6.8.1",
-    "@rspress/core": "^1.37.4",
+    "@rspress/core": "^1.39.0",
     "typescript": "^5.5.3"
   },
   "peerDependenciesMeta": {