Skip to content

add spelling suggestion support for module import #22283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1852,7 +1852,15 @@ namespace ts {
combineValueAndTypeSymbols(symbolFromVariable, symbolFromModule) :
symbolFromModule || symbolFromVariable;
if (!symbol) {
error(name, Diagnostics.Module_0_has_no_exported_member_1, getFullyQualifiedName(moduleSymbol), declarationNameToString(name));
const moduleName = getFullyQualifiedName(moduleSymbol);
const declarationName = declarationNameToString(name);
const suggestion = getSuggestionForNonexistentModule(name, targetSymbol);
if (suggestion !== undefined) {
error(name, Diagnostics.Module_0_has_no_exported_member_1_Did_you_mean_2, moduleName, declarationName, suggestion);
}
else {
error(name, Diagnostics.Module_0_has_no_exported_member_1, moduleName, declarationName);
}
}
return symbol;
}
Expand Down Expand Up @@ -16188,6 +16196,11 @@ namespace ts {
return result && symbolName(result);
}

function getSuggestionForNonexistentModule(name: Identifier, targetModule: Symbol): string | undefined {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one small nit: getSuggestionForNonexistentExport might be a better name. Not sure if it's worth changing through.

const suggestion = targetModule.exports && getSpellingSuggestionForName(idText(name), getExportsOfModuleAsArray(targetModule), SymbolFlags.ModuleMember);
return suggestion && symbolName(suggestion);
}

/**
* Given a name and a list of symbols whose names are *not* equal to the name, return a spelling suggestion if there is one that is close enough.
* Names less than length 3 only check for case-insensitive equality, not levenshtein distance.
Expand Down
4 changes: 4 additions & 0 deletions src/compiler/diagnosticMessages.json
Original file line number Diff line number Diff line change
Expand Up @@ -2317,6 +2317,10 @@
"category": "Error",
"code": 2723
},
"Module '{0}' has no exported member '{1}'. Did you mean '{2}'?": {
"category": "Error",
"code": 2724
},
"Import declaration '{0}' is using private name '{1}'.": {
"category": "Error",
"code": 4000
Expand Down
13 changes: 13 additions & 0 deletions tests/baselines/reference/exportSpellingSuggestion.errors.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
tests/cases/conformance/es6/modules/b.ts(1,10): error TS2724: Module '"tests/cases/conformance/es6/modules/a"' has no exported member 'assertNevar'. Did you mean 'assertNever'?


==== tests/cases/conformance/es6/modules/a.ts (0 errors) ====
export function assertNever(x: never, msg: string) {
throw new Error("Unexpected " + msg);
}

==== tests/cases/conformance/es6/modules/b.ts (1 errors) ====
import { assertNevar } from "./a";
~~~~~~~~~~~
!!! error TS2724: Module '"tests/cases/conformance/es6/modules/a"' has no exported member 'assertNevar'. Did you mean 'assertNever'?

21 changes: 21 additions & 0 deletions tests/baselines/reference/exportSpellingSuggestion.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
//// [tests/cases/conformance/es6/modules/exportSpellingSuggestion.ts] ////

//// [a.ts]
export function assertNever(x: never, msg: string) {
throw new Error("Unexpected " + msg);
}

//// [b.ts]
import { assertNevar } from "./a";


//// [a.js]
"use strict";
exports.__esModule = true;
function assertNever(x, msg) {
throw new Error("Unexpected " + msg);
}
exports.assertNever = assertNever;
//// [b.js]
"use strict";
exports.__esModule = true;
15 changes: 15 additions & 0 deletions tests/baselines/reference/exportSpellingSuggestion.symbols
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
=== tests/cases/conformance/es6/modules/a.ts ===
export function assertNever(x: never, msg: string) {
>assertNever : Symbol(assertNever, Decl(a.ts, 0, 0))
>x : Symbol(x, Decl(a.ts, 0, 28))
>msg : Symbol(msg, Decl(a.ts, 0, 37))

throw new Error("Unexpected " + msg);
>Error : Symbol(Error, Decl(lib.d.ts, --, --), Decl(lib.d.ts, --, --))
>msg : Symbol(msg, Decl(a.ts, 0, 37))
}

=== tests/cases/conformance/es6/modules/b.ts ===
import { assertNevar } from "./a";
>assertNevar : Symbol(assertNevar, Decl(b.ts, 0, 8))

18 changes: 18 additions & 0 deletions tests/baselines/reference/exportSpellingSuggestion.types
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=== tests/cases/conformance/es6/modules/a.ts ===
export function assertNever(x: never, msg: string) {
>assertNever : (x: never, msg: string) => void
>x : never
>msg : string

throw new Error("Unexpected " + msg);
>new Error("Unexpected " + msg) : Error
>Error : ErrorConstructor
>"Unexpected " + msg : string
>"Unexpected " : "Unexpected "
>msg : string
}

=== tests/cases/conformance/es6/modules/b.ts ===
import { assertNevar } from "./a";
>assertNevar : any

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// @filename: a.ts
export function assertNever(x: never, msg: string) {
throw new Error("Unexpected " + msg);
}

// @filename: b.ts
import { assertNevar } from "./a";