Proposal: simplify auto import descriptions (microsoft#47631)

* Simplify import fix descriptions

* Update tests

* Fix new test

Author: andrewbranch

src/compiler/diagnosticMessages.json

@@ -6354,18 +6354,14 @@
         "category": "Message",
         "code": 90012
     },
-    "Import '{0}' from module \"{1}\"": {
+    "Import '{0}' from \"{1}\"": {
         "category": "Message",
         "code": 90013
     },
     "Change '{0}' to '{1}'": {
         "category": "Message",
         "code": 90014
     },
-    "Add '{0}' to existing import declaration from \"{1}\"": {
-        "category": "Message",
-        "code": 90015
-    },
     "Declare property '{0}'": {
         "category": "Message",
         "code": 90016
@@ -6430,14 +6426,6 @@
         "category": "Message",
         "code": 90031
     },
-    "Import default '{0}' from module \"{1}\"": {
-        "category": "Message",
-        "code": 90032
-    },
-    "Add default import '{0}' to existing import declaration from \"{1}\"": {
-        "category": "Message",
-        "code": 90033
-    },
     "Add parameter name": {
         "category": "Message",
         "code": 90034
@@ -6482,6 +6470,14 @@
         "category": "Message",
         "code": 90056
     },
+    "Add import from \"{0}\"": {
+        "category": "Message",
+        "code": 90057
+    },
+    "Update import from \"{0}\"": {
+        "category": "Message",
+        "code": 90058
+    },
 
     "Convert function to an ES2015 class": {
         "category": "Message",

src/services/codefixes/importFixes.ts

@@ -20,9 +20,16 @@ namespace ts.codefix {
             const { errorCode, preferences, sourceFile, span, program } = context;
             const info = getFixesInfo(context, errorCode, span.start, /*useAutoImportProvider*/ true);
             if (!info) return undefined;
-            const { fixes, symbolName } = info;
+            const { fixes, symbolName, errorIdentifierText } = info;
             const quotePreference = getQuotePreference(sourceFile, preferences);
-            return fixes.map(fix => codeActionForFix(context, sourceFile, symbolName, fix, quotePreference, program.getCompilerOptions()));
+            return fixes.map(fix => codeActionForFix(
+                context,
+                sourceFile,
+                symbolName,
+                fix,
+                /*includeSymbolNameInDescription*/ symbolName !== errorIdentifierText,
+                quotePreference,
+                program.getCompilerOptions()));
         },
         fixIds: [importFixId],
         getAllCodeActions: context => {
@@ -78,7 +85,7 @@ namespace ts.codefix {
             const useRequire = shouldUseRequire(sourceFile, program);
             const fix = getImportFixForSymbol(sourceFile, exportInfos, moduleSymbol, symbolName, program, /*position*/ undefined, !!isValidTypeOnlyUseSite, useRequire, host, preferences);
             if (fix) {
-                addImport({ fixes: [fix], symbolName });
+                addImport({ fixes: [fix], symbolName, errorIdentifierText: undefined });
             }
         }
 
@@ -308,6 +315,7 @@ namespace ts.codefix {
                 sourceFile,
                 symbolName,
                 fix,
+                /*includeSymbolNameInDescription*/ false,
                 getQuotePreference(sourceFile, preferences), compilerOptions))
         };
     }
@@ -316,7 +324,8 @@ namespace ts.codefix {
         const compilerOptions = program.getCompilerOptions();
         const symbolName = getSymbolName(sourceFile, program.getTypeChecker(), symbolToken, compilerOptions);
         const fix = getTypeOnlyPromotionFix(sourceFile, symbolToken, symbolName, program);
-        return fix && codeFixActionToCodeAction(codeActionForFix({ host, formatContext, preferences }, sourceFile, symbolName, fix, QuotePreference.Double, compilerOptions));
+        const includeSymbolNameInDescription = symbolName !== symbolToken.text;
+        return fix && codeFixActionToCodeAction(codeActionForFix({ host, formatContext, preferences }, sourceFile, symbolName, fix, includeSymbolNameInDescription, QuotePreference.Double, compilerOptions));
     }
 
     function getImportFixForSymbol(sourceFile: SourceFile, exportInfos: readonly SymbolExportInfo[], moduleSymbol: Symbol, symbolName: string, program: Program, position: number | undefined, isValidTypeOnlyUseSite: boolean, useRequire: boolean, host: LanguageServiceHost, preferences: UserPreferences) {
@@ -666,7 +675,7 @@ namespace ts.codefix {
         }
     }
 
-    interface FixesInfo { readonly fixes: readonly ImportFix[]; readonly symbolName: string; }
+    interface FixesInfo { readonly fixes: readonly ImportFix[]; readonly symbolName: string; readonly errorIdentifierText: string | undefined; }
     function getFixesInfo(context: CodeFixContextBase, errorCode: number, pos: number, useAutoImportProvider: boolean): FixesInfo | undefined {
         const symbolToken = getTokenAtPosition(context.sourceFile, pos);
         let info;
@@ -679,7 +688,7 @@ namespace ts.codefix {
         else if (errorCode === Diagnostics._0_cannot_be_used_as_a_value_because_it_was_imported_using_import_type.code) {
             const symbolName = getSymbolName(context.sourceFile, context.program.getTypeChecker(), symbolToken, context.program.getCompilerOptions());
             const fix = getTypeOnlyPromotionFix(context.sourceFile, symbolToken, symbolName, context.program);
-            return fix && { fixes: [fix], symbolName };
+            return fix && { fixes: [fix], symbolName, errorIdentifierText: symbolToken.text };
         }
         else {
             info = getFixesInfoForNonUMDImport(context, symbolToken, useAutoImportProvider);
@@ -736,7 +745,7 @@ namespace ts.codefix {
         const exportInfos: readonly SymbolExportInfo[] = [{ symbol: umdSymbol, moduleSymbol: symbol, moduleFileName: undefined, exportKind: ExportKind.UMD, targetFlags: symbol.flags, isFromPackageJson: false }];
         const useRequire = shouldUseRequire(sourceFile, program);
         const fixes = getImportFixes(exportInfos, symbolName, isIdentifier(token) ? token.getStart(sourceFile) : undefined, /*isValidTypeOnlyUseSite*/ false, useRequire, program, sourceFile, host, preferences);
-        return { fixes, symbolName };
+        return { fixes, symbolName, errorIdentifierText: tryCast(token, isIdentifier)?.text };
     }
     function getUmdSymbol(token: Node, checker: TypeChecker): Symbol | undefined {
         // try the identifier to see if it is the umd symbol
@@ -808,7 +817,7 @@ namespace ts.codefix {
         const exportInfos = getExportInfos(symbolName, isJSXTagName(symbolToken), getMeaningFromLocation(symbolToken), cancellationToken, sourceFile, program, useAutoImportProvider, host, preferences);
         const fixes = arrayFrom(flatMapIterator(exportInfos.entries(), ([_, exportInfos]) =>
             getImportFixes(exportInfos, symbolName, symbolToken.getStart(sourceFile), isValidTypeOnlyUseSite, useRequire, program, sourceFile, host, preferences)));
-        return { fixes, symbolName };
+        return { fixes, symbolName, errorIdentifierText: symbolToken.text };
     }
 
     function getTypeOnlyPromotionFix(sourceFile: SourceFile, symbolToken: Identifier, symbolName: string, program: Program): FixPromoteTypeOnlyImport | undefined {
@@ -920,14 +929,14 @@ namespace ts.codefix {
         return allowSyntheticDefaults ? ImportKind.Default : ImportKind.CommonJS;
     }
 
-    function codeActionForFix(context: textChanges.TextChangesContext, sourceFile: SourceFile, symbolName: string, fix: ImportFix, quotePreference: QuotePreference, compilerOptions: CompilerOptions): CodeFixAction {
+    function codeActionForFix(context: textChanges.TextChangesContext, sourceFile: SourceFile, symbolName: string, fix: ImportFix, includeSymbolNameInDescription: boolean, quotePreference: QuotePreference, compilerOptions: CompilerOptions): CodeFixAction {
         let diag!: DiagnosticAndArguments;
         const changes = textChanges.ChangeTracker.with(context, tracker => {
-            diag = codeActionForFixWorker(tracker, sourceFile, symbolName, fix, quotePreference, compilerOptions);
+            diag = codeActionForFixWorker(tracker, sourceFile, symbolName, fix, includeSymbolNameInDescription, quotePreference, compilerOptions);
         });
         return createCodeFixAction(importFixName, changes, diag, importFixId, Diagnostics.Add_all_missing_imports);
     }
-    function codeActionForFixWorker(changes: textChanges.ChangeTracker, sourceFile: SourceFile, symbolName: string, fix: ImportFix, quotePreference: QuotePreference, compilerOptions: CompilerOptions): DiagnosticAndArguments {
+    function codeActionForFixWorker(changes: textChanges.ChangeTracker, sourceFile: SourceFile, symbolName: string, fix: ImportFix, includeSymbolNameInDescription: boolean, quotePreference: QuotePreference, compilerOptions: CompilerOptions): DiagnosticAndArguments {
         switch (fix.kind) {
             case ImportFixKind.UseNamespace:
                 addNamespaceQualifier(changes, sourceFile, fix);
@@ -945,11 +954,9 @@ namespace ts.codefix {
                     importKind === ImportKind.Named ? [{ name: symbolName, addAsTypeOnly }] : emptyArray,
                     compilerOptions);
                 const moduleSpecifierWithoutQuotes = stripQuotes(moduleSpecifier);
-                return [
-                    importKind === ImportKind.Default ? Diagnostics.Add_default_import_0_to_existing_import_declaration_from_1 : Diagnostics.Add_0_to_existing_import_declaration_from_1,
-                    symbolName,
-                    moduleSpecifierWithoutQuotes
-                ]; // you too!
+                return includeSymbolNameInDescription
+                    ? [Diagnostics.Import_0_from_1, symbolName, moduleSpecifierWithoutQuotes]
+                    : [Diagnostics.Update_import_from_0, moduleSpecifierWithoutQuotes];
             }
             case ImportFixKind.AddNew: {
                 const { importKind, moduleSpecifier, addAsTypeOnly, useRequire } = fix;
@@ -958,7 +965,9 @@ namespace ts.codefix {
                 const namedImports: Import[] | undefined = importKind === ImportKind.Named ? [{ name: symbolName, addAsTypeOnly }] : undefined;
                 const namespaceLikeImport = importKind === ImportKind.Namespace || importKind === ImportKind.CommonJS ? { importKind, name: symbolName, addAsTypeOnly } : undefined;
                 insertImports(changes, sourceFile, getDeclarations(moduleSpecifier, quotePreference, defaultImport, namedImports, namespaceLikeImport), /*blankLineBetween*/ true);
-                return [importKind === ImportKind.Default ? Diagnostics.Import_default_0_from_module_1 : Diagnostics.Import_0_from_module_1, symbolName, moduleSpecifier];
+                return includeSymbolNameInDescription
+                    ? [Diagnostics.Import_0_from_1, symbolName, moduleSpecifier]
+                    : [Diagnostics.Add_import_from_0, moduleSpecifier];
             }
             case ImportFixKind.PromoteTypeOnly: {
                 const { typeOnlyAliasDeclaration } = fix;

src/testRunner/unittests/tsserver/completions.ts

@@ -85,7 +85,7 @@ namespace ts.projectSystem {
                 {
                     codeActions: [
                         {
-                            description: `Import 'foo' from module "./a"`,
+                            description: `Add import from "./a"`,
                             changes: [
                                 {
                                     fileName: "/b.ts",
@@ -118,7 +118,7 @@ namespace ts.projectSystem {
                 {
                     codeActions: [
                         {
-                            description: `Import 'foo' from module "./a"`,
+                            description: `Add import from "./a"`,
                             changes: [
                                 {
                                     fileName: "/b.ts",

src/testRunner/unittests/tsserver/duplicatePackages.ts

@@ -33,7 +33,7 @@ namespace ts.projectSystem {
                 });
                 assert.deepEqual<readonly protocol.CodeFixAction[] | undefined>(response, [
                     {
-                        description: `Import 'foo' from module "foo"`,
+                        description: `Add import from "foo"`,
                         fixName: "import",
                         changes: [{
                             fileName: user.path,

tests/baselines/reference/tsserver/projectReferences/auto-import-with-referenced-project-when-built-with-disableSourceOfProjectReferenceRedirect.js

@@ -98,4 +98,4 @@ response:{"responseRequired":false}
 request:{"command":"getCodeFixes","arguments":{"file":"/user/username/projects/myproject/app/src/program/index.ts","startLine":1,"startOffset":1,"endLine":1,"endOffset":4,"errorCodes":[2304]},"seq":1,"type":"request"}
 DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject/node_modules 1 undefined WatchType: node_modules for closed script infos and package.jsons affecting module specifier cache
 Elapsed:: *ms DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject/node_modules 1 undefined WatchType: node_modules for closed script infos and package.jsons affecting module specifier cache
-response:{"response":[{"fixName":"import","description":"Import 'foo' from module \"shared\"","changes":[{"fileName":"/user/username/projects/myproject/app/src/program/index.ts","textChanges":[{"start":{"line":1,"offset":1},"end":{"line":1,"offset":1},"newText":"import { foo } from \"shared\";\n\n"}]}]}],"responseRequired":true}
+response:{"response":[{"fixName":"import","description":"Add import from \"shared\"","changes":[{"fileName":"/user/username/projects/myproject/app/src/program/index.ts","textChanges":[{"start":{"line":1,"offset":1},"end":{"line":1,"offset":1},"newText":"import { foo } from \"shared\";\n\n"}]}]}],"responseRequired":true}

tests/baselines/reference/tsserver/projectReferences/auto-import-with-referenced-project-when-built.js

@@ -97,4 +97,4 @@ response:{"responseRequired":false}
 request:{"command":"getCodeFixes","arguments":{"file":"/user/username/projects/myproject/app/src/program/index.ts","startLine":1,"startOffset":1,"endLine":1,"endOffset":4,"errorCodes":[2304]},"seq":1,"type":"request"}
 DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject/node_modules 1 undefined WatchType: node_modules for closed script infos and package.jsons affecting module specifier cache
 Elapsed:: *ms DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject/node_modules 1 undefined WatchType: node_modules for closed script infos and package.jsons affecting module specifier cache
-response:{"response":[{"fixName":"import","description":"Import 'foo' from module \"shared\"","changes":[{"fileName":"/user/username/projects/myproject/app/src/program/index.ts","textChanges":[{"start":{"line":1,"offset":1},"end":{"line":1,"offset":1},"newText":"import { foo } from \"shared\";\n\n"}]}]}],"responseRequired":true}
+response:{"response":[{"fixName":"import","description":"Add import from \"shared\"","changes":[{"fileName":"/user/username/projects/myproject/app/src/program/index.ts","textChanges":[{"start":{"line":1,"offset":1},"end":{"line":1,"offset":1},"newText":"import { foo } from \"shared\";\n\n"}]}]}],"responseRequired":true}

tests/baselines/reference/tsserver/projectReferences/auto-import-with-referenced-project.js

@@ -97,4 +97,4 @@ response:{"responseRequired":false}
 request:{"command":"getCodeFixes","arguments":{"file":"/user/username/projects/myproject/app/src/program/index.ts","startLine":1,"startOffset":1,"endLine":1,"endOffset":4,"errorCodes":[2304]},"seq":1,"type":"request"}
 DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject/node_modules 1 undefined WatchType: node_modules for closed script infos and package.jsons affecting module specifier cache
 Elapsed:: *ms DirectoryWatcher:: Added:: WatchInfo: /user/username/projects/myproject/node_modules 1 undefined WatchType: node_modules for closed script infos and package.jsons affecting module specifier cache
-response:{"response":[{"fixName":"import","description":"Import 'foo' from module \"shared\"","changes":[{"fileName":"/user/username/projects/myproject/app/src/program/index.ts","textChanges":[{"start":{"line":1,"offset":1},"end":{"line":1,"offset":1},"newText":"import { foo } from \"shared\";\n\n"}]}]}],"responseRequired":true}
+response:{"response":[{"fixName":"import","description":"Add import from \"shared\"","changes":[{"fileName":"/user/username/projects/myproject/app/src/program/index.ts","textChanges":[{"start":{"line":1,"offset":1},"end":{"line":1,"offset":1},"newText":"import { foo } from \"shared\";\n\n"}]}]}],"responseRequired":true}

tests/cases/fourslash/codeFixForgottenThisPropertyAccess01.ts

@@ -14,7 +14,7 @@
 
 goTo.file("/b.ts");
 verify.codeFixAvailable([
-    { description: `Import 'foo' from module "./a"` },
+    { description: `Add import from "./a"` },
     { description: "Change spelling to 'fooo'" },
     { description: "Add 'this.' to unresolved variable" },
 ]);

tests/cases/fourslash/codeFixSpellingVsImport.ts

@@ -11,6 +11,6 @@
 
 goTo.file("/b.ts");
 verify.codeFixAvailable([
-    { description: `Import 'foo' from module "./a"` },
+    { description: `Add import from "./a"` },
     { description: "Change spelling to 'foof'" },
 ]);

tests/cases/fourslash/completionsImportFromJSXTag.ts

@@ -22,7 +22,7 @@
 verify.applyCodeActionFromCompletion("", {
   name: "Box",
   source: "/Box",
-  description: `Import 'Box' from module "./Box"`,
+  description: `Add import from "./Box"`,
   newFileContent: `import { Box } from "./Box";
 
 export function App() {

tests/cases/fourslash/completionsImportModuleAugmentationWithJS.ts

@@ -26,7 +26,7 @@
 verify.applyCodeActionFromCompletion("", {
   name: "Abcde",
   source: "/test",
-  description: `Import 'Abcde' from module "./test"`,
+  description: `Add import from "./test"`,
   newFileContent: `import { Abcde } from "./test";
 
 export {};

tests/cases/fourslash/completionsImportYieldExpression.ts

@@ -11,7 +11,7 @@
 verify.applyCodeActionFromCompletion("", {
   name: "a",
   source: "/a",
-  description: `Import 'a' from module "./a"`,
+  description: `Add import from "./a"`,
   newFileContent: `import { a } from "./a";
 
 function *f() {

tests/cases/fourslash/completionsImport_46332.ts

@@ -80,7 +80,7 @@ verify.completions({
 verify.applyCodeActionFromCompletion("", {
   name: "ref",
   source: "vue",
-  description: `Add 'ref' to existing import declaration from "vue"`,
+  description: `Update import from "vue"`,
   data: {
     exportName: "ref",
     fileName: "/node_modules/vue/dist/vue.d.ts",

tests/cases/fourslash/completionsImport_ambient.ts

@@ -45,7 +45,7 @@ verify.completions({
 verify.applyCodeActionFromCompletion("", {
   name: "Bar",
   source: "path2longer",
-  description: `Import 'Bar' from module "path2longer"`,
+  description: `Add import from "path2longer"`,
   newFileContent: `import { Bar } from "path2longer";\n\nBa`,
   preferences: {
     includeCompletionsForModuleExports: true

tests/cases/fourslash/completionsImport_defaultAndNamedConflict.ts

@@ -42,7 +42,7 @@ verify.applyCodeActionFromCompletion("", {
   name: "someModule",
   source: "/someModule",
   data: { exportName: "default", fileName: "/someModule.ts" },
-  description: `Import default 'someModule' from module "./someModule"`,
+  description: `Add import from "./someModule"`,
   newFileContent: `import someModule from "./someModule";
 
 someMo`

tests/cases/fourslash/completionsImport_defaultFalsePositive.ts

@@ -30,7 +30,7 @@ verify.completions({
 verify.applyCodeActionFromCompletion("", {
     name: "concat",
     source: "/node_modules/bar/concat",
-    description: `Import 'concat' from module "bar/concat"`,
+    description: `Add import from "bar/concat"`,
     newFileContent:
 `import { concat } from "bar/concat";
 

tests/cases/fourslash/completionsImport_default_addToNamedImports.ts

@@ -26,7 +26,7 @@ verify.completions({
 verify.applyCodeActionFromCompletion("", {
     name: "foo",
     source: "/a",
-    description: `Add default import 'foo' to existing import declaration from "./a"`,
+    description: `Update import from "./a"`,
     newFileContent: `import foo, { x } from "./a";
 f;`,
 });

tests/cases/fourslash/completionsImport_default_addToNamespaceImport.ts

@@ -24,7 +24,7 @@ verify.completions({
 verify.applyCodeActionFromCompletion("", {
     name: "foo",
     source: "/a",
-    description: `Add default import 'foo' to existing import declaration from "./a"`,
+    description: `Update import from "./a"`,
     newFileContent: `import foo, * as a from "./a";
 f;`,
 });

tests/cases/fourslash/completionsImport_default_alreadyExistedWithRename.ts

@@ -24,7 +24,7 @@ verify.completions({
 verify.applyCodeActionFromCompletion("", {
     name: "foo",
     source: "/a",
-    description: `Import default 'foo' from module "./a"`,
+    description: `Add import from "./a"`,
     newFileContent: `import foo from "./a";
 import f_o_o from "./a";
 f;`,

tests/cases/fourslash/completionsImport_default_anonymous.ts

@@ -37,7 +37,7 @@ verify.completions(
 verify.applyCodeActionFromCompletion("1", {
     name: "fooBar",
     source: "/src/foo-bar",
-    description: `Import default 'fooBar' from module "./foo-bar"`,
+    description: `Add import from "./foo-bar"`,
     newFileContent: `import fooBar from "./foo-bar"
 
 def