provide spelling suggestion for indexed access (microsoft#22225)

Kingwl · sandersn · commit 51e7ae0813e7 · 2018-06-21T13:40:41.000-07:00
* provide spelling suggestion for indexed access

* update merge

* accept baseline

* fix suggession return type

* allow string or identifier on getSuggestionForNonexistentProperty

* fix lint
diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
@@ -8845,7 +8845,15 @@ namespace ts {
                             error(accessExpression.argumentExpression, Diagnostics.Element_implicitly_has_an_any_type_because_index_expression_is_not_of_type_number);
                         }
                         else {
-                            error(accessExpression, Diagnostics.Element_implicitly_has_an_any_type_because_type_0_has_no_index_signature, typeToString(objectType));
+                            let suggestion: string | undefined;
+                            if (propName !== undefined && (suggestion = getSuggestionForNonexistentProperty(propName as string, objectType))) {
+                                if (suggestion !== undefined) {
+                                    error(accessExpression.argumentExpression, Diagnostics.Property_0_does_not_exist_on_type_1_Did_you_mean_2, propName as string, typeToString(objectType), suggestion);
+                                }
+                            }
+                            else {
+                                error(accessExpression, Diagnostics.Element_implicitly_has_an_any_type_because_type_0_has_no_index_signature, typeToString(objectType));
+                            }
                         }
                     }
                     return anyType;
@@ -17367,14 +17375,21 @@ namespace ts {
                     errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1_Did_you_mean_2, declarationNameToString(propNode), typeToString(containingType), suggestion);
                 }
                 else {
-                    errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1, declarationNameToString(propNode), typeToString(containingType));
+                    const suggestion = getSuggestionForNonexistentProperty(propNode, containingType);
+                    if (suggestion !== undefined) {
+                        errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1_Did_you_mean_2, declarationNameToString(propNode), typeToString(containingType), suggestion);
+                    }
+                    else {
+                        errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1, declarationNameToString(propNode), typeToString(containingType));
+                    }
                 }
             }
+
             diagnostics.add(createDiagnosticForNodeFromMessageChain(propNode, errorInfo));
         }
 
-        function getSuggestionForNonexistentProperty(node: Identifier, containingType: Type): string | undefined {
-            const suggestion = getSpellingSuggestionForName(idText(node), getPropertiesOfType(containingType), SymbolFlags.Value);
+        function getSuggestionForNonexistentProperty(name: Identifier | string, containingType: Type): string | undefined {
+            const suggestion = getSpellingSuggestionForName(isString(name) ? name : idText(name), getPropertiesOfType(containingType), SymbolFlags.Value);
             return suggestion && symbolName(suggestion);
         }
 
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -2976,7 +2976,7 @@ namespace ts {
          */
         /* @internal */ tryGetMemberInModuleExportsAndProperties(memberName: string, moduleSymbol: Symbol): Symbol | undefined;
         getApparentType(type: Type): Type;
-        getSuggestionForNonexistentProperty(node: Identifier, containingType: Type): string | undefined;
+        getSuggestionForNonexistentProperty(name: Identifier | string, containingType: Type): string | undefined;
         getSuggestionForNonexistentSymbol(location: Node, name: string, meaning: SymbolFlags): string | undefined;
         getSuggestionForNonexistentModule(node: Identifier, target: Symbol): string | undefined;
         getBaseConstraintOfType(type: Type): Type | undefined;
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -2659,7 +2659,7 @@ declare namespace ts {
          */
         tryGetMemberInModuleExportsAndProperties(memberName: string, moduleSymbol: Symbol): Symbol | undefined;
         getApparentType(type: Type): Type;
-        getSuggestionForNonexistentProperty(node: Identifier, containingType: Type): string | undefined;
+        getSuggestionForNonexistentProperty(name: Identifier | string, containingType: Type): string | undefined;
         getSuggestionForNonexistentSymbol(location: Node, name: string, meaning: SymbolFlags): string | undefined;
         getSuggestionForNonexistentModule(node: Identifier, target: Symbol): string | undefined;
         getBaseConstraintOfType(type: Type): Type | undefined;
diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -1904,7 +1904,7 @@ declare namespace ts {
         getAmbientModules(): Symbol[];
         tryGetMemberInModuleExports(memberName: string, moduleSymbol: Symbol): Symbol | undefined;
         getApparentType(type: Type): Type;
-        getSuggestionForNonexistentProperty(node: Identifier, containingType: Type): string | undefined;
+        getSuggestionForNonexistentProperty(name: Identifier | string, containingType: Type): string | undefined;
         getSuggestionForNonexistentSymbol(location: Node, name: string, meaning: SymbolFlags): string | undefined;
         getSuggestionForNonexistentModule(node: Identifier, target: Symbol): string | undefined;
         getBaseConstraintOfType(type: Type): Type | undefined;
diff --git a/tests/baselines/reference/indexedAccessImplicitlyAny.errors.txt b/tests/baselines/reference/indexedAccessImplicitlyAny.errors.txt
@@ -0,0 +1,13 @@
+tests/cases/compiler/indexedAccessImplicitlyAny.ts(3,3): error TS2551: Property 'foo' does not exist on type 'I'. Did you mean 'foof'?
+tests/cases/compiler/indexedAccessImplicitlyAny.ts(4,3): error TS2551: Property 'foo' does not exist on type 'I'. Did you mean 'foof'?
+
+
+==== tests/cases/compiler/indexedAccessImplicitlyAny.ts (2 errors) ====
+    interface I { foof: number };
+    declare const i: I;
+    i.foo;
+      ~~~
+!!! error TS2551: Property 'foo' does not exist on type 'I'. Did you mean 'foof'?
+    i["foo"];
+      ~~~~~
+!!! error TS2551: Property 'foo' does not exist on type 'I'. Did you mean 'foof'?
diff --git a/tests/baselines/reference/indexedAccessImplicitlyAny.js b/tests/baselines/reference/indexedAccessImplicitlyAny.js
@@ -0,0 +1,10 @@
+//// [indexedAccessImplicitlyAny.ts]
+interface I { foof: number };
+declare const i: I;
+i.foo;
+i["foo"];
+
+//// [indexedAccessImplicitlyAny.js]
+;
+i.foo;
+i["foo"];
diff --git a/tests/baselines/reference/indexedAccessImplicitlyAny.symbols b/tests/baselines/reference/indexedAccessImplicitlyAny.symbols
@@ -0,0 +1,15 @@
+=== tests/cases/compiler/indexedAccessImplicitlyAny.ts ===
+interface I { foof: number };
+>I : Symbol(I, Decl(indexedAccessImplicitlyAny.ts, 0, 0))
+>foof : Symbol(I.foof, Decl(indexedAccessImplicitlyAny.ts, 0, 13))
+
+declare const i: I;
+>i : Symbol(i, Decl(indexedAccessImplicitlyAny.ts, 1, 13))
+>I : Symbol(I, Decl(indexedAccessImplicitlyAny.ts, 0, 0))
+
+i.foo;
+>i : Symbol(i, Decl(indexedAccessImplicitlyAny.ts, 1, 13))
+
+i["foo"];
+>i : Symbol(i, Decl(indexedAccessImplicitlyAny.ts, 1, 13))
+
diff --git a/tests/baselines/reference/indexedAccessImplicitlyAny.types b/tests/baselines/reference/indexedAccessImplicitlyAny.types
@@ -0,0 +1,19 @@
+=== tests/cases/compiler/indexedAccessImplicitlyAny.ts ===
+interface I { foof: number };
+>I : I
+>foof : number
+
+declare const i: I;
+>i : I
+>I : I
+
+i.foo;
+>i.foo : any
+>i : I
+>foo : any
+
+i["foo"];
+>i["foo"] : any
+>i : I
+>"foo" : "foo"
+
diff --git a/tests/cases/compiler/indexedAccessImplicitlyAny.ts b/tests/cases/compiler/indexedAccessImplicitlyAny.ts
@@ -0,0 +1,7 @@
+// @target: esnext
+// @noImplicitAny: true
+
+interface I { foof: number };
+declare const i: I;
+i.foo;
+i["foo"];

Original file line number	Diff line number	Diff line change
`@@ -8845,7 +8845,15 @@ namespace ts {`
`8845`	`8845`	`error(accessExpression.argumentExpression, Diagnostics.Element_implicitly_has_an_any_type_because_index_expression_is_not_of_type_number);`
`8846`	`8846`	`}`
`8847`	`8847`	`else {`
`8848`		`- error(accessExpression, Diagnostics.Element_implicitly_has_an_any_type_because_type_0_has_no_index_signature, typeToString(objectType));`
	`8848`	`+ let suggestion: string \| undefined;`
	`8849`	`+ if (propName !== undefined && (suggestion = getSuggestionForNonexistentProperty(propName as string, objectType))) {`
	`8850`	`+ if (suggestion !== undefined) {`
	`8851`	`+ error(accessExpression.argumentExpression, Diagnostics.Property_0_does_not_exist_on_type_1_Did_you_mean_2, propName as string, typeToString(objectType), suggestion);`
	`8852`	`+ }`
	`8853`	`+ }`
	`8854`	`+ else {`
	`8855`	`+ error(accessExpression, Diagnostics.Element_implicitly_has_an_any_type_because_type_0_has_no_index_signature, typeToString(objectType));`
	`8856`	`+ }`
`8849`	`8857`	`}`
`8850`	`8858`	`}`
`8851`	`8859`	`return anyType;`
`@@ -17367,14 +17375,21 @@ namespace ts {`
`17367`	`17375`	`errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1_Did_you_mean_2, declarationNameToString(propNode), typeToString(containingType), suggestion);`
`17368`	`17376`	`}`
`17369`	`17377`	`else {`
`17370`		`- errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1, declarationNameToString(propNode), typeToString(containingType));`
	`17378`	`+ const suggestion = getSuggestionForNonexistentProperty(propNode, containingType);`
	`17379`	`+ if (suggestion !== undefined) {`
	`17380`	`+ errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1_Did_you_mean_2, declarationNameToString(propNode), typeToString(containingType), suggestion);`
	`17381`	`+ }`
	`17382`	`+ else {`
	`17383`	`+ errorInfo = chainDiagnosticMessages(errorInfo, Diagnostics.Property_0_does_not_exist_on_type_1, declarationNameToString(propNode), typeToString(containingType));`
	`17384`	`+ }`
`17371`	`17385`	`}`
`17372`	`17386`	`}`
	`17387`	`+`
`17373`	`17388`	`diagnostics.add(createDiagnosticForNodeFromMessageChain(propNode, errorInfo));`
`17374`	`17389`	`}`
`17375`	`17390`
`17376`		`- function getSuggestionForNonexistentProperty(node: Identifier, containingType: Type): string \| undefined {`
`17377`		`- const suggestion = getSpellingSuggestionForName(idText(node), getPropertiesOfType(containingType), SymbolFlags.Value);`
	`17391`	`+ function getSuggestionForNonexistentProperty(name: Identifier \| string, containingType: Type): string \| undefined {`
	`17392`	`+ const suggestion = getSpellingSuggestionForName(isString(name) ? name : idText(name), getPropertiesOfType(containingType), SymbolFlags.Value);`
`17378`	`17393`	`return suggestion && symbolName(suggestion);`
`17379`	`17394`	`}`
`17380`	`17395`