features

Author: Zamiell

package-lock.json

@@ -71,7 +71,6 @@
     "typedoc": "0.28.20",
     "typedoc-plugin-frontmatter": "1.3.1",
     "typedoc-plugin-markdown": "4.13.0",
-    "typedoc-plugin-rename": "1.1.1",
     "typescript": "6.0.2",
     "typescript-eslint": "8.69.0",
     "typescript-to-lua": "1.37.1",

package.json

@@ -27,8 +27,7 @@
     "sharp": "0.35.4",
     "typedoc": "0.28.20",
     "typedoc-plugin-frontmatter": "1.3.1",
-    "typedoc-plugin-markdown": "4.13.0",
-    "typedoc-plugin-rename": "1.1.1"
+    "typedoc-plugin-markdown": "4.13.0"
   },
   "devDependencies": {
     "@astrojs/check": "0.9.10",

packages/docs/package.json

@@ -0,0 +1,17 @@
+import { Comment, Converter } from "typedoc";
+
+const RENAME_TAG = "@rename";
+
+export function load(application) {
+  application.converter.on(Converter.EVENT_RESOLVE_BEGIN, (context) => {
+    for (const reflection of Object.values(context.project.reflections)) {
+      const renameTag = reflection.comment?.getTag(RENAME_TAG);
+      if (renameTag === undefined) {
+        continue;
+      }
+
+      reflection.name = Comment.combineDisplayParts(renameTag.content).trim();
+      reflection.comment?.removeTags(RENAME_TAG);
+    }
+  });
+}

packages/docs/src/plugins/typedoc-rename.mjs

@@ -16,6 +16,7 @@ export function getTypeDocConfig(packageDirectoryPath) {
       "@allowEmptyVariadic",
       "@maximum",
       "@minimum",
+      "@rename",
     ],
     classPropertiesFormat: "table",
     entryFileName: "index",
@@ -38,8 +39,8 @@ export function getTypeDocConfig(packageDirectoryPath) {
       "@zamiell/typedoc-plugin-not-exported",
       import.meta.resolve("typedoc-plugin-frontmatter"),
       TYPE_DOC_FRONTMATTER_PLUGIN_PATH,
+      path.join(import.meta.dirname, "src", "plugins", "typedoc-rename.mjs"),
       "typedoc-plugin-markdown",
-      "typedoc-plugin-rename",
     ],
     propertyMembersFormat: "table",
     readme: path.join(packageDirectoryPath, "README.md"),