Skip to content

Commit 6a7323f

Browse files
Gerrit0Gerrit0
committed
Always link to the first line of a file if it creates a module declaration
Closes #2207
1 parent a41ac2d commit 6a7323f

File tree

16 files changed

+93
-72
lines changed

16 files changed

+93
-72
lines changed

‎src/lib/converter/plugins/SourcePlugin.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ export class SourcePlugin extends ConverterComponent {
9393
sourceFile,
9494
node.name.getStart()
9595
);
96+
} else if (ts.isSourceFile(node)) {
97+
position = { character: 0, line: 0 };
9698
} else {
9799
position = ts.getLineAndCharacterOfPosition(
98100
sourceFile,

‎src/test/converter/class/specs-with-lump-categories.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -475,9 +475,9 @@
475475
"sources": [
476476
{
477477
"fileName": "access.ts",
478-
"line": 5,
478+
"line": 1,
479479
"character": 0,
480-
"url": "typedoc://access.ts#L5"
480+
"url": "typedoc://access.ts#L1"
481481
}
482482
]
483483
},
@@ -2354,9 +2354,9 @@
23542354
"sources": [
23552355
{
23562356
"fileName": "class.ts",
2357-
"line": 8,
2357+
"line": 1,
23582358
"character": 0,
2359-
"url": "typedoc://class.ts#L8"
2359+
"url": "typedoc://class.ts#L1"
23602360
}
23612361
]
23622362
},
@@ -2919,9 +2919,9 @@
29192919
"sources": [
29202920
{
29212921
"fileName": "constructor-properties.ts",
2922-
"line": 4,
2922+
"line": 1,
29232923
"character": 0,
2924-
"url": "typedoc://constructor-properties.ts#L4"
2924+
"url": "typedoc://constructor-properties.ts#L1"
29252925
}
29262926
]
29272927
},
@@ -3352,9 +3352,9 @@
33523352
"sources": [
33533353
{
33543354
"fileName": "decorators.ts",
3355-
"line": 4,
3355+
"line": 1,
33563356
"character": 0,
3357-
"url": "typedoc://decorators.ts#L4"
3357+
"url": "typedoc://decorators.ts#L1"
33583358
}
33593359
]
33603360
},
@@ -4024,9 +4024,9 @@
40244024
"sources": [
40254025
{
40264026
"fileName": "events-overloads.ts",
4027-
"line": 6,
4027+
"line": 1,
40284028
"character": 0,
4029-
"url": "typedoc://events-overloads.ts#L6"
4029+
"url": "typedoc://events-overloads.ts#L1"
40304030
}
40314031
]
40324032
},
@@ -4596,9 +4596,9 @@
45964596
"sources": [
45974597
{
45984598
"fileName": "generic-class.ts",
4599-
"line": 5,
4599+
"line": 1,
46004600
"character": 0,
4601-
"url": "typedoc://generic-class.ts#L5"
4601+
"url": "typedoc://generic-class.ts#L1"
46024602
}
46034603
]
46044604
},
@@ -5014,9 +5014,9 @@
50145014
"sources": [
50155015
{
50165016
"fileName": "this.ts",
5017-
"line": 6,
5017+
"line": 1,
50185018
"character": 0,
5019-
"url": "typedoc://this.ts#L6"
5019+
"url": "typedoc://this.ts#L1"
50205020
}
50215021
]
50225022
},
@@ -5275,9 +5275,9 @@
52755275
"sources": [
52765276
{
52775277
"fileName": "type-operator.ts",
5278-
"line": 8,
5278+
"line": 1,
52795279
"character": 0,
5280-
"url": "typedoc://type-operator.ts#L8"
5280+
"url": "typedoc://type-operator.ts#L1"
52815281
}
52825282
]
52835283
}

‎src/test/converter/class/specs.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -475,9 +475,9 @@
475475
"sources": [
476476
{
477477
"fileName": "access.ts",
478-
"line": 5,
478+
"line": 1,
479479
"character": 0,
480-
"url": "typedoc://access.ts#L5"
480+
"url": "typedoc://access.ts#L1"
481481
}
482482
]
483483
},
@@ -2350,9 +2350,9 @@
23502350
"sources": [
23512351
{
23522352
"fileName": "class.ts",
2353-
"line": 8,
2353+
"line": 1,
23542354
"character": 0,
2355-
"url": "typedoc://class.ts#L8"
2355+
"url": "typedoc://class.ts#L1"
23562356
}
23572357
]
23582358
},
@@ -2915,9 +2915,9 @@
29152915
"sources": [
29162916
{
29172917
"fileName": "constructor-properties.ts",
2918-
"line": 4,
2918+
"line": 1,
29192919
"character": 0,
2920-
"url": "typedoc://constructor-properties.ts#L4"
2920+
"url": "typedoc://constructor-properties.ts#L1"
29212921
}
29222922
]
29232923
},
@@ -3348,9 +3348,9 @@
33483348
"sources": [
33493349
{
33503350
"fileName": "decorators.ts",
3351-
"line": 4,
3351+
"line": 1,
33523352
"character": 0,
3353-
"url": "typedoc://decorators.ts#L4"
3353+
"url": "typedoc://decorators.ts#L1"
33543354
}
33553355
]
33563356
},
@@ -4020,9 +4020,9 @@
40204020
"sources": [
40214021
{
40224022
"fileName": "events-overloads.ts",
4023-
"line": 6,
4023+
"line": 1,
40244024
"character": 0,
4025-
"url": "typedoc://events-overloads.ts#L6"
4025+
"url": "typedoc://events-overloads.ts#L1"
40264026
}
40274027
]
40284028
},
@@ -4592,9 +4592,9 @@
45924592
"sources": [
45934593
{
45944594
"fileName": "generic-class.ts",
4595-
"line": 5,
4595+
"line": 1,
45964596
"character": 0,
4597-
"url": "typedoc://generic-class.ts#L5"
4597+
"url": "typedoc://generic-class.ts#L1"
45984598
}
45994599
]
46004600
},
@@ -5010,9 +5010,9 @@
50105010
"sources": [
50115011
{
50125012
"fileName": "this.ts",
5013-
"line": 6,
5013+
"line": 1,
50145014
"character": 0,
5015-
"url": "typedoc://this.ts#L6"
5015+
"url": "typedoc://this.ts#L1"
50165016
}
50175017
]
50185018
},
@@ -5271,9 +5271,9 @@
52715271
"sources": [
52725272
{
52735273
"fileName": "type-operator.ts",
5274-
"line": 8,
5274+
"line": 1,
52755275
"character": 0,
5276-
"url": "typedoc://type-operator.ts#L8"
5276+
"url": "typedoc://type-operator.ts#L1"
52775277
}
52785278
]
52795279
}

‎src/test/converter/comment/specs.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -205,9 +205,9 @@
205205
"sources": [
206206
{
207207
"fileName": "comment.ts",
208-
"line": 5,
208+
"line": 1,
209209
"character": 0,
210-
"url": "typedoc://comment.ts#L5"
210+
"url": "typedoc://comment.ts#L1"
211211
}
212212
]
213213
},
@@ -306,9 +306,9 @@
306306
"sources": [
307307
{
308308
"fileName": "comment2.ts",
309-
"line": 8,
309+
"line": 1,
310310
"character": 0,
311-
"url": "typedoc://comment2.ts#L8"
311+
"url": "typedoc://comment2.ts#L1"
312312
}
313313
]
314314
},
@@ -407,9 +407,9 @@
407407
"sources": [
408408
{
409409
"fileName": "comment3.ts",
410-
"line": 8,
410+
"line": 1,
411411
"character": 0,
412-
"url": "typedoc://comment3.ts#L8"
412+
"url": "typedoc://comment3.ts#L1"
413413
}
414414
]
415415
},
@@ -504,9 +504,9 @@
504504
"sources": [
505505
{
506506
"fileName": "comment4.ts",
507-
"line": 11,
507+
"line": 1,
508508
"character": 0,
509-
"url": "typedoc://comment4.ts#L11"
509+
"url": "typedoc://comment4.ts#L1"
510510
}
511511
]
512512
}

‎src/test/converter/exports/specs.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -893,9 +893,9 @@
893893
"sources": [
894894
{
895895
"fileName": "mod.ts",
896-
"line": 8,
896+
"line": 1,
897897
"character": 0,
898-
"url": "typedoc://mod.ts#L8"
898+
"url": "typedoc://mod.ts#L1"
899899
}
900900
]
901901
},
@@ -959,9 +959,9 @@
959959
"sources": [
960960
{
961961
"fileName": "no-doc-members.ts",
962-
"line": 6,
962+
"line": 1,
963963
"character": 0,
964-
"url": "typedoc://no-doc-members.ts#L6"
964+
"url": "typedoc://no-doc-members.ts#L1"
965965
}
966966
]
967967
}

‎src/test/converter/exports/specs.nodoc.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,9 @@
233233
"sources": [
234234
{
235235
"fileName": "mod.ts",
236-
"line": 8,
236+
"line": 1,
237237
"character": 0,
238-
"url": "typedoc://mod.ts#L8"
238+
"url": "typedoc://mod.ts#L1"
239239
}
240240
]
241241
},
@@ -267,9 +267,9 @@
267267
"sources": [
268268
{
269269
"fileName": "no-doc-members.ts",
270-
"line": 6,
270+
"line": 1,
271271
"character": 0,
272-
"url": "typedoc://no-doc-members.ts#L6"
272+
"url": "typedoc://no-doc-members.ts#L1"
273273
}
274274
]
275275
}

‎src/test/converter/function/specs.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2577,9 +2577,9 @@
25772577
"sources": [
25782578
{
25792579
"fileName": "function.ts",
2580-
"line": 4,
2580+
"line": 1,
25812581
"character": 0,
2582-
"url": "typedoc://function.ts#L4"
2582+
"url": "typedoc://function.ts#L1"
25832583
}
25842584
]
25852585
},
@@ -2897,9 +2897,9 @@
28972897
"sources": [
28982898
{
28992899
"fileName": "generic-function.ts",
2900-
"line": 7,
2900+
"line": 1,
29012901
"character": 0,
2902-
"url": "typedoc://generic-function.ts#L7"
2902+
"url": "typedoc://generic-function.ts#L1"
29032903
}
29042904
]
29052905
},

‎src/test/converter/inheritance/specs.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -656,9 +656,9 @@
656656
"sources": [
657657
{
658658
"fileName": "inherit-doc.ts",
659-
"line": 6,
659+
"line": 1,
660660
"character": 0,
661-
"url": "typedoc://inherit-doc.ts#L6"
661+
"url": "typedoc://inherit-doc.ts#L1"
662662
}
663663
]
664664
},

‎src/test/converter/interface/specs.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -649,9 +649,9 @@
649649
"sources": [
650650
{
651651
"fileName": "interface-empty.ts",
652-
"line": 4,
652+
"line": 1,
653653
"character": 0,
654-
"url": "typedoc://interface-empty.ts#L4"
654+
"url": "typedoc://interface-empty.ts#L1"
655655
}
656656
]
657657
},

‎src/test/converter/js/specs.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@
9898
"sources": [
9999
{
100100
"fileName": "export-eq-type.js",
101-
"line": 4,
101+
"line": 1,
102102
"character": 0,
103-
"url": "typedoc://export-eq-type.js#L4"
103+
"url": "typedoc://export-eq-type.js#L1"
104104
}
105105
]
106106
},
@@ -960,9 +960,9 @@
960960
"sources": [
961961
{
962962
"fileName": "index.js",
963-
"line": 55,
963+
"line": 1,
964964
"character": 0,
965-
"url": "typedoc://index.js#L55"
965+
"url": "typedoc://index.js#L1"
966966
}
967967
]
968968
}

‎src/test/converter/types/specs.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -936,9 +936,9 @@
936936
"sources": [
937937
{
938938
"fileName": "parens.ts",
939-
"line": 3,
939+
"line": 1,
940940
"character": 0,
941-
"url": "typedoc://parens.ts#L3"
941+
"url": "typedoc://parens.ts#L1"
942942
}
943943
]
944944
},
@@ -1949,9 +1949,9 @@
19491949
"sources": [
19501950
{
19511951
"fileName": "union-or-intersection.ts",
1952-
"line": 4,
1952+
"line": 1,
19531953
"character": 0,
1954-
"url": "typedoc://union-or-intersection.ts#L4"
1954+
"url": "typedoc://union-or-intersection.ts#L1"
19551955
}
19561956
]
19571957
}

0 commit comments

Comments
 (0)