typedoc-plugin-dt-links 1.1.16 → 2.0.0

package/README.md

@@ -8,22 +8,17 @@ to their source code on GitHub.
 If VSCode can follow a link into an `@types` package, this plugin should also
 be able to provide links to that package.
 
-> Note: Using TypeDoc before 0.26.8 may result in links which go to the start of
-> the doc comment rather to the symbol name.
-
-Supports TypeDoc 0.23.14 through 0.26.x.
-
 ## Options
 
--   `warnOnUnstableDtLink`
+- `warnOnUnstableDtLink`
 
-    Defaults to `true`. If set, and an `@types` package is referenced which is newer
-    than this plugin, produces a warning as this plugin won't be able to produce a stable
-    link.
+  Defaults to `true`. If set, and an `@types` package is referenced which is newer
+  than this plugin, produces a warning as this plugin won't be able to produce a stable
+  link.
 
-    This plugin is automatically published weekly, so if you are upgrading `@types` packages
-    and rebuilding docs more frequently than that, you may want to disable this option as
-    the link won't be dead long enough to matter.
+  This plugin is automatically published weekly, so if you are upgrading `@types` packages
+  and rebuilding docs more frequently than that, you may want to disable this option as
+  the link won't be dead long enough to matter.
 
 ## Changelog
 
@@ -50,4 +45,4 @@ was released more recently than this plugin, the plugin can't know what git hash
 should be used and will instead use `master` as the reference.
 
 [useTsLinkResolution]: https://typedoc.org/options/comments/#usetslinkresolution
-[ReflectionSymbolId]: (https://typedoc.org/api/classes/Models.ReflectionSymbolId.html)
+[ReflectionSymbolId]: https://typedoc.org/api/classes/Models.ReflectionSymbolId.html

package/dist/plugin.js

@@ -1,7 +1,7 @@
-import { ParameterType, splitUnquotedString, TypeScript as ts, } from "typedoc";
 import { readFileSync } from "node:fs";
 import { dirname } from "node:path";
 import { fileURLToPath } from "node:url";
+import { ParameterType, splitUnquotedString, TypeScript as ts, } from "typedoc";
 const PLUGIN_PREFIX = "[typedoc-plugin-dt-links]";
 const DT_DEFAULT_BRANCH = "master";
 export const DT_COMMITS = readFileSync(dirname(fileURLToPath(import.meta.url)) + "/../data/dt_history.txt", "utf-8")
@@ -44,8 +44,8 @@ function discoverSourceFilePosition(sf, qualifiedName) {
     function walkPath(index, node) {
         if (index === path.length) {
             const name = node.name;
-            if (name &&
-                (ts.isMemberName(name) || ts.isComputedPropertyName(name))) {
+            if (name
+                && (ts.isMemberName(name) || ts.isComputedPropertyName(name))) {
                 return name.getStart(sf, false);
             }
             return node.getStart(sf, false);
@@ -62,30 +62,30 @@ function discoverSourceFilePosition(sf, qualifiedName) {
                 else if (child.name.text === path[index]) {
                     return walkPath(index + 1, child);
                 }
-                else if (child.name.text === "global" &&
+                else if (child.name.text === "global"
                     // Not quite sure why TypeDoc gives this name...
-                    path[index] === "__global") {
+                    && path[index] === "__global") {
                     return walkPath(index + 1, child);
                 }
             }
-            if (ts.isModuleBlock(child) ||
-                ts.isVariableDeclaration(child) ||
-                ts.isVariableDeclarationList(child)) {
+            if (ts.isModuleBlock(child)
+                || ts.isVariableDeclaration(child)
+                || ts.isVariableDeclarationList(child)) {
                 return walkPath(index, child);
             }
-            if (ts.isClassDeclaration(child) ||
-                ts.isInterfaceDeclaration(child)) {
+            if (ts.isClassDeclaration(child)
+                || ts.isInterfaceDeclaration(child)) {
                 if ((child.name?.text ?? "default") === path[index]) {
                     return walkPath(index + 1, child);
                 }
             }
-            if (ts.isFunctionDeclaration(child) ||
-                ts.isPropertyDeclaration(child) ||
-                ts.isVariableDeclaration(child) ||
-                ts.isMethodDeclaration(child) ||
-                ts.isMethodSignature(child) ||
-                ts.isPropertySignature(child) ||
-                ts.isPropertyAssignment(child)) {
+            if (ts.isFunctionDeclaration(child)
+                || ts.isPropertyDeclaration(child)
+                || ts.isVariableDeclaration(child)
+                || ts.isMethodDeclaration(child)
+                || ts.isMethodSignature(child)
+                || ts.isPropertySignature(child)
+                || ts.isPropertyAssignment(child)) {
                 if (child.name?.getText() === path[index]) {
                     return walkPath(index + 1, child);
                 }
@@ -95,6 +95,8 @@ function discoverSourceFilePosition(sf, qualifiedName) {
 }
 const sourceFileCache = new Map();
 export function getLineNumber(symbolId) {
+    if (!symbolId.fileName)
+        throw new Error("Requires a filename");
     let sf = sourceFileCache.get(symbolId.fileName);
     if (!sf) {
         try {
@@ -143,16 +145,15 @@ export function load(app) {
                 else {
                     const publishDate = Date.parse(update[1]);
                     app.logger.verbose(`${PLUGIN_PREFIX} @types/${packageName} was updated at ${new Date(publishDate).toISOString()}`);
-                    hash =
-                        findDtCommitHash(publishDate / 1000) ??
-                            DT_DEFAULT_BRANCH;
+                    hash = findDtCommitHash(publishDate / 1000)
+                        ?? DT_DEFAULT_BRANCH;
                 }
             }
             catch {
                 hash = DT_DEFAULT_BRANCH;
             }
-            if (hash === DT_DEFAULT_BRANCH &&
-                app.options.getValue("warnOnUnstableDtLink")) {
+            if (hash === DT_DEFAULT_BRANCH
+                && app.options.getValue("warnOnUnstableDtLink")) {
                 const version = JSON.parse(readFileSync(packagePath + "/package.json", "utf-8")).version;
                 app.logger.warn(`${PLUGIN_PREFIX} Failed to discover git hash for @types/${packageName} v${version}, linking to ${DT_DEFAULT_BRANCH} branch. This will eventually cause broken links.`);
             }
@@ -162,7 +163,7 @@ export function load(app) {
         return publishHashCache.get(packagePath);
     }
     function resolveSymbol(_declaration, _refl, _part, symbolId) {
-        if (!symbolId) {
+        if (!symbolId || !symbolId.packageName.startsWith("@types/") || !symbolId.fileName) {
             return;
         }
         // Attempt to decide package name from path if it contains "node_modules"
@@ -172,16 +173,14 @@ export function load(app) {
         startIndex += "node_modules/@types/".length;
         let stopIndex = symbolId.fileName.indexOf("/", startIndex);
         const packageName = symbolId.fileName.substring(startIndex, stopIndex);
-        const innerPath = symbolId.fileName
-            .substring(stopIndex)
-            .replaceAll("\\", "/");
         const hash = getPublishHash(symbolId.fileName.substring(0, stopIndex), packageName);
         return [
             "https://github.com/DefinitelyTyped/DefinitelyTyped/blob/",
             hash,
             "/types/",
-            packageName,
-            innerPath,
+            symbolId.packageName.replace("@types/", ""),
+            "/",
+            symbolId.packagePath,
             "#L",
             getLineNumber(symbolId),
         ].join("");

package/package.json

@@ -1,18 +1,16 @@
 {
   "name": "typedoc-plugin-dt-links",
-  "version": "1.1.16",
+  "version": "2.0.0",
   "main": "dist/plugin.js",
   "type": "module",
   "license": "MIT",
   "devDependencies": {
     "@types/node": "22.7.4",
     "@voxpelli/node-test-pretty-reporter": "^1.1.2",
-    "faucet": "^0.0.4",
-    "prettier": "^3.3.3",
-    "tap-prettify": "^0.0.2",
-    "tsx": "^4.19.2",
-    "typedoc": "^0.27.0-beta.1",
-    "typescript": "^5.7.2"
+    "dprint": "^0.49.0",
+    "tsx": "^4.19.3",
+    "typedoc": "^0.28.0",
+    "typescript": "^5.8.2"
   },
   "keywords": [
     "typedoc-plugin"
@@ -22,12 +20,7 @@
     "data/dt_history.txt"
   ],
   "peerDependencies": {
-    "typedoc": ">= 0.23.14 || 0.24.x || 0.25.x || 0.26.x || 0.27.x"
-  },
-  "scripts": {
-    "lint": "prettier --check .",
-    "build": "tsc",
-    "test": "tsx --test --test-reporter=@voxpelli/node-test-pretty-reporter src/test/plugin.test.ts"
+    "typedoc": "0.28.x"
   },
   "repository": {
     "type": "git",
@@ -35,5 +28,10 @@
   },
   "bugs": {
     "url": "https://github.com/Gerrit0/typedoc-plugin-dt-links/issues"
+  },
+  "scripts": {
+    "lint": "dprint check",
+    "build": "tsc",
+    "test": "tsx --test --test-reporter=@voxpelli/node-test-pretty-reporter src/test/plugin.test.ts"
   }
-}
+}