@rspress/plugin-typedoc 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# @rspress/plugin-typedoc

package/dist/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/index.js

@@ -0,0 +1,303 @@
+// src/index.ts
+import path2 from "path";
+import { Application, TSConfigReader } from "typedoc";
+import { load } from "typedoc-plugin-markdown";
+
+// src/constants.ts
+var API_DIR = "api";
+var ROUTE_PREFIX = `/${API_DIR}`;
+
+// src/sidebar.ts
+import path from "path";
+import fs from "@modern-js/utils/fs-extra";
+
+// src/utils.ts
+function transformModuleName(name) {
+  return name.replace(/\//g, "_").replace(/-/g, "_");
+}
+
+// src/sidebar.ts
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+  try {
+    var info = gen[key](arg);
+    var value = info.value;
+  } catch (error) {
+    reject(error);
+    return;
+  }
+  if (info.done) {
+    resolve(value);
+  } else {
+    Promise.resolve(value).then(_next, _throw);
+  }
+}
+function _async_to_generator(fn) {
+  return function() {
+    var self = this, args = arguments;
+    return new Promise(function(resolve, reject) {
+      var gen = fn.apply(self, args);
+      function _next(value) {
+        asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+      }
+      function _throw(err) {
+        asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+      }
+      _next(void 0);
+    });
+  };
+}
+function patchLinks(outputDir) {
+  return _patchLinks.apply(this, arguments);
+}
+function _patchLinks() {
+  _patchLinks = _async_to_generator(function* (outputDir) {
+    const normlizeLinksInFile = function() {
+      var _ref = _async_to_generator(function* (filePath) {
+        const content = yield fs.readFile(filePath, "utf-8");
+        const newContent = content.replace(/\[([^\]]+)\]\(([^)]+)\)/g, (_match, p1, p2) => {
+          return `[${p1}](./${p2})`;
+        });
+        yield fs.writeFile(filePath, newContent);
+      });
+      return function normlizeLinksInFile2(filePath) {
+        return _ref.apply(this, arguments);
+      };
+    }();
+    const traverse = function() {
+      var _ref = _async_to_generator(function* (dir) {
+        const files = yield fs.readdir(dir);
+        for (const file of files) {
+          const filePath = path.join(dir, file);
+          const stat = yield fs.stat(filePath);
+          if (stat.isDirectory()) {
+            yield traverse(filePath);
+          } else if (stat.isFile() && /\.mdx?/.test(file)) {
+            yield normlizeLinksInFile(filePath);
+          }
+        }
+      });
+      return function traverse2(dir) {
+        return _ref.apply(this, arguments);
+      };
+    }();
+    yield traverse(outputDir);
+  });
+  return _patchLinks.apply(this, arguments);
+}
+function resolveSidebarForSingleEntry(jsonFile) {
+  return _resolveSidebarForSingleEntry.apply(this, arguments);
+}
+function _resolveSidebarForSingleEntry() {
+  _resolveSidebarForSingleEntry = _async_to_generator(function* (jsonFile) {
+    const result = [];
+    const data = JSON.parse(yield fs.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(path.dirname(jsonFile));
+    return result;
+  });
+  return _resolveSidebarForSingleEntry.apply(this, arguments);
+}
+function resolveSidebarForMultiEntry(jsonFile) {
+  return _resolveSidebarForMultiEntry.apply(this, arguments);
+}
+function _resolveSidebarForMultiEntry() {
+  _resolveSidebarForMultiEntry = _async_to_generator(function* (jsonFile) {
+    const result = [];
+    const data = JSON.parse(yield fs.readFile(jsonFile, "utf-8"));
+    if (!data.children || data.children.length <= 0) {
+      return result;
+    }
+    function getModulePath(name) {
+      return path.join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`).replace(/\\/g, "/");
+    }
+    function getClassPath(moduleName, className) {
+      return path.join(`${ROUTE_PREFIX}/classes`, `${transformModuleName(moduleName)}.${className}`).replace(/\\/g, "/");
+    }
+    function getInterfacePath(moduleName, interfaceName) {
+      return path.join(`${ROUTE_PREFIX}/interfaces`, `${transformModuleName(moduleName)}.${interfaceName}`).replace(/\\/g, "/");
+    }
+    function getFunctionPath(moduleName, functionName) {
+      return path.join(`${ROUTE_PREFIX}/functions`, `${transformModuleName(moduleName)}.${functionName}`).replace(/\\/g, "/");
+    }
+    data.children.forEach((module) => {
+      const moduleNames = module.name.split("/");
+      const name = moduleNames[moduleNames.length - 1];
+      const moduleConfig = {
+        text: `Module:${name}`,
+        items: [
+          {
+            text: "Overview",
+            link: getModulePath(module.name)
+          }
+        ]
+      };
+      if (!module.children || module.children.length <= 0) {
+        return;
+      }
+      module.children.forEach((sub) => {
+        var _module_groups_find;
+        const kindString = (_module_groups_find = module.groups.find((item) => item.children.includes(sub.id))) === null || _module_groups_find === void 0 ? void 0 : _module_groups_find.title.slice(0, -1);
+        if (!kindString) {
+          return;
+        }
+        switch (kindString) {
+          case "Class":
+            moduleConfig.items.push({
+              text: `Class:${sub.name}`,
+              link: getClassPath(module.name, sub.name)
+            });
+            break;
+          case "Interface":
+            moduleConfig.items.push({
+              text: `Interface:${sub.name}`,
+              link: getInterfacePath(module.name, sub.name)
+            });
+            break;
+          case "Function":
+            moduleConfig.items.push({
+              text: `Function:${sub.name}`,
+              link: getFunctionPath(module.name, sub.name)
+            });
+            break;
+          default:
+            break;
+        }
+      });
+      result.push(moduleConfig);
+    });
+    yield patchLinks(path.dirname(jsonFile));
+    return result;
+  });
+  return _resolveSidebarForMultiEntry.apply(this, arguments);
+}
+
+// src/index.ts
+function asyncGeneratorStep2(gen, resolve, reject, _next, _throw, key, arg) {
+  try {
+    var info = gen[key](arg);
+    var value = info.value;
+  } catch (error) {
+    reject(error);
+    return;
+  }
+  if (info.done) {
+    resolve(value);
+  } else {
+    Promise.resolve(value).then(_next, _throw);
+  }
+}
+function _async_to_generator2(fn) {
+  return function() {
+    var self = this, args = arguments;
+    return new Promise(function(resolve, reject) {
+      var gen = fn.apply(self, args);
+      function _next(value) {
+        asyncGeneratorStep2(gen, resolve, reject, _next, _throw, "next", value);
+      }
+      function _throw(err) {
+        asyncGeneratorStep2(gen, resolve, reject, _next, _throw, "throw", err);
+      }
+      _next(void 0);
+    });
+  };
+}
+function pluginTypeDoc(options) {
+  let docRoot;
+  const { entryPoints = [], outDir = API_DIR } = options;
+  return {
+    name: "doc-plugin-typedoc",
+    addPages() {
+      return _async_to_generator2(function* () {
+        return [
+          {
+            routePath: `${outDir.replace(/\/$/, "")}/`,
+            filepath: path2.join(docRoot, outDir, "README.md")
+          }
+        ];
+      })();
+    },
+    config(config) {
+      return _async_to_generator2(function* () {
+        const app = new Application();
+        docRoot = config.root;
+        app.options.addReader(new TSConfigReader());
+        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 = path2.join(docRoot, outDir);
+          yield app.generateDocs(project, absoluteOutputdir);
+          const jsonDir = path2.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;
+      })();
+    }
+  };
+}
+export {
+  pluginTypeDoc
+};
+
+//# sourceMappingURL=index.js.map

package/dist/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: 'doc-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/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@rspress/plugin-typedoc",
+  "version": "0.0.1",
+  "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",
+    "directory": "packages/plugin-typedoc"
+  },
+  "license": "MIT",
+  "jsnext:source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/node/index.js",
+  "engines": {
+    "node": ">=14.17.6"
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "dist/"
+  ],
+  "devDependencies": {
+    "@modern-js/tsconfig": "2.30.0",
+    "@types/node": "^18.11.17",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "typescript": "^5",
+    "vitest": "0.33.0",
+    "react": "^17",
+    "@rspress/shared": "0.0.1"
+  },
+  "peerDependencies": {
+    "rspress": "*"
+  },
+  "sideEffects": [
+    "*.css",
+    "*.less",
+    "*.sass",
+    "*.scss"
+  ],
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@modern-js/utils": "2.30.0",
+    "typedoc": "0.24.8",
+    "typedoc-plugin-markdown": "3.15.3"
+  },
+  "scripts": {
+    "dev": "modern dev",
+    "build": "modern build",
+    "reset": "rimraf ./**/node_modules",
+    "lint": "modern lint",
+    "change": "modern change",
+    "bump": "modern bump",
+    "pre": "modern pre",
+    "change-status": "modern change-status",
+    "gen-release-note": "modern gen-release-note",
+    "release": "modern release",
+    "new": "modern new",
+    "test": "vitest run --passWithNoTests",
+    "upgrade": "modern upgrade"
+  }
+}

package/src/.eslintrc.cjs

@@ -0,0 +1,9 @@
+// eslint-disable-next-line import/no-commonjs
+module.exports = {
+  root: true,
+  extends: ['@modern-js-app'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['../tsconfig.json'],
+  },
+};

package/src/constants.ts

@@ -0,0 +1,2 @@
+export const API_DIR = 'api';
+export const ROUTE_PREFIX = `/${API_DIR}`;

package/src/index.ts

@@ -0,0 +1,87 @@
+import path from 'path';
+import { Application, TSConfigReader } from 'typedoc';
+import type { RspressPlugin } from '@rspress/shared';
+import { load } from 'typedoc-plugin-markdown';
+import { API_DIR } from './constants';
+import {
+  resolveSidebarForMultiEntry,
+  resolveSidebarForSingleEntry,
+} from './sidebar';
+
+export interface PluginTypeDocOptions {
+  /**
+   * The entry points of modules.
+   * @default []
+   */
+  entryPoints: string[];
+  /**
+   * The output directory.
+   * @default 'api'
+   */
+  outDir?: string;
+}
+
+export function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {
+  let docRoot: string | undefined;
+  const { entryPoints = [], outDir = API_DIR } = options;
+  return {
+    name: 'doc-plugin-typedoc',
+    async addPages() {
+      return [
+        {
+          routePath: `${outDir.replace(/\/$/, '')}/`,
+          filepath: path.join(docRoot!, outDir, 'README.md'),
+        },
+      ];
+    },
+    async config(config) {
+      const app = new Application();
+      docRoot = config.root;
+      app.options.addReader(new TSConfigReader());
+      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) {
+        // 1. Generate module doc by typedoc
+        const absoluteOutputdir = path.join(docRoot!, outDir);
+        await app.generateDocs(project, absoluteOutputdir);
+        const jsonDir = path.join(absoluteOutputdir, 'documentation.json');
+        await app.generateJson(project, jsonDir);
+        // 2. Generate sidebar
+        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
+            ? await resolveSidebarForMultiEntry(jsonDir)
+            : await resolveSidebarForSingleEntry(jsonDir);
+        config.themeConfig.sidebar[apiIndexLink].unshift({
+          text: 'Overview',
+          link: `${apiIndexLink}README`,
+        });
+      }
+      config.route = config.route || {};
+      config.route.exclude = config.route.exclude || [];
+      return config;
+    },
+  };
+}

package/src/modern-app-env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types='@modern-js/module-tools/types' />
+/// <reference types='@modern-js/plugin-testing/types' />

package/src/sidebar.ts

@@ -0,0 +1,179 @@
+import path from 'path';
+import fs from '@modern-js/utils/fs-extra';
+import type { SidebarGroup } from '@rspress/shared';
+import { transformModuleName } from './utils';
+import { ROUTE_PREFIX } from './constants';
+
+interface ModuleItem {
+  id: number;
+  name: string;
+  children: {
+    id: number;
+    name: string;
+  }[];
+  groups: {
+    title: string;
+    children: number[];
+  }[];
+}
+
+async function patchLinks(outputDir: string) {
+  // Patch links in markdown files
+  // Scan all the markdown files in the output directory
+  // replace [xxx](yyy) -> [xxx](./yyy)
+  const normlizeLinksInFile = async (filePath: string) => {
+    const content = await fs.readFile(filePath, 'utf-8');
+    // replace: [xxx](yyy) -> [xxx](./yyy)
+    const newContent = content.replace(
+      /\[([^\]]+)\]\(([^)]+)\)/g,
+      (_match, p1, p2) => {
+        return `[${p1}](./${p2})`;
+      },
+    );
+    await fs.writeFile(filePath, newContent);
+  };
+
+  const traverse = async (dir: string) => {
+    const files = await fs.readdir(dir);
+    for (const file of files) {
+      const filePath = path.join(dir, file);
+      const stat = await fs.stat(filePath);
+      if (stat.isDirectory()) {
+        await traverse(filePath);
+      } else if (stat.isFile() && /\.mdx?/.test(file)) {
+        await normlizeLinksInFile(filePath);
+      }
+    }
+  };
+  await traverse(outputDir);
+}
+
+export async function resolveSidebarForSingleEntry(
+  jsonFile: string,
+): Promise<SidebarGroup[]> {
+  const result: SidebarGroup[] = [];
+  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));
+  if (!data.children || data.children.length <= 0) {
+    return [];
+  }
+  const symbolMap = new Map<string, number>();
+  data.groups.forEach((group: { title: string; children: number[] }) => {
+    const groupItem: SidebarGroup = {
+      text: group.title,
+      items: [],
+    };
+    group.children.forEach((id: number) => {
+      const dataItem = data.children.find((item: ModuleItem) => item.id === id);
+      if (dataItem) {
+        // Note: we should handle the case that classes and interfaces have the same name
+        // Such as class `Env` and variable `env`
+        // The final output file name should be `classes/Env.md` and `variables/env-1.md`
+        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);
+  });
+
+  await patchLinks(path.dirname(jsonFile));
+
+  return result;
+}
+
+export async function resolveSidebarForMultiEntry(
+  jsonFile: string,
+): Promise<SidebarGroup[]> {
+  const result: SidebarGroup[] = [];
+  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));
+  if (!data.children || data.children.length <= 0) {
+    return result;
+  }
+
+  function getModulePath(name: string) {
+    return path
+      .join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`)
+      .replace(/\\/g, '/');
+  }
+
+  function getClassPath(moduleName: string, className: string) {
+    return path
+      .join(
+        `${ROUTE_PREFIX}/classes`,
+        `${transformModuleName(moduleName)}.${className}`,
+      )
+      .replace(/\\/g, '/');
+  }
+
+  function getInterfacePath(moduleName: string, interfaceName: string) {
+    return path
+      .join(
+        `${ROUTE_PREFIX}/interfaces`,
+        `${transformModuleName(moduleName)}.${interfaceName}`,
+      )
+      .replace(/\\/g, '/');
+  }
+
+  function getFunctionPath(moduleName: string, functionName: string) {
+    return path
+      .join(
+        `${ROUTE_PREFIX}/functions`,
+        `${transformModuleName(moduleName)}.${functionName}`,
+      )
+      .replace(/\\/g, '/');
+  }
+
+  data.children.forEach((module: ModuleItem) => {
+    const moduleNames = module.name.split('/');
+    const name = moduleNames[moduleNames.length - 1];
+    const moduleConfig = {
+      text: `Module:${name}`,
+      items: [{ text: 'Overview', link: getModulePath(module.name) }],
+    };
+    if (!module.children || module.children.length <= 0) {
+      return;
+    }
+    module.children.forEach(sub => {
+      const kindString = module.groups
+        .find(item => item.children.includes(sub.id))
+        ?.title.slice(0, -1);
+      if (!kindString) {
+        return;
+      }
+      switch (kindString) {
+        case 'Class':
+          moduleConfig.items.push({
+            text: `Class:${sub.name}`,
+            link: getClassPath(module.name, sub.name),
+          });
+          break;
+        case 'Interface':
+          moduleConfig.items.push({
+            text: `Interface:${sub.name}`,
+            link: getInterfacePath(module.name, sub.name),
+          });
+          break;
+        case 'Function':
+          moduleConfig.items.push({
+            text: `Function:${sub.name}`,
+            link: getFunctionPath(module.name, sub.name),
+          });
+          break;
+        default:
+          break;
+      }
+    });
+    result.push(moduleConfig);
+  });
+  await patchLinks(path.dirname(jsonFile));
+  return result;
+}

package/src/utils.ts

@@ -0,0 +1,3 @@
+export function transformModuleName(name: string) {
+  return name.replace(/\//g, '_').replace(/-/g, '_');
+}