@rspress/plugin-api-docgen 1.43.13 → 1.44.0

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
 var __webpack_modules__ = {
     documentation: function(module) {
-        module.exports = import("documentation");
+        module.exports = import("documentation").then(function(module) {
+            return module;
+        });
     }
 };
 var __webpack_module_cache__ = {};
@@ -15,12 +17,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 +26,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 +34,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'
         });
@@ -69,20 +65,20 @@ var __webpack_exports__ = {};
     const external_react_docgen_typescript_namespaceObject = require("react-docgen-typescript");
     const locales = {
         zh: {
-            copy: '复制',
-            copied: '复制成功',
-            expand: '展开代码',
-            collapse: '收起代码',
-            className: '节点类名',
-            style: '节点样式',
-            children: '子节点',
-            disabled: '是否禁用',
-            required: '必填',
-            property: '属性',
-            description: '说明',
-            type: '类型',
-            defaultValue: '默认值',
-            overview: '概览'
+            copy: "\u590D\u5236",
+            copied: "\u590D\u5236\u6210\u529F",
+            expand: "\u5C55\u5F00\u4EE3\u7801",
+            collapse: "\u6536\u8D77\u4EE3\u7801",
+            className: "\u8282\u70B9\u7C7B\u540D",
+            style: "\u8282\u70B9\u6837\u5F0F",
+            children: "\u5B50\u8282\u70B9",
+            disabled: "\u662F\u5426\u7981\u7528",
+            required: "\u5FC5\u586B",
+            property: "\u5C5E\u6027",
+            description: "\u8BF4\u660E",
+            type: "\u7C7B\u578B",
+            defaultValue: "\u9ED8\u8BA4\u503C",
+            overview: "\u6982\u89C8"
         },
         en: {
             copy: 'Copy',
@@ -101,20 +97,20 @@ var __webpack_exports__ = {};
             overview: 'Overview'
         },
         ru: {
-            copy: 'Копировать',
-            copied: 'Скопировано успешно',
-            expand: 'Развернуть код',
-            collapse: 'Свернуть код',
-            className: 'Имя класса узла',
-            style: 'Стиль узла',
-            children: 'Дочерние элементы',
-            disabled: 'Отключено',
-            required: 'Обязательно',
-            property: 'Свойство',
-            description: 'Описание',
-            type: 'Тип',
-            defaultValue: 'Значение по умолчанию',
-            overview: 'Обзор'
+            copy: "\u041A\u043E\u043F\u0438\u0440\u043E\u0432\u0430\u0442\u044C",
+            copied: "\u0421\u043A\u043E\u043F\u0438\u0440\u043E\u0432\u0430\u043D\u043E \u0443\u0441\u043F\u0435\u0448\u043D\u043E",
+            expand: "\u0420\u0430\u0437\u0432\u0435\u0440\u043D\u0443\u0442\u044C \u043A\u043E\u0434",
+            collapse: "\u0421\u0432\u0435\u0440\u043D\u0443\u0442\u044C \u043A\u043E\u0434",
+            className: "\u0418\u043C\u044F \u043A\u043B\u0430\u0441\u0441\u0430 \u0443\u0437\u043B\u0430",
+            style: "\u0421\u0442\u0438\u043B\u044C \u0443\u0437\u043B\u0430",
+            children: "\u0414\u043E\u0447\u0435\u0440\u043D\u0438\u0435 \u044D\u043B\u0435\u043C\u0435\u043D\u0442\u044B",
+            disabled: "\u041E\u0442\u043A\u043B\u044E\u0447\u0435\u043D\u043E",
+            required: "\u041E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u043E",
+            property: "\u0421\u0432\u043E\u0439\u0441\u0442\u0432\u043E",
+            description: "\u041E\u043F\u0438\u0441\u0430\u043D\u0438\u0435",
+            type: "\u0422\u0438\u043F",
+            defaultValue: "\u0417\u043D\u0430\u0447\u0435\u043D\u0438\u0435 \u043F\u043E \u0443\u043C\u043E\u043B\u0447\u0430\u043D\u0438\u044E",
+            overview: "\u041E\u0431\u0437\u043E\u0440"
         }
     };
     const isToolEntries = (obj)=>!!obj.documentation || !!obj["react-docgen-typescript"];
@@ -138,7 +134,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,7 +268,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)) || []).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'
@@ -317,8 +313,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.13",
+  "version": "1.44.0",
   "description": "A plugin for rspress to generate api doc.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -20,14 +20,17 @@
   "dependencies": {
     "chokidar": "^3.6.0",
     "documentation": "14.0.3",
+    "github-slugger": "^2.0.0",
     "react-docgen-typescript": "2.2.2",
     "react-markdown": "8.0.7",
     "remark-gfm": "3.0.1",
-    "@rspress/shared": "1.43.13"
+    "unist-util-visit": "^4.1.2",
+    "@rspress/shared": "1.44.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.49.2",
-    "@rslib/core": "0.5.2",
+    "@rslib/core": "~0.6.9",
+    "@types/hast": "^2.3.10",
     "@types/mdast": "^3.0.15",
     "@types/node": "^18.11.17",
     "@types/react": "^18.3.18",
@@ -36,11 +39,10 @@
     "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"
+    "unified": "^10.1.2"
   },
   "peerDependencies": {
-    "@rspress/core": "^1.43.13",
+    "@rspress/core": "^1.44.0",
     "react": ">=17.0.0",
     "react-router-dom": "^6.8.1",
     "typescript": "^5.5.3"

package/static/global-components/API.tsx

@@ -5,6 +5,97 @@ import { getCustomMDXComponent } from '@rspress/core/theme';
 import ReactMarkdown from 'react-markdown';
 import remarkGfm from 'remark-gfm';
 import './API.scss';
+import GithubSlugger from 'github-slugger';
+import type { Content, Element, Root } from 'hast';
+// biome-ignore lint/style/useImportType: <exact>
+import React from 'react';
+import type { Plugin } from 'unified';
+import { visit } from 'unist-util-visit';
+
+function headingRank(node: Root | Content): number | null {
+  const name =
+    (node && node.type === 'element' && node.tagName.toLowerCase()) || '';
+  const code =
+    name.length === 2 && name.charCodeAt(0) === 104 /* `h` */
+      ? name.charCodeAt(1)
+      : 0;
+  return code > 48 /* `0` */ && code < 55 /* `7` */
+    ? code - 48 /* `0` */
+    : null;
+}
+
+const rehypeHeaderAnchor: Plugin<[], Root> = () => {
+  const slugger = new GithubSlugger();
+  return tree => {
+    visit(tree, 'element', node => {
+      if (!headingRank(node)) {
+        return;
+      }
+      // generate id
+
+      if (!node.properties?.id) {
+        const text = collectHeaderText(node);
+        node.properties ??= {};
+        node.properties.id = slugger.slug(text);
+      }
+      // apply to headings
+      node.children.unshift(create(node));
+    });
+  };
+};
+
+/**
+ * Create an `a`.
+ *
+ * @param {Readonly<Element>} node
+ *   Related heading.
+ * @returns {Element}
+ *   Link.
+ */
+function create(node: Element): Element {
+  return {
+    type: 'element',
+    tagName: 'a',
+    properties: {
+      class: 'header-anchor',
+      ariaHidden: 'true',
+      href: `#${node.properties!.id}`,
+    },
+    children: [
+      {
+        type: 'text',
+        value: '#',
+      },
+    ],
+  };
+}
+
+const extractTextAndId = (title?: string): string => {
+  if (!title) {
+    return '';
+  }
+  const text = title.trimEnd();
+  return text;
+};
+
+const collectHeaderText = (node: Element): string => {
+  let text = '';
+  node.children.forEach(child => {
+    if (child.type === 'text') {
+      const textPart = extractTextAndId(child.value);
+      child.value = textPart;
+      text += textPart;
+    }
+    if (child.type === 'element') {
+      child.children.forEach(c => {
+        if (c.type === 'text') {
+          text += c.value;
+        }
+      });
+    }
+  });
+  return text;
+};
 
 export default (props: { moduleName: string }) => {
   const lang = useLang();
@@ -18,6 +109,7 @@ export default (props: { moduleName: string }) => {
   return (
     <ReactMarkdown
       remarkPlugins={[[remarkGfm]]}
+      rehypePlugins={[[rehypeHeaderAnchor]]}
       components={getCustomMDXComponent() as Record<string, React.ElementType>}
       skipHtml={true}
       className="rspress-plugin-api-docgen"