@rspress/plugin-typedoc 0.1.1 → 0.2.0

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"mappings":";AAAA,OAAOA,WAAU;AACjB,SAASC,aAAaC,sBAAsB;AAE5C,SAASC,YAAY;;;ACHd,IAAMC,UAAU;AAChB,IAAMC,eAAe,IAAID;;;ACDhC,OAAOJ,UAAU;AACjB,OAAOM,QAAQ;;;ACDR,SAASC,oBAAoBC,MAAY;AAC9C,SAAOA,KAAKC,QAAQ,OAAO,KAAKA,QAAQ,MAAM;AAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SDiBeC,WAAWC,WAAiB;SAA5BD;;SAAAA;AAAAA,gBAAf,+BAA0BC,WAAiB;AAIzC,UAAMC;iBAAsB,+BAAOC;AACjC,cAAMC,UAAU,MAAMR,GAAGS,SAASF,UAAU;AAE5C,cAAMG,aAAaF,QAAQL,QACzB,4BACA,CAACQ,QAAQC,IAAIC;AACX,iBAAO,IAAID,SAASC;QACtB;AAEF,cAAMb,GAAGc,UAAUP,UAAUG;MAC/B;sBAVMJ,qBAA6BC;;;;AAYnC,UAAMQ;iBAAW,+BAAOC;AACtB,cAAMC,QAAQ,MAAMjB,GAAGkB,QAAQF;AAC/B,mBAAWG,QAAQF,OAAO;AACxB,gBAAMV,WAAWb,KAAK0B,KAAKJ,KAAKG;AAChC,gBAAME,OAAO,MAAMrB,GAAGqB,KAAKd;AAC3B,cAAIc,KAAKC,YAAW,GAAI;AACtB,kBAAMP,SAASR;UACjB,WAAWc,KAAKE,OAAM,KAAM,SAASC,KAAKL,OAAO;AAC/C,kBAAMb,oBAAoBC;UAC5B;QACF;MACF;sBAXMQ,UAAkBC;;;;AAYxB,UAAMD,SAASV;EACjB;SA7BeD;;AA+Bf,SAAsBqB,6BACpBC,UAAgB;SADID;;SAAAA;AAAAA,kCAAf,+BACLC,UAAgB;AAEhB,UAAMC,SAAyB;AAC/B,UAAMC,OAAOC,KAAKC,MAAM,MAAM9B,GAAGS,SAASiB,UAAU,QAAO;AAC3D,QAAI,CAACE,KAAKG,YAAYH,KAAKG,SAASC,UAAU,GAAG;AAC/C,aAAO;IACT;AACA,UAAMC,YAAY,oBAAIC;AACtBN,SAAKO,OAAOC,QAAQ,CAACC;AACnB,YAAMC,YAA0B;QAC9BC,MAAMF,MAAMG;QACZC,OAAO;MACT;AACAJ,YAAMN,SAASK,QAAQ,CAACM;AACtB,cAAMC,WAAWf,KAAKG,SAASa,KAAK,CAACC,SAAqBA,KAAKH,OAAOA;AACtE,YAAIC,UAAU;AAIZ,cAAIG,WAAWH,SAASzC;AACxB,cAAI+B,UAAUc,IAAIJ,SAASzC,IAAI,GAAG;AAChC,kBAAM8C,QAAQf,UAAUgB,IAAIN,SAASzC,IAAI,IAAK;AAC9C+B,sBAAUiB,IAAIP,SAASzC,MAAM8C;AAC7BF,uBAAW,GAAGH,SAASzC,QAAQ8C;UACjC,OAAO;AACLf,sBAAUiB,IAAIP,SAASzC,KAAKiD,kBAAiB,GAAI;UACnD;AACAb,oBAAUG,MAAMW,KAAK;YACnBb,MAAMI,SAASzC;YACfmD,MAAM,GAAGtD,gBAAgBsC,MAAMG,MAAMW,kBAAiB,KAAML;UAC9D;QACF;MACF;AACAnB,aAAOyB,KAAKd;IACd;AAEA,UAAMlC,WAAWV,KAAK4D,QAAQ5B;AAE9B,WAAOC;EACT;SAxCsBF;;AA0CtB,SAAsB8B,4BACpB7B,UAAgB;SADI6B;;SAAAA;AAAAA,iCAAf,+BACL7B,UAAgB;AAEhB,UAAMC,SAAyB;AAC/B,UAAMC,OAAOC,KAAKC,MAAM,MAAM9B,GAAGS,SAASiB,UAAU,QAAO;AAC3D,QAAI,CAACE,KAAKG,YAAYH,KAAKG,SAASC,UAAU,GAAG;AAC/C,aAAOL;IACT;AAEA,aAAS6B,cAActD,MAAY;AACjC,aAAOR,KACJ0B,KAAK,GAAGrB,wBAAwB,GAAGE,oBAAoBC,OAAO,EAC9DC,QAAQ,OAAO;IACpB;AAEA,aAASsD,aAAaC,YAAoBC,WAAiB;AACzD,aAAOjE,KACJ0B,KACC,GAAGrB,wBACH,GAAGE,oBAAoByD,eAAeC,WAAW,EAElDxD,QAAQ,OAAO;IACpB;AAEA,aAASyD,iBAAiBF,YAAoBG,eAAqB;AACjE,aAAOnE,KACJ0B,KACC,GAAGrB,2BACH,GAAGE,oBAAoByD,eAAeG,eAAe,EAEtD1D,QAAQ,OAAO;IACpB;AAEA,aAAS2D,gBAAgBJ,YAAoBK,cAAoB;AAC/D,aAAOrE,KACJ0B,KACC,GAAGrB,0BACH,GAAGE,oBAAoByD,eAAeK,cAAc,EAErD5D,QAAQ,OAAO;IACpB;AAEAyB,SAAKG,SAASK,QAAQ,CAAC4B;AACrB,YAAMC,cAAcD,OAAO9D,KAAKgE,MAAM;AACtC,YAAMhE,OAAO+D,YAAYA,YAAYjC,SAAS;AAC9C,YAAMmC,eAAe;QACnB5B,MAAM,UAAUrC;QAChBuC,OAAO;UAAC;YAAEF,MAAM;YAAYc,MAAMG,cAAcQ,OAAO9D,IAAI;UAAE;;MAC/D;AACA,UAAI,CAAC8D,OAAOjC,YAAYiC,OAAOjC,SAASC,UAAU,GAAG;AACnD;MACF;AACAgC,aAAOjC,SAASK,QAAQgC;YACHJ;AAAnB,cAAMK,cAAaL,6BAAO7B,OACvBS,KAAKC,UAAQA,KAAKd,SAASuC,SAASF,IAAI1B,EAAE,gBAD1BsB,8DAEfxB,MAAM+B,MAAM,GAAG,EAAC;AACpB,YAAI,CAACF,YAAY;AACf;QACF;AACA,gBAAQA;UACN,KAAK;AACHF,yBAAa1B,MAAMW,KAAK;cACtBb,MAAM,SAAS6B,IAAIlE;cACnBmD,MAAMI,aAAaO,OAAO9D,MAAMkE,IAAIlE,IAAI;YAC1C;AACA;UACF,KAAK;AACHiE,yBAAa1B,MAAMW,KAAK;cACtBb,MAAM,aAAa6B,IAAIlE;cACvBmD,MAAMO,iBAAiBI,OAAO9D,MAAMkE,IAAIlE,IAAI;YAC9C;AACA;UACF,KAAK;AACHiE,yBAAa1B,MAAMW,KAAK;cACtBb,MAAM,YAAY6B,IAAIlE;cACtBmD,MAAMS,gBAAgBE,OAAO9D,MAAMkE,IAAIlE,IAAI;YAC7C;AACA;UACF;AACE;QACJ;MACF;AACAyB,aAAOyB,KAAKe;IACd;AACA,UAAM/D,WAAWV,KAAK4D,QAAQ5B;AAC9B,WAAOC;EACT;SAtFsB4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AFrEf,SAASiB,cAAcC,SAA6B;AACzD,MAAIC;AACJ,QAAM,EAAEC,cAAc,IAAIC,SAAS9E,QAAO,IAAK2E;AAC/C,SAAO;IACLvE,MAAM;IACA2E;aAAWC;AACf,eAAO;UACL;YACEC,WAAW,GAAGH,OAAOzE,QAAQ,OAAO;YACpC6E,UAAUtF,MAAK0B,KAAKsD,SAAUE,QAAQ;UACxC;;MAEJ;;IACMK,OAAOA,QAAM;aAAEH;AACnB,cAAMI,MAAM,IAAIvF;AAChB+E,kBAAUO,OAAOE;AACjBD,YAAIT,QAAQW,UAAU,IAAIxF;AAC1BC,aAAKqF;AACLA,YAAIG,UAAU;UACZnF,MAAM+E,OAAOzC;UACbmC;UACAW,OAAO;UACPC,gBAAgB;UAChBC,QAAQ;UACRC,aAAa;UACbC,wBAAwB;YAAC;YAAS;YAAY;;UAC9CC,QAAQ;YAAC;;;UAETC,iBAAiB;UACjBC,mBAAmB;UACnBC,+BAA+B;QACjC;AACA,cAAMC,UAAUb,IAAIc,QAAO;AAE3B,YAAID,SAAS;AAEX,gBAAME,oBAAoBvG,MAAK0B,KAAKsD,SAAUE;AAC9C,gBAAMM,IAAIgB,aAAaH,SAASE;AAChC,gBAAME,UAAUzG,MAAK0B,KAAK6E,mBAAmB;AAC7C,gBAAMf,IAAIkB,aAAaL,SAASI;AAEhClB,iBAAOoB,cAAcpB,OAAOoB,eAAe,CAAC;AAC5CpB,iBAAOoB,YAAYC,MAAMrB,OAAOoB,YAAYC,OAAO;AACnD,gBAAMC,eAAe,IAAI3B,OAAOzE,QAAQ,eAAe;AACvD8E,iBAAOoB,YAAYC,IAAIlD,KAAK;YAC1Bb,MAAM;YACNc,MAAMkD;UACR;AACAtB,iBAAOoB,YAAYG,UAAUvB,OAAOoB,YAAYG,WAAW,CAAC;AAC5DvB,iBAAOoB,YAAYG,QAAQD,gBACzB5B,YAAY3C,SAAS,IACjB,MAAMuB,4BAA4B4C,WAClC,MAAM1E,6BAA6B0E;AACzClB,iBAAOoB,YAAYG,QAAQD,cAAcE,QAAQ;YAC/ClE,MAAM;YACNc,MAAM,GAAGkD;UACX;QACF;AACAtB,eAAOyB,QAAQzB,OAAOyB,SAAS,CAAC;AAChCzB,eAAOyB,MAAMC,UAAU1B,OAAOyB,MAAMC,WAAW;AAC/C,eAAO1B;MACT;;EACF;AACF;","names":["path","Application","TSConfigReader","load","API_DIR","ROUTE_PREFIX","fs","transformModuleName","name","replace","patchLinks","outputDir","normlizeLinksInFile","filePath","content","readFile","newContent","_match","p1","p2","writeFile","traverse","dir","files","readdir","file","join","stat","isDirectory","isFile","test","resolveSidebarForSingleEntry","jsonFile","result","data","JSON","parse","children","length","symbolMap","Map","groups","forEach","group","groupItem","text","title","items","id","dataItem","find","item","fileName","has","count","get","set","toLocaleLowerCase","push","link","dirname","resolveSidebarForMultiEntry","getModulePath","getClassPath","moduleName","className","getInterfacePath","interfaceName","getFunctionPath","functionName","module","moduleNames","split","moduleConfig","sub","kindString","includes","slice","pluginTypeDoc","options","docRoot","entryPoints","outDir","addPages","_async_to_generator","routePath","filepath","config","app","root","addReader","bootstrap","theme","disableSources","readme","githubPages","requiredToBeDocumented","plugin","hideBreadcrumbs","hideMembersSymbol","allReflectionsHaveOwnDocument","project","convert","absoluteOutputdir","generateDocs","jsonDir","generateJson","themeConfig","nav","apiIndexLink","sidebar","unshift","route","exclude"],"sources":["../../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/index.ts","../../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/constants.ts","../../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/sidebar.ts","../../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/utils.ts"],"sourcesContent":["import path from 'path';\nimport { Application, TSConfigReader } from 'typedoc';\nimport type { RspressPlugin } from '@rspress/shared';\nimport { load } from 'typedoc-plugin-markdown';\nimport { API_DIR } from './constants';\nimport {\n  resolveSidebarForMultiEntry,\n  resolveSidebarForSingleEntry,\n} from './sidebar';\n\nexport interface PluginTypeDocOptions {\n  /**\n   * The entry points of modules.\n   * @default []\n   */\n  entryPoints: string[];\n  /**\n   * The output directory.\n   * @default 'api'\n   */\n  outDir?: string;\n}\n\nexport function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {\n  let docRoot: string | undefined;\n  const { entryPoints = [], outDir = API_DIR } = options;\n  return {\n    name: '@rspress/plugin-typedoc',\n    async addPages() {\n      return [\n        {\n          routePath: `${outDir.replace(/\\/$/, '')}/`,\n          filepath: path.join(docRoot!, outDir, 'README.md'),\n        },\n      ];\n    },\n    async config(config) {\n      const app = new Application();\n      docRoot = config.root;\n      app.options.addReader(new TSConfigReader());\n      load(app);\n      app.bootstrap({\n        name: config.title,\n        entryPoints,\n        theme: 'markdown',\n        disableSources: true,\n        readme: 'none',\n        githubPages: false,\n        requiredToBeDocumented: ['Class', 'Function', 'Interface'],\n        plugin: ['typedoc-plugin-markdown'],\n        // @ts-expect-error MarkdownTheme has no export\n        hideBreadcrumbs: true,\n        hideMembersSymbol: true,\n        allReflectionsHaveOwnDocument: true,\n      });\n      const project = app.convert();\n\n      if (project) {\n        // 1. Generate module doc by typedoc\n        const absoluteOutputdir = path.join(docRoot!, outDir);\n        await app.generateDocs(project, absoluteOutputdir);\n        const jsonDir = path.join(absoluteOutputdir, 'documentation.json');\n        await app.generateJson(project, jsonDir);\n        // 2. Generate sidebar\n        config.themeConfig = config.themeConfig || {};\n        config.themeConfig.nav = config.themeConfig.nav || [];\n        const apiIndexLink = `/${outDir.replace(/(^\\/)|(\\/$)/, '')}/`;\n        config.themeConfig.nav.push({\n          text: 'API',\n          link: apiIndexLink,\n        });\n        config.themeConfig.sidebar = config.themeConfig.sidebar || {};\n        config.themeConfig.sidebar[apiIndexLink] =\n          entryPoints.length > 1\n            ? await resolveSidebarForMultiEntry(jsonDir)\n            : await resolveSidebarForSingleEntry(jsonDir);\n        config.themeConfig.sidebar[apiIndexLink].unshift({\n          text: 'Overview',\n          link: `${apiIndexLink}README`,\n        });\n      }\n      config.route = config.route || {};\n      config.route.exclude = config.route.exclude || [];\n      return config;\n    },\n  };\n}\n","export const API_DIR = 'api';\nexport const ROUTE_PREFIX = `/${API_DIR}`;\n","import path from 'path';\nimport fs from '@modern-js/utils/fs-extra';\nimport type { SidebarGroup } from '@rspress/shared';\nimport { transformModuleName } from './utils';\nimport { ROUTE_PREFIX } from './constants';\n\ninterface ModuleItem {\n  id: number;\n  name: string;\n  children: {\n    id: number;\n    name: string;\n  }[];\n  groups: {\n    title: string;\n    children: number[];\n  }[];\n}\n\nasync function patchLinks(outputDir: string) {\n  // Patch links in markdown files\n  // Scan all the markdown files in the output directory\n  // replace [xxx](yyy) -> [xxx](./yyy)\n  const normlizeLinksInFile = async (filePath: string) => {\n    const content = await fs.readFile(filePath, 'utf-8');\n    // replace: [xxx](yyy) -> [xxx](./yyy)\n    const newContent = content.replace(\n      /\\[([^\\]]+)\\]\\(([^)]+)\\)/g,\n      (_match, p1, p2) => {\n        return `[${p1}](./${p2})`;\n      },\n    );\n    await fs.writeFile(filePath, newContent);\n  };\n\n  const traverse = async (dir: string) => {\n    const files = await fs.readdir(dir);\n    for (const file of files) {\n      const filePath = path.join(dir, file);\n      const stat = await fs.stat(filePath);\n      if (stat.isDirectory()) {\n        await traverse(filePath);\n      } else if (stat.isFile() && /\\.mdx?/.test(file)) {\n        await normlizeLinksInFile(filePath);\n      }\n    }\n  };\n  await traverse(outputDir);\n}\n\nexport async function resolveSidebarForSingleEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return [];\n  }\n  const symbolMap = new Map<string, number>();\n  data.groups.forEach((group: { title: string; children: number[] }) => {\n    const groupItem: SidebarGroup = {\n      text: group.title,\n      items: [],\n    };\n    group.children.forEach((id: number) => {\n      const dataItem = data.children.find((item: ModuleItem) => item.id === id);\n      if (dataItem) {\n        // Note: we should handle the case that classes and interfaces have the same name\n        // Such as class `Env` and variable `env`\n        // The final output file name should be `classes/Env.md` and `variables/env-1.md`\n        let fileName = dataItem.name;\n        if (symbolMap.has(dataItem.name)) {\n          const count = symbolMap.get(dataItem.name)! + 1;\n          symbolMap.set(dataItem.name, count);\n          fileName = `${dataItem.name}-${count}`;\n        } else {\n          symbolMap.set(dataItem.name.toLocaleLowerCase(), 0);\n        }\n        groupItem.items.push({\n          text: dataItem.name,\n          link: `${ROUTE_PREFIX}/${group.title.toLocaleLowerCase()}/${fileName}`,\n        });\n      }\n    });\n    result.push(groupItem);\n  });\n\n  await patchLinks(path.dirname(jsonFile));\n\n  return result;\n}\n\nexport async function resolveSidebarForMultiEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return result;\n  }\n\n  function getModulePath(name: string) {\n    return path\n      .join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`)\n      .replace(/\\\\/g, '/');\n  }\n\n  function getClassPath(moduleName: string, className: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/classes`,\n        `${transformModuleName(moduleName)}.${className}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getInterfacePath(moduleName: string, interfaceName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/interfaces`,\n        `${transformModuleName(moduleName)}.${interfaceName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getFunctionPath(moduleName: string, functionName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/functions`,\n        `${transformModuleName(moduleName)}.${functionName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  data.children.forEach((module: ModuleItem) => {\n    const moduleNames = module.name.split('/');\n    const name = moduleNames[moduleNames.length - 1];\n    const moduleConfig = {\n      text: `Module:${name}`,\n      items: [{ text: 'Overview', link: getModulePath(module.name) }],\n    };\n    if (!module.children || module.children.length <= 0) {\n      return;\n    }\n    module.children.forEach(sub => {\n      const kindString = module.groups\n        .find(item => item.children.includes(sub.id))\n        ?.title.slice(0, -1);\n      if (!kindString) {\n        return;\n      }\n      switch (kindString) {\n        case 'Class':\n          moduleConfig.items.push({\n            text: `Class:${sub.name}`,\n            link: getClassPath(module.name, sub.name),\n          });\n          break;\n        case 'Interface':\n          moduleConfig.items.push({\n            text: `Interface:${sub.name}`,\n            link: getInterfacePath(module.name, sub.name),\n          });\n          break;\n        case 'Function':\n          moduleConfig.items.push({\n            text: `Function:${sub.name}`,\n            link: getFunctionPath(module.name, sub.name),\n          });\n          break;\n        default:\n          break;\n      }\n    });\n    result.push(moduleConfig);\n  });\n  await patchLinks(path.dirname(jsonFile));\n  return result;\n}\n","export function transformModuleName(name: string) {\n  return name.replace(/\\//g, '_').replace(/-/g, '_');\n}\n"]}

package/dist/lib/index.d.ts

@@ -0,0 +1,17 @@
+import { RspressPlugin } from '@rspress/shared';
+
+interface PluginTypeDocOptions {
+    /**
+     * The entry points of modules.
+     * @default []
+     */
+    entryPoints: string[];
+    /**
+     * The output directory.
+     * @default 'api'
+     */
+    outDir?: string;
+}
+declare function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin;
+
+export { PluginTypeDocOptions, pluginTypeDoc };

package/dist/lib/index.js

@@ -0,0 +1,278 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  pluginTypeDoc: () => pluginTypeDoc
+});
+module.exports = __toCommonJS(src_exports);
+var import_path2 = __toESM(require("path"));
+var import_typedoc = require("typedoc");
+var import_typedoc_plugin_markdown = require("typedoc-plugin-markdown");
+
+// src/constants.ts
+var API_DIR = "api";
+var ROUTE_PREFIX = `/${API_DIR}`;
+
+// src/sidebar.ts
+var import_path = __toESM(require("path"));
+var import_fs_extra = __toESM(require("@modern-js/utils/fs-extra"));
+
+// src/utils.ts
+function transformModuleName(name) {
+  return name.replace(/\//g, "_").replace(/-/g, "_");
+}
+
+// src/sidebar.ts
+function patchLinks(outputDir) {
+  return __async(this, null, function* () {
+    const normlizeLinksInFile = (filePath) => __async(this, null, function* () {
+      const content = yield import_fs_extra.default.readFile(filePath, "utf-8");
+      const newContent = content.replace(
+        /\[([^\]]+)\]\(([^)]+)\)/g,
+        (_match, p1, p2) => {
+          return `[${p1}](./${p2})`;
+        }
+      );
+      yield import_fs_extra.default.writeFile(filePath, newContent);
+    });
+    const traverse = (dir) => __async(this, null, function* () {
+      const files = yield import_fs_extra.default.readdir(dir);
+      for (const file of files) {
+        const filePath = import_path.default.join(dir, file);
+        const stat = yield import_fs_extra.default.stat(filePath);
+        if (stat.isDirectory()) {
+          yield traverse(filePath);
+        } else if (stat.isFile() && /\.mdx?/.test(file)) {
+          yield normlizeLinksInFile(filePath);
+        }
+      }
+    });
+    yield traverse(outputDir);
+  });
+}
+function resolveSidebarForSingleEntry(jsonFile) {
+  return __async(this, null, function* () {
+    const result = [];
+    const data = JSON.parse(yield import_fs_extra.default.readFile(jsonFile, "utf-8"));
+    if (!data.children || data.children.length <= 0) {
+      return [];
+    }
+    const symbolMap = /* @__PURE__ */ new Map();
+    data.groups.forEach((group) => {
+      const groupItem = {
+        text: group.title,
+        items: []
+      };
+      group.children.forEach((id) => {
+        const dataItem = data.children.find((item) => item.id === id);
+        if (dataItem) {
+          let fileName = dataItem.name;
+          if (symbolMap.has(dataItem.name)) {
+            const count = symbolMap.get(dataItem.name) + 1;
+            symbolMap.set(dataItem.name, count);
+            fileName = `${dataItem.name}-${count}`;
+          } else {
+            symbolMap.set(dataItem.name.toLocaleLowerCase(), 0);
+          }
+          groupItem.items.push({
+            text: dataItem.name,
+            link: `${ROUTE_PREFIX}/${group.title.toLocaleLowerCase()}/${fileName}`
+          });
+        }
+      });
+      result.push(groupItem);
+    });
+    yield patchLinks(import_path.default.dirname(jsonFile));
+    return result;
+  });
+}
+function resolveSidebarForMultiEntry(jsonFile) {
+  return __async(this, null, function* () {
+    const result = [];
+    const data = JSON.parse(yield import_fs_extra.default.readFile(jsonFile, "utf-8"));
+    if (!data.children || data.children.length <= 0) {
+      return result;
+    }
+    function getModulePath(name) {
+      return import_path.default.join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`).replace(/\\/g, "/");
+    }
+    function getClassPath(moduleName, className) {
+      return import_path.default.join(
+        `${ROUTE_PREFIX}/classes`,
+        `${transformModuleName(moduleName)}.${className}`
+      ).replace(/\\/g, "/");
+    }
+    function getInterfacePath(moduleName, interfaceName) {
+      return import_path.default.join(
+        `${ROUTE_PREFIX}/interfaces`,
+        `${transformModuleName(moduleName)}.${interfaceName}`
+      ).replace(/\\/g, "/");
+    }
+    function getFunctionPath(moduleName, functionName) {
+      return import_path.default.join(
+        `${ROUTE_PREFIX}/functions`,
+        `${transformModuleName(moduleName)}.${functionName}`
+      ).replace(/\\/g, "/");
+    }
+    data.children.forEach((module2) => {
+      const moduleNames = module2.name.split("/");
+      const name = moduleNames[moduleNames.length - 1];
+      const moduleConfig = {
+        text: `Module:${name}`,
+        items: [{ text: "Overview", link: getModulePath(module2.name) }]
+      };
+      if (!module2.children || module2.children.length <= 0) {
+        return;
+      }
+      module2.children.forEach((sub) => {
+        var _a;
+        const kindString = (_a = module2.groups.find((item) => item.children.includes(sub.id))) == null ? void 0 : _a.title.slice(0, -1);
+        if (!kindString) {
+          return;
+        }
+        switch (kindString) {
+          case "Class":
+            moduleConfig.items.push({
+              text: `Class:${sub.name}`,
+              link: getClassPath(module2.name, sub.name)
+            });
+            break;
+          case "Interface":
+            moduleConfig.items.push({
+              text: `Interface:${sub.name}`,
+              link: getInterfacePath(module2.name, sub.name)
+            });
+            break;
+          case "Function":
+            moduleConfig.items.push({
+              text: `Function:${sub.name}`,
+              link: getFunctionPath(module2.name, sub.name)
+            });
+            break;
+          default:
+            break;
+        }
+      });
+      result.push(moduleConfig);
+    });
+    yield patchLinks(import_path.default.dirname(jsonFile));
+    return result;
+  });
+}
+
+// src/index.ts
+function pluginTypeDoc(options) {
+  let docRoot;
+  const { entryPoints = [], outDir = API_DIR } = options;
+  return {
+    name: "@rspress/plugin-typedoc",
+    addPages() {
+      return __async(this, null, function* () {
+        return [
+          {
+            routePath: `${outDir.replace(/\/$/, "")}/`,
+            filepath: import_path2.default.join(docRoot, outDir, "README.md")
+          }
+        ];
+      });
+    },
+    config(config) {
+      return __async(this, null, function* () {
+        const app = new import_typedoc.Application();
+        docRoot = config.root;
+        app.options.addReader(new import_typedoc.TSConfigReader());
+        (0, import_typedoc_plugin_markdown.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) {
+          const absoluteOutputdir = import_path2.default.join(docRoot, outDir);
+          yield app.generateDocs(project, absoluteOutputdir);
+          const jsonDir = import_path2.default.join(absoluteOutputdir, "documentation.json");
+          yield app.generateJson(project, jsonDir);
+          config.themeConfig = config.themeConfig || {};
+          config.themeConfig.nav = config.themeConfig.nav || [];
+          const apiIndexLink = `/${outDir.replace(/(^\/)|(\/$)/, "")}/`;
+          config.themeConfig.nav.push({
+            text: "API",
+            link: apiIndexLink
+          });
+          config.themeConfig.sidebar = config.themeConfig.sidebar || {};
+          config.themeConfig.sidebar[apiIndexLink] = entryPoints.length > 1 ? yield resolveSidebarForMultiEntry(jsonDir) : yield resolveSidebarForSingleEntry(jsonDir);
+          config.themeConfig.sidebar[apiIndexLink].unshift({
+            text: "Overview",
+            link: `${apiIndexLink}README`
+          });
+        }
+        config.route = config.route || {};
+        config.route.exclude = config.route.exclude || [];
+        return config;
+      });
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pluginTypeDoc
+});
+
+//# sourceMappingURL=index.js.map

package/dist/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAiB;AACjB,qBAA4C;AAE5C,qCAAqB;;;ACHd,IAAM,UAAU;AAChB,IAAM,eAAe,IAAI;;;ACDhC,kBAAiB;AACjB,sBAAe;;;ACDR,SAAS,oBAAoB,MAAc;AAChD,SAAO,KAAK,QAAQ,OAAO,GAAG,EAAE,QAAQ,MAAM,GAAG;AACnD;;;ADiBA,SAAe,WAAW,WAAmB;AAAA;AAI3C,UAAM,sBAAsB,CAAO,aAAqB;AACtD,YAAM,UAAU,MAAM,wBAAG,SAAS,UAAU,OAAO;AAEnD,YAAM,aAAa,QAAQ;AAAA,QACzB;AAAA,QACA,CAAC,QAAQ,IAAI,OAAO;AAClB,iBAAO,IAAI,SAAS;AAAA,QACtB;AAAA,MACF;AACA,YAAM,wBAAG,UAAU,UAAU,UAAU;AAAA,IACzC;AAEA,UAAM,WAAW,CAAO,QAAgB;AACtC,YAAM,QAAQ,MAAM,wBAAG,QAAQ,GAAG;AAClC,iBAAW,QAAQ,OAAO;AACxB,cAAM,WAAW,oBAAK,KAAK,KAAK,IAAI;AACpC,cAAM,OAAO,MAAM,wBAAG,KAAK,QAAQ;AACnC,YAAI,KAAK,YAAY,GAAG;AACtB,gBAAM,SAAS,QAAQ;AAAA,QACzB,WAAW,KAAK,OAAO,KAAK,SAAS,KAAK,IAAI,GAAG;AAC/C,gBAAM,oBAAoB,QAAQ;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AACA,UAAM,SAAS,SAAS;AAAA,EAC1B;AAAA;AAEA,SAAsB,6BACpB,UACyB;AAAA;AACzB,UAAM,SAAyB,CAAC;AAChC,UAAM,OAAO,KAAK,MAAM,MAAM,wBAAG,SAAS,UAAU,OAAO,CAAC;AAC5D,QAAI,CAAC,KAAK,YAAY,KAAK,SAAS,UAAU,GAAG;AAC/C,aAAO,CAAC;AAAA,IACV;AACA,UAAM,YAAY,oBAAI,IAAoB;AAC1C,SAAK,OAAO,QAAQ,CAAC,UAAiD;AACpE,YAAM,YAA0B;AAAA,QAC9B,MAAM,MAAM;AAAA,QACZ,OAAO,CAAC;AAAA,MACV;AACA,YAAM,SAAS,QAAQ,CAAC,OAAe;AACrC,cAAM,WAAW,KAAK,SAAS,KAAK,CAAC,SAAqB,KAAK,OAAO,EAAE;AACxE,YAAI,UAAU;AAIZ,cAAI,WAAW,SAAS;AACxB,cAAI,UAAU,IAAI,SAAS,IAAI,GAAG;AAChC,kBAAM,QAAQ,UAAU,IAAI,SAAS,IAAI,IAAK;AAC9C,sBAAU,IAAI,SAAS,MAAM,KAAK;AAClC,uBAAW,GAAG,SAAS,QAAQ;AAAA,UACjC,OAAO;AACL,sBAAU,IAAI,SAAS,KAAK,kBAAkB,GAAG,CAAC;AAAA,UACpD;AACA,oBAAU,MAAM,KAAK;AAAA,YACnB,MAAM,SAAS;AAAA,YACf,MAAM,GAAG,gBAAgB,MAAM,MAAM,kBAAkB,KAAK;AAAA,UAC9D,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AACD,aAAO,KAAK,SAAS;AAAA,IACvB,CAAC;AAED,UAAM,WAAW,oBAAK,QAAQ,QAAQ,CAAC;AAEvC,WAAO;AAAA,EACT;AAAA;AAEA,SAAsB,4BACpB,UACyB;AAAA;AACzB,UAAM,SAAyB,CAAC;AAChC,UAAM,OAAO,KAAK,MAAM,MAAM,wBAAG,SAAS,UAAU,OAAO,CAAC;AAC5D,QAAI,CAAC,KAAK,YAAY,KAAK,SAAS,UAAU,GAAG;AAC/C,aAAO;AAAA,IACT;AAEA,aAAS,cAAc,MAAc;AACnC,aAAO,oBACJ,KAAK,GAAG,wBAAwB,GAAG,oBAAoB,IAAI,GAAG,EAC9D,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,aAAa,YAAoB,WAAmB;AAC3D,aAAO,oBACJ;AAAA,QACC,GAAG;AAAA,QACH,GAAG,oBAAoB,UAAU,KAAK;AAAA,MACxC,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,iBAAiB,YAAoB,eAAuB;AACnE,aAAO,oBACJ;AAAA,QACC,GAAG;AAAA,QACH,GAAG,oBAAoB,UAAU,KAAK;AAAA,MACxC,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,gBAAgB,YAAoB,cAAsB;AACjE,aAAO,oBACJ;AAAA,QACC,GAAG;AAAA,QACH,GAAG,oBAAoB,UAAU,KAAK;AAAA,MACxC,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,SAAK,SAAS,QAAQ,CAACA,YAAuB;AAC5C,YAAM,cAAcA,QAAO,KAAK,MAAM,GAAG;AACzC,YAAM,OAAO,YAAY,YAAY,SAAS,CAAC;AAC/C,YAAM,eAAe;AAAA,QACnB,MAAM,UAAU;AAAA,QAChB,OAAO,CAAC,EAAE,MAAM,YAAY,MAAM,cAAcA,QAAO,IAAI,EAAE,CAAC;AAAA,MAChE;AACA,UAAI,CAACA,QAAO,YAAYA,QAAO,SAAS,UAAU,GAAG;AACnD;AAAA,MACF;AACA,cAAO,SAAS,QAAQ,SAAO;AAhJnC;AAiJM,cAAM,cAAa,aAAO,OACvB,KAAK,UAAQ,KAAK,SAAS,SAAS,IAAI,EAAE,CAAC,MAD3B,mBAEf,MAAM,MAAM,GAAG;AACnB,YAAI,CAAC,YAAY;AACf;AAAA,QACF;AACA,gBAAQ,YAAY;AAAA,UAClB,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,SAAS,IAAI;AAAA,cACnB,MAAM,aAAaA,QAAO,MAAM,IAAI,IAAI;AAAA,YAC1C,CAAC;AACD;AAAA,UACF,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,aAAa,IAAI;AAAA,cACvB,MAAM,iBAAiBA,QAAO,MAAM,IAAI,IAAI;AAAA,YAC9C,CAAC;AACD;AAAA,UACF,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,YAAY,IAAI;AAAA,cACtB,MAAM,gBAAgBA,QAAO,MAAM,IAAI,IAAI;AAAA,YAC7C,CAAC;AACD;AAAA,UACF;AACE;AAAA,QACJ;AAAA,MACF,CAAC;AACD,aAAO,KAAK,YAAY;AAAA,IAC1B,CAAC;AACD,UAAM,WAAW,oBAAK,QAAQ,QAAQ,CAAC;AACvC,WAAO;AAAA,EACT;AAAA;;;AF3JO,SAAS,cAAc,SAA8C;AAC1E,MAAI;AACJ,QAAM,EAAE,cAAc,CAAC,GAAG,SAAS,QAAQ,IAAI;AAC/C,SAAO;AAAA,IACL,MAAM;AAAA,IACA,WAAW;AAAA;AACf,eAAO;AAAA,UACL;AAAA,YACE,WAAW,GAAG,OAAO,QAAQ,OAAO,EAAE;AAAA,YACtC,UAAU,qBAAK,KAAK,SAAU,QAAQ,WAAW;AAAA,UACnD;AAAA,QACF;AAAA,MACF;AAAA;AAAA,IACM,OAAO,QAAQ;AAAA;AACnB,cAAM,MAAM,IAAI,2BAAY;AAC5B,kBAAU,OAAO;AACjB,YAAI,QAAQ,UAAU,IAAI,8BAAe,CAAC;AAC1C,iDAAK,GAAG;AACR,YAAI,UAAU;AAAA,UACZ,MAAM,OAAO;AAAA,UACb;AAAA,UACA,OAAO;AAAA,UACP,gBAAgB;AAAA,UAChB,QAAQ;AAAA,UACR,aAAa;AAAA,UACb,wBAAwB,CAAC,SAAS,YAAY,WAAW;AAAA,UACzD,QAAQ,CAAC,yBAAyB;AAAA;AAAA,UAElC,iBAAiB;AAAA,UACjB,mBAAmB;AAAA,UACnB,+BAA+B;AAAA,QACjC,CAAC;AACD,cAAM,UAAU,IAAI,QAAQ;AAE5B,YAAI,SAAS;AAEX,gBAAM,oBAAoB,qBAAK,KAAK,SAAU,MAAM;AACpD,gBAAM,IAAI,aAAa,SAAS,iBAAiB;AACjD,gBAAM,UAAU,qBAAK,KAAK,mBAAmB,oBAAoB;AACjE,gBAAM,IAAI,aAAa,SAAS,OAAO;AAEvC,iBAAO,cAAc,OAAO,eAAe,CAAC;AAC5C,iBAAO,YAAY,MAAM,OAAO,YAAY,OAAO,CAAC;AACpD,gBAAM,eAAe,IAAI,OAAO,QAAQ,eAAe,EAAE;AACzD,iBAAO,YAAY,IAAI,KAAK;AAAA,YAC1B,MAAM;AAAA,YACN,MAAM;AAAA,UACR,CAAC;AACD,iBAAO,YAAY,UAAU,OAAO,YAAY,WAAW,CAAC;AAC5D,iBAAO,YAAY,QAAQ,YAAY,IACrC,YAAY,SAAS,IACjB,MAAM,4BAA4B,OAAO,IACzC,MAAM,6BAA6B,OAAO;AAChD,iBAAO,YAAY,QAAQ,YAAY,EAAE,QAAQ;AAAA,YAC/C,MAAM;AAAA,YACN,MAAM,GAAG;AAAA,UACX,CAAC;AAAA,QACH;AACA,eAAO,QAAQ,OAAO,SAAS,CAAC;AAChC,eAAO,MAAM,UAAU,OAAO,MAAM,WAAW,CAAC;AAChD,eAAO;AAAA,MACT;AAAA;AAAA,EACF;AACF;","names":["module"],"sources":["../../src/index.ts","../../src/constants.ts","../../src/sidebar.ts","../../src/utils.ts"],"sourcesContent":["import path from 'path';\nimport { Application, TSConfigReader } from 'typedoc';\nimport type { RspressPlugin } from '@rspress/shared';\nimport { load } from 'typedoc-plugin-markdown';\nimport { API_DIR } from './constants';\nimport {\n  resolveSidebarForMultiEntry,\n  resolveSidebarForSingleEntry,\n} from './sidebar';\n\nexport interface PluginTypeDocOptions {\n  /**\n   * The entry points of modules.\n   * @default []\n   */\n  entryPoints: string[];\n  /**\n   * The output directory.\n   * @default 'api'\n   */\n  outDir?: string;\n}\n\nexport function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {\n  let docRoot: string | undefined;\n  const { entryPoints = [], outDir = API_DIR } = options;\n  return {\n    name: '@rspress/plugin-typedoc',\n    async addPages() {\n      return [\n        {\n          routePath: `${outDir.replace(/\\/$/, '')}/`,\n          filepath: path.join(docRoot!, outDir, 'README.md'),\n        },\n      ];\n    },\n    async config(config) {\n      const app = new Application();\n      docRoot = config.root;\n      app.options.addReader(new TSConfigReader());\n      load(app);\n      app.bootstrap({\n        name: config.title,\n        entryPoints,\n        theme: 'markdown',\n        disableSources: true,\n        readme: 'none',\n        githubPages: false,\n        requiredToBeDocumented: ['Class', 'Function', 'Interface'],\n        plugin: ['typedoc-plugin-markdown'],\n        // @ts-expect-error MarkdownTheme has no export\n        hideBreadcrumbs: true,\n        hideMembersSymbol: true,\n        allReflectionsHaveOwnDocument: true,\n      });\n      const project = app.convert();\n\n      if (project) {\n        // 1. Generate module doc by typedoc\n        const absoluteOutputdir = path.join(docRoot!, outDir);\n        await app.generateDocs(project, absoluteOutputdir);\n        const jsonDir = path.join(absoluteOutputdir, 'documentation.json');\n        await app.generateJson(project, jsonDir);\n        // 2. Generate sidebar\n        config.themeConfig = config.themeConfig || {};\n        config.themeConfig.nav = config.themeConfig.nav || [];\n        const apiIndexLink = `/${outDir.replace(/(^\\/)|(\\/$)/, '')}/`;\n        config.themeConfig.nav.push({\n          text: 'API',\n          link: apiIndexLink,\n        });\n        config.themeConfig.sidebar = config.themeConfig.sidebar || {};\n        config.themeConfig.sidebar[apiIndexLink] =\n          entryPoints.length > 1\n            ? await resolveSidebarForMultiEntry(jsonDir)\n            : await resolveSidebarForSingleEntry(jsonDir);\n        config.themeConfig.sidebar[apiIndexLink].unshift({\n          text: 'Overview',\n          link: `${apiIndexLink}README`,\n        });\n      }\n      config.route = config.route || {};\n      config.route.exclude = config.route.exclude || [];\n      return config;\n    },\n  };\n}\n","export const API_DIR = 'api';\nexport const ROUTE_PREFIX = `/${API_DIR}`;\n","import path from 'path';\nimport fs from '@modern-js/utils/fs-extra';\nimport type { SidebarGroup } from '@rspress/shared';\nimport { transformModuleName } from './utils';\nimport { ROUTE_PREFIX } from './constants';\n\ninterface ModuleItem {\n  id: number;\n  name: string;\n  children: {\n    id: number;\n    name: string;\n  }[];\n  groups: {\n    title: string;\n    children: number[];\n  }[];\n}\n\nasync function patchLinks(outputDir: string) {\n  // Patch links in markdown files\n  // Scan all the markdown files in the output directory\n  // replace [xxx](yyy) -> [xxx](./yyy)\n  const normlizeLinksInFile = async (filePath: string) => {\n    const content = await fs.readFile(filePath, 'utf-8');\n    // replace: [xxx](yyy) -> [xxx](./yyy)\n    const newContent = content.replace(\n      /\\[([^\\]]+)\\]\\(([^)]+)\\)/g,\n      (_match, p1, p2) => {\n        return `[${p1}](./${p2})`;\n      },\n    );\n    await fs.writeFile(filePath, newContent);\n  };\n\n  const traverse = async (dir: string) => {\n    const files = await fs.readdir(dir);\n    for (const file of files) {\n      const filePath = path.join(dir, file);\n      const stat = await fs.stat(filePath);\n      if (stat.isDirectory()) {\n        await traverse(filePath);\n      } else if (stat.isFile() && /\\.mdx?/.test(file)) {\n        await normlizeLinksInFile(filePath);\n      }\n    }\n  };\n  await traverse(outputDir);\n}\n\nexport async function resolveSidebarForSingleEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return [];\n  }\n  const symbolMap = new Map<string, number>();\n  data.groups.forEach((group: { title: string; children: number[] }) => {\n    const groupItem: SidebarGroup = {\n      text: group.title,\n      items: [],\n    };\n    group.children.forEach((id: number) => {\n      const dataItem = data.children.find((item: ModuleItem) => item.id === id);\n      if (dataItem) {\n        // Note: we should handle the case that classes and interfaces have the same name\n        // Such as class `Env` and variable `env`\n        // The final output file name should be `classes/Env.md` and `variables/env-1.md`\n        let fileName = dataItem.name;\n        if (symbolMap.has(dataItem.name)) {\n          const count = symbolMap.get(dataItem.name)! + 1;\n          symbolMap.set(dataItem.name, count);\n          fileName = `${dataItem.name}-${count}`;\n        } else {\n          symbolMap.set(dataItem.name.toLocaleLowerCase(), 0);\n        }\n        groupItem.items.push({\n          text: dataItem.name,\n          link: `${ROUTE_PREFIX}/${group.title.toLocaleLowerCase()}/${fileName}`,\n        });\n      }\n    });\n    result.push(groupItem);\n  });\n\n  await patchLinks(path.dirname(jsonFile));\n\n  return result;\n}\n\nexport async function resolveSidebarForMultiEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return result;\n  }\n\n  function getModulePath(name: string) {\n    return path\n      .join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`)\n      .replace(/\\\\/g, '/');\n  }\n\n  function getClassPath(moduleName: string, className: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/classes`,\n        `${transformModuleName(moduleName)}.${className}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getInterfacePath(moduleName: string, interfaceName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/interfaces`,\n        `${transformModuleName(moduleName)}.${interfaceName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getFunctionPath(moduleName: string, functionName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/functions`,\n        `${transformModuleName(moduleName)}.${functionName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  data.children.forEach((module: ModuleItem) => {\n    const moduleNames = module.name.split('/');\n    const name = moduleNames[moduleNames.length - 1];\n    const moduleConfig = {\n      text: `Module:${name}`,\n      items: [{ text: 'Overview', link: getModulePath(module.name) }],\n    };\n    if (!module.children || module.children.length <= 0) {\n      return;\n    }\n    module.children.forEach(sub => {\n      const kindString = module.groups\n        .find(item => item.children.includes(sub.id))\n        ?.title.slice(0, -1);\n      if (!kindString) {\n        return;\n      }\n      switch (kindString) {\n        case 'Class':\n          moduleConfig.items.push({\n            text: `Class:${sub.name}`,\n            link: getClassPath(module.name, sub.name),\n          });\n          break;\n        case 'Interface':\n          moduleConfig.items.push({\n            text: `Interface:${sub.name}`,\n            link: getInterfacePath(module.name, sub.name),\n          });\n          break;\n        case 'Function':\n          moduleConfig.items.push({\n            text: `Function:${sub.name}`,\n            link: getFunctionPath(module.name, sub.name),\n          });\n          break;\n        default:\n          break;\n      }\n    });\n    result.push(moduleConfig);\n  });\n  await patchLinks(path.dirname(jsonFile));\n  return result;\n}\n","export function transformModuleName(name: string) {\n  return name.replace(/\\//g, '_').replace(/-/g, '_');\n}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,17 @@
+import { RspressPlugin } from '@rspress/shared';
+
+interface PluginTypeDocOptions {
+    /**
+     * The entry points of modules.
+     * @default []
+     */
+    entryPoints: string[];
+    /**
+     * The output directory.
+     * @default 'api'
+     */
+    outDir?: string;
+}
+declare function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin;
+
+export { PluginTypeDocOptions, pluginTypeDoc };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-typedoc",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A plugin for rspress to integrate typedoc",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -10,9 +10,9 @@
   },
   "license": "MIT",
   "jsnext:source": "./src/index.ts",
-  "types": "./dist/index.d.ts",
-  "main": "./dist/index.js",
-  "module": "./dist/node/index.js",
+  "types": "./dist/types/index.d.ts",
+  "main": "./dist/lib/index.js",
+  "module": "./dist/es/index.js",
   "engines": {
     "node": ">=14.17.6"
   },
@@ -28,7 +28,7 @@
     "typescript": "^5",
     "vitest": "0.33.0",
     "react": "^18",
-    "@rspress/shared": "0.1.1"
+    "@rspress/shared": "0.2.0"
   },
   "peerDependencies": {
     "rspress": "*"

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"mappings":";AAAA,OAAOA,WAAU;AACjB,SAASC,aAAaC,sBAAsB;AAE5C,SAASC,YAAY;;;ACHd,IAAMC,UAAU;AAChB,IAAMC,eAAe,IAAID;;;ACDhC,OAAOJ,UAAU;AACjB,OAAOM,QAAQ;;;ACDR,SAASC,oBAAoBC,MAAY;AAC9C,SAAOA,KAAKC,QAAQ,OAAO,KAAKA,QAAQ,MAAM;AAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SDiBeC,WAAWC,WAAiB;SAA5BD;;SAAAA;AAAAA,gBAAf,+BAA0BC,WAAiB;AAIzC,UAAMC;iBAAsB,+BAAOC;AACjC,cAAMC,UAAU,MAAMR,GAAGS,SAASF,UAAU;AAE5C,cAAMG,aAAaF,QAAQL,QACzB,4BACA,CAACQ,QAAQC,IAAIC;AACX,iBAAO,IAAID,SAASC;QACtB;AAEF,cAAMb,GAAGc,UAAUP,UAAUG;MAC/B;sBAVMJ,qBAA6BC;;;;AAYnC,UAAMQ;iBAAW,+BAAOC;AACtB,cAAMC,QAAQ,MAAMjB,GAAGkB,QAAQF;AAC/B,mBAAWG,QAAQF,OAAO;AACxB,gBAAMV,WAAWb,KAAK0B,KAAKJ,KAAKG;AAChC,gBAAME,OAAO,MAAMrB,GAAGqB,KAAKd;AAC3B,cAAIc,KAAKC,YAAW,GAAI;AACtB,kBAAMP,SAASR;UACjB,WAAWc,KAAKE,OAAM,KAAM,SAASC,KAAKL,OAAO;AAC/C,kBAAMb,oBAAoBC;UAC5B;QACF;MACF;sBAXMQ,UAAkBC;;;;AAYxB,UAAMD,SAASV;EACjB;SA7BeD;;AA+Bf,SAAsBqB,6BACpBC,UAAgB;SADID;;SAAAA;AAAAA,kCAAf,+BACLC,UAAgB;AAEhB,UAAMC,SAAyB;AAC/B,UAAMC,OAAOC,KAAKC,MAAM,MAAM9B,GAAGS,SAASiB,UAAU,QAAO;AAC3D,QAAI,CAACE,KAAKG,YAAYH,KAAKG,SAASC,UAAU,GAAG;AAC/C,aAAO;IACT;AACA,UAAMC,YAAY,oBAAIC;AACtBN,SAAKO,OAAOC,QAAQ,CAACC;AACnB,YAAMC,YAA0B;QAC9BC,MAAMF,MAAMG;QACZC,OAAO;MACT;AACAJ,YAAMN,SAASK,QAAQ,CAACM;AACtB,cAAMC,WAAWf,KAAKG,SAASa,KAAK,CAACC,SAAqBA,KAAKH,OAAOA;AACtE,YAAIC,UAAU;AAIZ,cAAIG,WAAWH,SAASzC;AACxB,cAAI+B,UAAUc,IAAIJ,SAASzC,IAAI,GAAG;AAChC,kBAAM8C,QAAQf,UAAUgB,IAAIN,SAASzC,IAAI,IAAK;AAC9C+B,sBAAUiB,IAAIP,SAASzC,MAAM8C;AAC7BF,uBAAW,GAAGH,SAASzC,QAAQ8C;UACjC,OAAO;AACLf,sBAAUiB,IAAIP,SAASzC,KAAKiD,kBAAiB,GAAI;UACnD;AACAb,oBAAUG,MAAMW,KAAK;YACnBb,MAAMI,SAASzC;YACfmD,MAAM,GAAGtD,gBAAgBsC,MAAMG,MAAMW,kBAAiB,KAAML;UAC9D;QACF;MACF;AACAnB,aAAOyB,KAAKd;IACd;AAEA,UAAMlC,WAAWV,KAAK4D,QAAQ5B;AAE9B,WAAOC;EACT;SAxCsBF;;AA0CtB,SAAsB8B,4BACpB7B,UAAgB;SADI6B;;SAAAA;AAAAA,iCAAf,+BACL7B,UAAgB;AAEhB,UAAMC,SAAyB;AAC/B,UAAMC,OAAOC,KAAKC,MAAM,MAAM9B,GAAGS,SAASiB,UAAU,QAAO;AAC3D,QAAI,CAACE,KAAKG,YAAYH,KAAKG,SAASC,UAAU,GAAG;AAC/C,aAAOL;IACT;AAEA,aAAS6B,cAActD,MAAY;AACjC,aAAOR,KACJ0B,KAAK,GAAGrB,wBAAwB,GAAGE,oBAAoBC,OAAO,EAC9DC,QAAQ,OAAO;IACpB;AAEA,aAASsD,aAAaC,YAAoBC,WAAiB;AACzD,aAAOjE,KACJ0B,KACC,GAAGrB,wBACH,GAAGE,oBAAoByD,eAAeC,WAAW,EAElDxD,QAAQ,OAAO;IACpB;AAEA,aAASyD,iBAAiBF,YAAoBG,eAAqB;AACjE,aAAOnE,KACJ0B,KACC,GAAGrB,2BACH,GAAGE,oBAAoByD,eAAeG,eAAe,EAEtD1D,QAAQ,OAAO;IACpB;AAEA,aAAS2D,gBAAgBJ,YAAoBK,cAAoB;AAC/D,aAAOrE,KACJ0B,KACC,GAAGrB,0BACH,GAAGE,oBAAoByD,eAAeK,cAAc,EAErD5D,QAAQ,OAAO;IACpB;AAEAyB,SAAKG,SAASK,QAAQ,CAAC4B;AACrB,YAAMC,cAAcD,OAAO9D,KAAKgE,MAAM;AACtC,YAAMhE,OAAO+D,YAAYA,YAAYjC,SAAS;AAC9C,YAAMmC,eAAe;QACnB5B,MAAM,UAAUrC;QAChBuC,OAAO;UAAC;YAAEF,MAAM;YAAYc,MAAMG,cAAcQ,OAAO9D,IAAI;UAAE;;MAC/D;AACA,UAAI,CAAC8D,OAAOjC,YAAYiC,OAAOjC,SAASC,UAAU,GAAG;AACnD;MACF;AACAgC,aAAOjC,SAASK,QAAQgC;YACHJ;AAAnB,cAAMK,cAAaL,6BAAO7B,OACvBS,KAAKC,UAAQA,KAAKd,SAASuC,SAASF,IAAI1B,EAAE,gBAD1BsB,8DAEfxB,MAAM+B,MAAM,GAAG,EAAC;AACpB,YAAI,CAACF,YAAY;AACf;QACF;AACA,gBAAQA;UACN,KAAK;AACHF,yBAAa1B,MAAMW,KAAK;cACtBb,MAAM,SAAS6B,IAAIlE;cACnBmD,MAAMI,aAAaO,OAAO9D,MAAMkE,IAAIlE,IAAI;YAC1C;AACA;UACF,KAAK;AACHiE,yBAAa1B,MAAMW,KAAK;cACtBb,MAAM,aAAa6B,IAAIlE;cACvBmD,MAAMO,iBAAiBI,OAAO9D,MAAMkE,IAAIlE,IAAI;YAC9C;AACA;UACF,KAAK;AACHiE,yBAAa1B,MAAMW,KAAK;cACtBb,MAAM,YAAY6B,IAAIlE;cACtBmD,MAAMS,gBAAgBE,OAAO9D,MAAMkE,IAAIlE,IAAI;YAC7C;AACA;UACF;AACE;QACJ;MACF;AACAyB,aAAOyB,KAAKe;IACd;AACA,UAAM/D,WAAWV,KAAK4D,QAAQ5B;AAC9B,WAAOC;EACT;SAtFsB4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AFrEf,SAASiB,cAAcC,SAA6B;AACzD,MAAIC;AACJ,QAAM,EAAEC,cAAc,IAAIC,SAAS9E,QAAO,IAAK2E;AAC/C,SAAO;IACLvE,MAAM;IACA2E;aAAWC;AACf,eAAO;UACL;YACEC,WAAW,GAAGH,OAAOzE,QAAQ,OAAO;YACpC6E,UAAUtF,MAAK0B,KAAKsD,SAAUE,QAAQ;UACxC;;MAEJ;;IACMK,OAAOA,QAAM;aAAEH;AACnB,cAAMI,MAAM,IAAIvF;AAChB+E,kBAAUO,OAAOE;AACjBD,YAAIT,QAAQW,UAAU,IAAIxF;AAC1BC,aAAKqF;AACLA,YAAIG,UAAU;UACZnF,MAAM+E,OAAOzC;UACbmC;UACAW,OAAO;UACPC,gBAAgB;UAChBC,QAAQ;UACRC,aAAa;UACbC,wBAAwB;YAAC;YAAS;YAAY;;UAC9CC,QAAQ;YAAC;;;UAETC,iBAAiB;UACjBC,mBAAmB;UACnBC,+BAA+B;QACjC;AACA,cAAMC,UAAUb,IAAIc,QAAO;AAE3B,YAAID,SAAS;AAEX,gBAAME,oBAAoBvG,MAAK0B,KAAKsD,SAAUE;AAC9C,gBAAMM,IAAIgB,aAAaH,SAASE;AAChC,gBAAME,UAAUzG,MAAK0B,KAAK6E,mBAAmB;AAC7C,gBAAMf,IAAIkB,aAAaL,SAASI;AAEhClB,iBAAOoB,cAAcpB,OAAOoB,eAAe,CAAC;AAC5CpB,iBAAOoB,YAAYC,MAAMrB,OAAOoB,YAAYC,OAAO;AACnD,gBAAMC,eAAe,IAAI3B,OAAOzE,QAAQ,eAAe;AACvD8E,iBAAOoB,YAAYC,IAAIlD,KAAK;YAC1Bb,MAAM;YACNc,MAAMkD;UACR;AACAtB,iBAAOoB,YAAYG,UAAUvB,OAAOoB,YAAYG,WAAW,CAAC;AAC5DvB,iBAAOoB,YAAYG,QAAQD,gBACzB5B,YAAY3C,SAAS,IACjB,MAAMuB,4BAA4B4C,WAClC,MAAM1E,6BAA6B0E;AACzClB,iBAAOoB,YAAYG,QAAQD,cAAcE,QAAQ;YAC/ClE,MAAM;YACNc,MAAM,GAAGkD;UACX;QACF;AACAtB,eAAOyB,QAAQzB,OAAOyB,SAAS,CAAC;AAChCzB,eAAOyB,MAAMC,UAAU1B,OAAOyB,MAAMC,WAAW;AAC/C,eAAO1B;MACT;;EACF;AACF;","names":["path","Application","TSConfigReader","load","API_DIR","ROUTE_PREFIX","fs","transformModuleName","name","replace","patchLinks","outputDir","normlizeLinksInFile","filePath","content","readFile","newContent","_match","p1","p2","writeFile","traverse","dir","files","readdir","file","join","stat","isDirectory","isFile","test","resolveSidebarForSingleEntry","jsonFile","result","data","JSON","parse","children","length","symbolMap","Map","groups","forEach","group","groupItem","text","title","items","id","dataItem","find","item","fileName","has","count","get","set","toLocaleLowerCase","push","link","dirname","resolveSidebarForMultiEntry","getModulePath","getClassPath","moduleName","className","getInterfacePath","interfaceName","getFunctionPath","functionName","module","moduleNames","split","moduleConfig","sub","kindString","includes","slice","pluginTypeDoc","options","docRoot","entryPoints","outDir","addPages","_async_to_generator","routePath","filepath","config","app","root","addReader","bootstrap","theme","disableSources","readme","githubPages","requiredToBeDocumented","plugin","hideBreadcrumbs","hideMembersSymbol","allReflectionsHaveOwnDocument","project","convert","absoluteOutputdir","generateDocs","jsonDir","generateJson","themeConfig","nav","apiIndexLink","sidebar","unshift","route","exclude"],"sources":["../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/index.ts","../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/constants.ts","../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/sidebar.ts","../src/home/runner/work/rspress/rspress/packages/plugin-typedoc/src/utils.ts"],"sourcesContent":["import path from 'path';\nimport { Application, TSConfigReader } from 'typedoc';\nimport type { RspressPlugin } from '@rspress/shared';\nimport { load } from 'typedoc-plugin-markdown';\nimport { API_DIR } from './constants';\nimport {\n  resolveSidebarForMultiEntry,\n  resolveSidebarForSingleEntry,\n} from './sidebar';\n\nexport interface PluginTypeDocOptions {\n  /**\n   * The entry points of modules.\n   * @default []\n   */\n  entryPoints: string[];\n  /**\n   * The output directory.\n   * @default 'api'\n   */\n  outDir?: string;\n}\n\nexport function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {\n  let docRoot: string | undefined;\n  const { entryPoints = [], outDir = API_DIR } = options;\n  return {\n    name: '@rspress/plugin-typedoc',\n    async addPages() {\n      return [\n        {\n          routePath: `${outDir.replace(/\\/$/, '')}/`,\n          filepath: path.join(docRoot!, outDir, 'README.md'),\n        },\n      ];\n    },\n    async config(config) {\n      const app = new Application();\n      docRoot = config.root;\n      app.options.addReader(new TSConfigReader());\n      load(app);\n      app.bootstrap({\n        name: config.title,\n        entryPoints,\n        theme: 'markdown',\n        disableSources: true,\n        readme: 'none',\n        githubPages: false,\n        requiredToBeDocumented: ['Class', 'Function', 'Interface'],\n        plugin: ['typedoc-plugin-markdown'],\n        // @ts-expect-error MarkdownTheme has no export\n        hideBreadcrumbs: true,\n        hideMembersSymbol: true,\n        allReflectionsHaveOwnDocument: true,\n      });\n      const project = app.convert();\n\n      if (project) {\n        // 1. Generate module doc by typedoc\n        const absoluteOutputdir = path.join(docRoot!, outDir);\n        await app.generateDocs(project, absoluteOutputdir);\n        const jsonDir = path.join(absoluteOutputdir, 'documentation.json');\n        await app.generateJson(project, jsonDir);\n        // 2. Generate sidebar\n        config.themeConfig = config.themeConfig || {};\n        config.themeConfig.nav = config.themeConfig.nav || [];\n        const apiIndexLink = `/${outDir.replace(/(^\\/)|(\\/$)/, '')}/`;\n        config.themeConfig.nav.push({\n          text: 'API',\n          link: apiIndexLink,\n        });\n        config.themeConfig.sidebar = config.themeConfig.sidebar || {};\n        config.themeConfig.sidebar[apiIndexLink] =\n          entryPoints.length > 1\n            ? await resolveSidebarForMultiEntry(jsonDir)\n            : await resolveSidebarForSingleEntry(jsonDir);\n        config.themeConfig.sidebar[apiIndexLink].unshift({\n          text: 'Overview',\n          link: `${apiIndexLink}README`,\n        });\n      }\n      config.route = config.route || {};\n      config.route.exclude = config.route.exclude || [];\n      return config;\n    },\n  };\n}\n","export const API_DIR = 'api';\nexport const ROUTE_PREFIX = `/${API_DIR}`;\n","import path from 'path';\nimport fs from '@modern-js/utils/fs-extra';\nimport type { SidebarGroup } from '@rspress/shared';\nimport { transformModuleName } from './utils';\nimport { ROUTE_PREFIX } from './constants';\n\ninterface ModuleItem {\n  id: number;\n  name: string;\n  children: {\n    id: number;\n    name: string;\n  }[];\n  groups: {\n    title: string;\n    children: number[];\n  }[];\n}\n\nasync function patchLinks(outputDir: string) {\n  // Patch links in markdown files\n  // Scan all the markdown files in the output directory\n  // replace [xxx](yyy) -> [xxx](./yyy)\n  const normlizeLinksInFile = async (filePath: string) => {\n    const content = await fs.readFile(filePath, 'utf-8');\n    // replace: [xxx](yyy) -> [xxx](./yyy)\n    const newContent = content.replace(\n      /\\[([^\\]]+)\\]\\(([^)]+)\\)/g,\n      (_match, p1, p2) => {\n        return `[${p1}](./${p2})`;\n      },\n    );\n    await fs.writeFile(filePath, newContent);\n  };\n\n  const traverse = async (dir: string) => {\n    const files = await fs.readdir(dir);\n    for (const file of files) {\n      const filePath = path.join(dir, file);\n      const stat = await fs.stat(filePath);\n      if (stat.isDirectory()) {\n        await traverse(filePath);\n      } else if (stat.isFile() && /\\.mdx?/.test(file)) {\n        await normlizeLinksInFile(filePath);\n      }\n    }\n  };\n  await traverse(outputDir);\n}\n\nexport async function resolveSidebarForSingleEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return [];\n  }\n  const symbolMap = new Map<string, number>();\n  data.groups.forEach((group: { title: string; children: number[] }) => {\n    const groupItem: SidebarGroup = {\n      text: group.title,\n      items: [],\n    };\n    group.children.forEach((id: number) => {\n      const dataItem = data.children.find((item: ModuleItem) => item.id === id);\n      if (dataItem) {\n        // Note: we should handle the case that classes and interfaces have the same name\n        // Such as class `Env` and variable `env`\n        // The final output file name should be `classes/Env.md` and `variables/env-1.md`\n        let fileName = dataItem.name;\n        if (symbolMap.has(dataItem.name)) {\n          const count = symbolMap.get(dataItem.name)! + 1;\n          symbolMap.set(dataItem.name, count);\n          fileName = `${dataItem.name}-${count}`;\n        } else {\n          symbolMap.set(dataItem.name.toLocaleLowerCase(), 0);\n        }\n        groupItem.items.push({\n          text: dataItem.name,\n          link: `${ROUTE_PREFIX}/${group.title.toLocaleLowerCase()}/${fileName}`,\n        });\n      }\n    });\n    result.push(groupItem);\n  });\n\n  await patchLinks(path.dirname(jsonFile));\n\n  return result;\n}\n\nexport async function resolveSidebarForMultiEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return result;\n  }\n\n  function getModulePath(name: string) {\n    return path\n      .join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`)\n      .replace(/\\\\/g, '/');\n  }\n\n  function getClassPath(moduleName: string, className: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/classes`,\n        `${transformModuleName(moduleName)}.${className}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getInterfacePath(moduleName: string, interfaceName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/interfaces`,\n        `${transformModuleName(moduleName)}.${interfaceName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getFunctionPath(moduleName: string, functionName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/functions`,\n        `${transformModuleName(moduleName)}.${functionName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  data.children.forEach((module: ModuleItem) => {\n    const moduleNames = module.name.split('/');\n    const name = moduleNames[moduleNames.length - 1];\n    const moduleConfig = {\n      text: `Module:${name}`,\n      items: [{ text: 'Overview', link: getModulePath(module.name) }],\n    };\n    if (!module.children || module.children.length <= 0) {\n      return;\n    }\n    module.children.forEach(sub => {\n      const kindString = module.groups\n        .find(item => item.children.includes(sub.id))\n        ?.title.slice(0, -1);\n      if (!kindString) {\n        return;\n      }\n      switch (kindString) {\n        case 'Class':\n          moduleConfig.items.push({\n            text: `Class:${sub.name}`,\n            link: getClassPath(module.name, sub.name),\n          });\n          break;\n        case 'Interface':\n          moduleConfig.items.push({\n            text: `Interface:${sub.name}`,\n            link: getInterfacePath(module.name, sub.name),\n          });\n          break;\n        case 'Function':\n          moduleConfig.items.push({\n            text: `Function:${sub.name}`,\n            link: getFunctionPath(module.name, sub.name),\n          });\n          break;\n        default:\n          break;\n      }\n    });\n    result.push(moduleConfig);\n  });\n  await patchLinks(path.dirname(jsonFile));\n  return result;\n}\n","export function transformModuleName(name: string) {\n  return name.replace(/\\//g, '_').replace(/-/g, '_');\n}\n"]}