Skip to content

Commit 21a26ca

Browse files
a-tarasyuka-tarasyuk
committed
feat(25259): add better error to report for equals instead of the colon in object literals
1 parent 1aaa2ec commit 21a26ca

12 files changed

+129
-19
lines changed

‎src/compiler/checker.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23889,7 +23889,10 @@ namespace ts {
2388923889
memberDecl.kind === SyntaxKind.ShorthandPropertyAssignment ||
2389023890
isObjectLiteralMethod(memberDecl)) {
2389123891
let type = memberDecl.kind === SyntaxKind.PropertyAssignment ? checkPropertyAssignment(memberDecl, checkMode) :
23892-
memberDecl.kind === SyntaxKind.ShorthandPropertyAssignment ? checkExpressionForMutableLocation(memberDecl.name, checkMode) :
23892+
// avoid resolving the left side of the ShorthandPropertyAssignment outside of the destructuring
23893+
// for error recovery purposes. For example, if a user wrote `{ a = 100 }` instead of `{ a: 100 }`.
23894+
// we don't want to say "could not find 'a'".
23895+
memberDecl.kind === SyntaxKind.ShorthandPropertyAssignment ? checkExpressionForMutableLocation(!inDestructuringPattern && memberDecl.objectAssignmentInitializer ? memberDecl.objectAssignmentInitializer : memberDecl.name, checkMode) :
2389323896
checkObjectLiteralMethod(memberDecl, checkMode);
2389423897
if (isInJavascript) {
2389523898
const jsDocType = getTypeForDeclarationFromJSDocComment(memberDecl);
@@ -38218,7 +38221,7 @@ namespace ts {
3821838221
if (prop.kind === SyntaxKind.ShorthandPropertyAssignment && !inDestructuring && prop.objectAssignmentInitializer) {
3821938222
// having objectAssignmentInitializer is only valid in ObjectAssignmentPattern
3822038223
// outside of destructuring it is a syntax error
38221-
return grammarErrorOnNode(prop.equalsToken!, Diagnostics.can_only_be_used_in_an_object_literal_property_inside_a_destructuring_assignment);
38224+
return grammarErrorOnNode(prop.equalsToken!, Diagnostics.Did_you_mean_to_use_a_Colon_When_following_property_names_in_an_object_literal_implies_a_destructuring_assignment);
3822238225
}
3822338226

3822438227
if (name.kind === SyntaxKind.PrivateIdentifier) {

‎src/compiler/diagnosticMessages.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -880,7 +880,7 @@
880880
"category": "Error",
881881
"code": 1308
882882
},
883-
"'=' can only be used in an object literal property inside a destructuring assignment.": {
883+
"Did you mean to use a ':'? When following property names in an object literal, '=' implies a destructuring assignment.": {
884884
"category": "Error",
885885
"code": 1312
886886
},
@@ -5819,6 +5819,10 @@
58195819
"category": "Message",
58205820
"code": 95137
58215821
},
5822+
"Switch each misused '{0}' to '{1}'": {
5823+
"category": "Message",
5824+
"code": 95138
5825+
},
58225826

58235827
"No value exists in scope for the shorthand property '{0}'. Either declare one or provide an initializer.": {
58245828
"category": "Error",

‎src/services/codefixes/fixPropertyAssignment.ts

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/* @internal */
2+
namespace ts.codefix {
3+
const fixId = "fixPropertyAssignment";
4+
const errorCodes = [
5+
Diagnostics.Did_you_mean_to_use_a_Colon_When_following_property_names_in_an_object_literal_implies_a_destructuring_assignment.code
6+
];
7+
8+
registerCodeFix({
9+
errorCodes,
10+
fixIds: [fixId],
11+
getCodeActions(context) {
12+
const { sourceFile, span } = context;
13+
const property = getProperty(sourceFile, span.start);
14+
const changes = textChanges.ChangeTracker.with(context, t => doChange(t, context.sourceFile, property));
15+
return [createCodeFixAction(fixId, changes, [Diagnostics.Change_0_to_1, "=", ":"], fixId, [Diagnostics.Switch_each_misused_0_to_1, "=", ":"])];
16+
},
17+
getAllCodeActions: context =>
18+
codeFixAll(context, errorCodes, (changes, diag) => doChange(changes, diag.file, getProperty(diag.file, diag.start)))
19+
});
20+
21+
function doChange(changes: textChanges.ChangeTracker, sourceFile: SourceFile, node: ShorthandPropertyAssignment): void {
22+
changes.replaceNode(sourceFile, node, factory.createPropertyAssignment(node.name, node.objectAssignmentInitializer as Expression));
23+
}
24+
25+
function getProperty(sourceFile: SourceFile, pos: number): ShorthandPropertyAssignment {
26+
return cast(getTokenAtPosition(sourceFile, pos).parent, isShorthandPropertyAssignment);
27+
}
28+
}

‎src/services/tsconfig.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@
7676
"codefixes/fixEnableExperimentalDecorators.ts",
7777
"codefixes/fixEnableJsxFlag.ts",
7878
"codefixes/fixModuleAndTargetOptions.ts",
79+
"codefixes/fixPropertyAssignment.ts",
7980
"codefixes/fixExtendsInterfaceBecomesImplements.ts",
8081
"codefixes/fixForgottenThisPropertyAccess.ts",
8182
"codefixes/fixInvalidJsxCharacters.ts",

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,10 @@ tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts(85,19): erro
1111
Types of property 'x' are incompatible.
1212
Type 'number' is not assignable to type 'string'.
1313
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts(85,26): error TS2322: Type 'number' is not assignable to type 'string'.
14-
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts(111,12): error TS18004: No value exists in scope for the shorthand property 's'. Either declare one or provide an initializer.
15-
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts(111,14): error TS1312: '=' can only be used in an object literal property inside a destructuring assignment.
14+
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts(111,14): error TS1312: Did you mean to use a ':'? When following property names in an object literal, '=' implies a destructuring assignment.
1615

1716

18-
==== tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts (13 errors) ====
17+
==== tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts (12 errors) ====
1918
(function() {
2019
var s0;
2120
for ({ s0 = 5 } of [{ s0: 1 }]) {
@@ -153,10 +152,8 @@ tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring.ts(111,14): err
153152

154153
(function() {
155154
let a = { s = 5 };
156-
~
157-
!!! error TS18004: No value exists in scope for the shorthand property 's'. Either declare one or provide an initializer.
158155
~
159-
!!! error TS1312: '=' can only be used in an object literal property inside a destructuring assignment.
156+
!!! error TS1312: Did you mean to use a ':'? When following property names in an object literal, '=' implies a destructuring assignment.
160157
});
161158

162159
function foo({a = 4, b = { x: 5 }}) {

‎tests/baselines/reference/shorthandPropertyAssignmentsInDestructuring.types

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -417,8 +417,8 @@
417417
>function() { let a = { s = 5 };} : () => void
418418

419419
let a = { s = 5 };
420-
>a : { s: any; }
421-
>{ s = 5 } : { s: any; }
420+
>a : { s: number; }
421+
>{ s = 5 } : { s: number; }
422422
>s : any
423423
>5 : 5
424424

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,10 @@ tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts(85,19):
1111
Types of property 'x' are incompatible.
1212
Type 'number' is not assignable to type 'string'.
1313
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts(85,26): error TS2322: Type 'number' is not assignable to type 'string'.
14-
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts(111,12): error TS18004: No value exists in scope for the shorthand property 's'. Either declare one or provide an initializer.
15-
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts(111,14): error TS1312: '=' can only be used in an object literal property inside a destructuring assignment.
14+
tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts(111,14): error TS1312: Did you mean to use a ':'? When following property names in an object literal, '=' implies a destructuring assignment.
1615

1716

18-
==== tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts (13 errors) ====
17+
==== tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts (12 errors) ====
1918
(function() {
2019
var s0;
2120
for ({ s0 = 5 } of [{ s0: 1 }]) {
@@ -153,10 +152,8 @@ tests/cases/compiler/shorthandPropertyAssignmentsInDestructuring_ES6.ts(111,14):
153152

154153
(function() {
155154
let a = { s = 5 };
156-
~
157-
!!! error TS18004: No value exists in scope for the shorthand property 's'. Either declare one or provide an initializer.
158155
~
159-
!!! error TS1312: '=' can only be used in an object literal property inside a destructuring assignment.
156+
!!! error TS1312: Did you mean to use a ':'? When following property names in an object literal, '=' implies a destructuring assignment.
160157
});
161158

162159
function foo({a = 4, b = { x: 5 }}) {

‎tests/baselines/reference/shorthandPropertyAssignmentsInDestructuring_ES6.types

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -417,8 +417,8 @@
417417
>function() { let a = { s = 5 };} : () => void
418418

419419
let a = { s = 5 };
420-
>a : { s: any; }
421-
>{ s = 5 } : { s: any; }
420+
>a : { s: number; }
421+
>{ s = 5 } : { s: number; }
422422
>s : any
423423
>5 : 5
424424

‎tests/cases/fourslash/codeFixPropertyAssignment1.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/// <reference path='fourslash.ts'/>
2+
3+
////const a = {
4+
//// x/**/= 1
5+
////}
6+
7+
verify.codeFix({
8+
description: [ts.Diagnostics.Change_0_to_1.message, "=", ":"],
9+
index: 0,
10+
newFileContent:
11+
`const a = {
12+
x: 1
13+
}`,
14+
});

‎tests/cases/fourslash/codeFixPropertyAssignment2.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/// <reference path='fourslash.ts'/>
2+
3+
////const a = {
4+
//// x /**/= 1
5+
////}
6+
7+
verify.codeFix({
8+
description: [ts.Diagnostics.Change_0_to_1.message, "=", ":"],
9+
index: 0,
10+
newFileContent:
11+
`const a = {
12+
x: 1
13+
}`,
14+
});

‎tests/cases/fourslash/codeFixPropertyAssignment3.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/// <reference path='fourslash.ts'/>
2+
3+
////const a = {
4+
//// x: 1,
5+
//// y /**/= 1,
6+
//// z: 1
7+
////}
8+
9+
verify.codeFix({
10+
description: [ts.Diagnostics.Change_0_to_1.message, "=", ":"],
11+
index: 0,
12+
newFileContent:
13+
`const a = {
14+
x: 1,
15+
y: 1,
16+
z: 1
17+
}`,
18+
});

‎tests/cases/fourslash/codeFixPropertyAssignment_fixAll.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/// <reference path='fourslash.ts'/>
2+
3+
////const a = {
4+
//// x: 1,
5+
//// y = 1,
6+
//// z: 1
7+
////}
8+
////const b = {
9+
//// x = 1,
10+
//// y: 1
11+
////}
12+
////const c = {
13+
//// x: 1,
14+
//// y = 1
15+
////}
16+
17+
verify.codeFixAll({
18+
fixAllDescription: "Switch each misused '=' to ':'",
19+
fixId: "fixPropertyAssignment",
20+
newFileContent:
21+
`const a = {
22+
x: 1,
23+
y: 1,
24+
z: 1
25+
}
26+
const b = {
27+
x: 1,
28+
y: 1
29+
}
30+
const c = {
31+
x: 1,
32+
y: 1
33+
}`
34+
});

0 commit comments

Comments
 (0)