Fix defined in edge case

Resolves #2307

CHANGELOG.md

@@ -14,6 +14,7 @@
 ### Bug Fixes
 
 -   `notDocumented` validation will no longer require documentation for data within parameters that cannot be documented via `@param`, #2291.
+-   "defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, #2307.
 -   Type parameters will now be resolved for arrow-methods on classes like regular class methods, #2320.
 -   TypeDoc now inherits `typedocOptions` fields from extended tsconfig files, #2334.
 -   Methods which return function types no longer have duplicated comments, #2336.

src/lib/converter/plugins/SourcePlugin.ts

@@ -183,6 +183,10 @@ export class SourcePlugin extends ConverterComponent {
                 continue;
             }
 
+            if (replaceSourcesWithParentSources(refl)) {
+                refl.sources = (refl.parent as DeclarationReflection).sources;
+            }
+
             for (const source of refl.sources || []) {
                 if (this.disableGit || gitIsInstalled()) {
                     const repo = this.getRepository(
@@ -255,3 +259,39 @@ function getLocationNode(node: ts.Node) {
     if (isNamedNode(node)) return node.name;
     return node;
 }
+
+function replaceSourcesWithParentSources(
+    refl: SignatureReflection | DeclarationReflection,
+) {
+    if (refl instanceof DeclarationReflection || !refl.sources) {
+        return false;
+    }
+
+    if (refl.name === "privateArrow") {
+        console.log("privateArrow");
+    }
+
+    const symbol = refl.project.getSymbolFromReflection(refl.parent);
+    if (!symbol?.declarations) {
+        return false;
+    }
+
+    for (const decl of symbol.declarations) {
+        const file = decl.getSourceFile();
+        const pos = file.getLineAndCharacterOfPosition(decl.pos);
+        const end = file.getLineAndCharacterOfPosition(decl.end);
+
+        if (
+            refl.sources.some(
+                (src) =>
+                    src.fullFileName === file.fileName &&
+                    pos.line <= src.line - 1 &&
+                    src.line - 1 <= end.line,
+            )
+        ) {
+            return false;
+        }
+    }
+
+    return true;
+}

src/lib/models/sources/file.ts

@@ -19,7 +19,7 @@ export class SourceReference {
     fullFileName: string;
 
     /**
-     * The number of the line that emitted the declaration.
+     * The one based number of the line that emitted the declaration.
      */
     line: number;
 

src/test/converter/js/specs.json

@@ -894,9 +894,9 @@
               "sources": [
                 {
                   "fileName": "index.js",
-                  "line": 49,
-                  "character": 3,
-                  "url": "typedoc://index.js#L49"
+                  "line": 55,
+                  "character": 13,
+                  "url": "typedoc://index.js#L55"
                 }
               ],
               "parameters": [

src/test/converter/mixin/specs.json

@@ -585,9 +585,9 @@
                             "sources": [
                               {
                                 "fileName": "mixin.ts",
-                                "line": 9,
-                                "character": 41,
-                                "url": "typedoc://mixin.ts#L9"
+                                "line": 34,
+                                "character": 10,
+                                "url": "typedoc://mixin.ts#L34"
                               }
                             ],
                             "parameters": [
@@ -1656,9 +1656,9 @@
                       "sources": [
                         {
                           "fileName": "mixin.ts",
-                          "line": 9,
-                          "character": 41,
-                          "url": "typedoc://mixin.ts#L9"
+                          "line": 34,
+                          "character": 10,
+                          "url": "typedoc://mixin.ts#L34"
                         }
                       ],
                       "parameters": [
@@ -1852,9 +1852,9 @@
                       "sources": [
                         {
                           "fileName": "mixin.ts",
-                          "line": 9,
-                          "character": 41,
-                          "url": "typedoc://mixin.ts#L9"
+                          "line": 54,
+                          "character": 10,
+                          "url": "typedoc://mixin.ts#L54"
                         }
                       ],
                       "parameters": [
@@ -2041,9 +2041,9 @@
                       "sources": [
                         {
                           "fileName": "mixin.ts",
-                          "line": 9,
-                          "character": 41,
-                          "url": "typedoc://mixin.ts#L9"
+                          "line": 74,
+                          "character": 10,
+                          "url": "typedoc://mixin.ts#L74"
                         }
                       ],
                       "parameters": [

src/test/converter2/issues/gh2307.ts

@@ -0,0 +1,10 @@
+const times = (b: number) => (a: number) => a * b;
+
+export const double = times(2);
+
+export const foo = () => 123;
+
+export const all: {
+    <T>(fn: (item: T) => boolean, iterator: Iterable<T>): boolean;
+    <T>(fn: (item: T) => boolean): (iterator: Iterable<T>) => boolean;
+} = () => false as any;

src/test/issues.c2.test.ts

@@ -1143,6 +1143,21 @@ describe("Issue Tests", () => {
         equal(tp.flags.isConst, true);
     });
 
+    it("Detects source locations coming from types and prefers value declarations, #2307", () => {
+        const project = convert();
+
+        const getLines = (name: string) => {
+            const refl = query(project, name);
+            return refl.signatures?.flatMap((sig) =>
+                sig.sources!.map((src) => src.line),
+            );
+        };
+
+        equal(getLines("double"), [3]);
+        equal(getLines("foo"), [5]);
+        equal(getLines("all"), [8, 9]);
+    });
+
     it("Uses type parameters from parent class in arrow-methods, #2320", () => {
         const project = convert();
         const arrow = querySig(project, "ResolvedSubclass.arrowFunction");