Skip to content

Commit f7dfc7f

Browse files
DanielRosenwasserDanielRosenwasser
authored
Merge pull request microsoft#25359 from Microsoft/useBeforeDeclareRelatedSpans
Related error spans on "used before declared" error messages
2 parents dc2dc8d + f675798 commit f7dfc7f

50 files changed

Lines changed: 145 additions & 8 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/compiler/checker.ts‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1655,14 +1655,25 @@ namespace ts {
16551655
if (declaration === undefined) return Debug.fail("Declaration to checkResolvedBlockScopedVariable is undefined");
16561656

16571657
if (!(declaration.flags & NodeFlags.Ambient) && !isBlockScopedNameDeclaredBeforeUse(declaration, errorLocation)) {
1658+
let diagnosticMessage;
1659+
const declarationName = declarationNameToString(getNameOfDeclaration(declaration));
16581660
if (result.flags & SymbolFlags.BlockScopedVariable) {
1659-
error(errorLocation, Diagnostics.Block_scoped_variable_0_used_before_its_declaration, declarationNameToString(getNameOfDeclaration(declaration)));
1661+
diagnosticMessage = error(errorLocation, Diagnostics.Block_scoped_variable_0_used_before_its_declaration, declarationName);
16601662
}
16611663
else if (result.flags & SymbolFlags.Class) {
1662-
error(errorLocation, Diagnostics.Class_0_used_before_its_declaration, declarationNameToString(getNameOfDeclaration(declaration)));
1664+
diagnosticMessage = error(errorLocation, Diagnostics.Class_0_used_before_its_declaration, declarationName);
16631665
}
16641666
else if (result.flags & SymbolFlags.RegularEnum) {
1665-
error(errorLocation, Diagnostics.Enum_0_used_before_its_declaration, declarationNameToString(getNameOfDeclaration(declaration)));
1667+
diagnosticMessage = error(errorLocation, Diagnostics.Enum_0_used_before_its_declaration, declarationName);
1668+
}
1669+
else {
1670+
Debug.assert(!!(result.flags & SymbolFlags.ConstEnum));
1671+
}
1672+
1673+
if (diagnosticMessage) {
1674+
addRelatedInfo(diagnosticMessage,
1675+
createDiagnosticForNode(declaration, Diagnostics._0_was_declared_here, declarationName)
1676+
);
16661677
}
16671678
}
16681679
}
@@ -17460,16 +17471,24 @@ namespace ts {
1746017471
return;
1746117472
}
1746217473

17474+
let diagnosticMessage;
17475+
const declarationName = idText(right);
1746317476
if (isInPropertyInitializer(node) &&
1746417477
!isBlockScopedNameDeclaredBeforeUse(valueDeclaration, right)
1746517478
&& !isPropertyDeclaredInAncestorClass(prop)) {
17466-
error(right, Diagnostics.Block_scoped_variable_0_used_before_its_declaration, idText(right));
17479+
diagnosticMessage = error(right, Diagnostics.Block_scoped_variable_0_used_before_its_declaration, declarationName);
1746717480
}
1746817481
else if (valueDeclaration.kind === SyntaxKind.ClassDeclaration &&
1746917482
node.parent.kind !== SyntaxKind.TypeReference &&
1747017483
!(valueDeclaration.flags & NodeFlags.Ambient) &&
1747117484
!isBlockScopedNameDeclaredBeforeUse(valueDeclaration, right)) {
17472-
error(right, Diagnostics.Class_0_used_before_its_declaration, idText(right));
17485+
diagnosticMessage = error(right, Diagnostics.Class_0_used_before_its_declaration, declarationName);
17486+
}
17487+
17488+
if (diagnosticMessage) {
17489+
addRelatedInfo(diagnosticMessage,
17490+
createDiagnosticForNode(valueDeclaration, Diagnostics._0_was_declared_here, declarationName)
17491+
);
1747317492
}
1747417493
}
1747517494

@@ -19083,8 +19102,8 @@ namespace ts {
1908319102
if (importNode && !isImportCall(importNode)) {
1908419103
const sigs = getSignaturesOfType(getTypeOfSymbol(getSymbolLinks(apparentType.symbol).target!), kind);
1908519104
if (!sigs || !sigs.length) return;
19086-
diagnostic.relatedInformation = diagnostic.relatedInformation || [];
19087-
diagnostic.relatedInformation.push(createDiagnosticForNode(importNode, Diagnostics.Type_originates_at_this_import_A_namespace_style_import_cannot_be_called_or_constructed_and_will_cause_a_failure_at_runtime_Consider_using_a_default_import_or_import_require_here_instead));
19105+
Debug.assert(!diagnostic.relatedInformation);
19106+
diagnostic.relatedInformation = [createDiagnosticForNode(importNode, Diagnostics.Type_originates_at_this_import_A_namespace_style_import_cannot_be_called_or_constructed_and_will_cause_a_failure_at_runtime_Consider_using_a_default_import_or_import_require_here_instead)];
1908819107
}
1908919108
}
1909019109

‎src/compiler/diagnosticMessages.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2397,6 +2397,10 @@
23972397
"category": "Error",
23982398
"code": 2727
23992399
},
2400+
"'{0}' was declared here.": {
2401+
"category": "Error",
2402+
"code": 2728
2403+
},
24002404

24012405
"Import declaration '{0}' is using private name '{1}'.": {
24022406
"category": "Error",

‎tests/baselines/reference/ES5For-of17.errors.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ tests/cases/conformance/statements/for-ofStatements/ES5For-of17.ts(3,20): error
77
for (let v of [v]) {
88
~
99
!!! error TS2448: Block-scoped variable 'v' used before its declaration.
10+
!!! related TS2728 tests/cases/conformance/statements/for-ofStatements/ES5For-of17.ts:3:14: 'v' was declared here.
1011
var x = v;
1112
v++;
1213
}

‎tests/baselines/reference/ES5For-of20.errors.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tests/cases/conformance/statements/for-ofStatements/ES5For-of20.ts(4,15): error
88
for (let v of [v]) {
99
~
1010
!!! error TS2448: Block-scoped variable 'v' used before its declaration.
11+
!!! related TS2728 tests/cases/conformance/statements/for-ofStatements/ES5For-of20.ts:3:14: 'v' was declared here.
1112
const v;
1213
~
1314
!!! error TS1155: 'const' declarations must be initialized.

‎tests/baselines/reference/ModuleAndClassWithSameNameAndCommonRoot.errors.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ tests/cases/conformance/internalModules/DeclarationMerging/simple.ts(2,31): erro
3232
export var Instance = new A();
3333
~
3434
!!! error TS2449: Class 'A' used before its declaration.
35+
!!! related TS2728 tests/cases/conformance/internalModules/DeclarationMerging/simple.ts:6:7: 'A' was declared here.
3536
}
3637

3738
// duplicate identifier

‎tests/baselines/reference/api/tsserverlibrary.d.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5418,6 +5418,7 @@ declare namespace ts {
54185418
Class_name_cannot_be_Object_when_targeting_ES5_with_module_0: DiagnosticMessage;
54195419
Cannot_find_lib_definition_for_0: DiagnosticMessage;
54205420
Cannot_find_lib_definition_for_0_Did_you_mean_1: DiagnosticMessage;
5421+
_0_was_declared_here: DiagnosticMessage;
54215422
Import_declaration_0_is_using_private_name_1: DiagnosticMessage;
54225423
Type_parameter_0_of_exported_class_has_or_is_using_private_name_1: DiagnosticMessage;
54235424
Type_parameter_0_of_exported_interface_has_or_is_using_private_name_1: DiagnosticMessage;

‎tests/baselines/reference/blockScopedBindingUsedBeforeDef.errors.txt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,16 @@ tests/cases/compiler/blockScopedBindingUsedBeforeDef.ts(8,7): error TS2448: Bloc
88
for (let {[a]: a} of [{ }]) continue;
99
~
1010
!!! error TS2448: Block-scoped variable 'a' used before its declaration.
11+
!!! related TS2728 tests/cases/compiler/blockScopedBindingUsedBeforeDef.ts:2:16: 'a' was declared here.
1112

1213
// 2:
1314
for (let {[a]: a} = { }; false; ) continue;
1415
~
1516
!!! error TS2448: Block-scoped variable 'a' used before its declaration.
17+
!!! related TS2728 tests/cases/compiler/blockScopedBindingUsedBeforeDef.ts:5:16: 'a' was declared here.
1618

1719
// 3:
1820
let {[b]: b} = { };
1921
~
20-
!!! error TS2448: Block-scoped variable 'b' used before its declaration.
22+
!!! error TS2448: Block-scoped variable 'b' used before its declaration.
23+
!!! related TS2728 tests/cases/compiler/blockScopedBindingUsedBeforeDef.ts:8:11: 'b' was declared here.

‎tests/baselines/reference/blockScopedVariablesUseBeforeDef.errors.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts(100,12): error TS2448:
99
let a = x;
1010
~
1111
!!! error TS2448: Block-scoped variable 'x' used before its declaration.
12+
!!! related TS2728 tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts:3:9: 'x' was declared here.
1213
let x;
1314
}
1415

@@ -67,6 +68,7 @@ tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts(100,12): error TS2448:
6768
static a = x;
6869
~
6970
!!! error TS2448: Block-scoped variable 'x' used before its declaration.
71+
!!! related TS2728 tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts:60:9: 'x' was declared here.
7072
}
7173
let x;
7274
}
@@ -76,6 +78,7 @@ tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts(100,12): error TS2448:
7678
static a = x;
7779
~
7880
!!! error TS2448: Block-scoped variable 'x' used before its declaration.
81+
!!! related TS2728 tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts:67:9: 'x' was declared here.
7982
}
8083
let x;
8184
}
@@ -113,6 +116,7 @@ tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts(100,12): error TS2448:
113116
a: x
114117
~
115118
!!! error TS2448: Block-scoped variable 'x' used before its declaration.
119+
!!! related TS2728 tests/cases/compiler/blockScopedVariablesUseBeforeDef.ts:102:9: 'x' was declared here.
116120
}
117121
let x
118122
}

‎tests/baselines/reference/circularImportAlias.errors.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ tests/cases/conformance/internalModules/importDeclarations/circularImportAlias.t
99
export class D extends a.C {
1010
~
1111
!!! error TS2449: Class 'C' used before its declaration.
12+
!!! related TS2728 tests/cases/conformance/internalModules/importDeclarations/circularImportAlias.ts:11:18: 'C' was declared here.
1213
id: number;
1314
}
1415
}

‎tests/baselines/reference/classAbstractInstantiations2.errors.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ tests/cases/conformance/classes/classDeclarations/classAbstractKeyword/classAbst
4545
var x : any = C;
4646
~
4747
!!! error TS2449: Class 'C' used before its declaration.
48+
!!! related TS2728 tests/cases/conformance/classes/classDeclarations/classAbstractKeyword/classAbstractInstantiations2.ts:26:7: 'C' was declared here.
4849
new x; // okay -- undefined behavior at runtime
4950

5051
class C extends B { } // error -- not declared abstract

0 commit comments

Comments
 (0)