8000 Import statement completions by andrewbranch · Pull Request #43149 · microsoft/TypeScript · GitHub
[go: up one dir, main page]
Skip to content

Import statement completions #43149

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.

Sign up for GitHub

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 39 commits into from
Mar 26, 2021
Merged

Import statement completions #43149

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
60422cb
WIP
andrewbranch Feb 17, 2021
081f564
WIP
andrewbranch Feb 18, 2021
48bfb22
Get completion details working
andrewbranch Mar 3, 2021
9e456b5
Start unifying eager and lazy auto imports
andrewbranch Mar 4, 2021
89dba08
Fix export=
andrewbranch Mar 4, 2021
3a4e275
Fix completion details for totally misspelled names
andrewbranch Mar 4, 2021
12bb1fe
Almost fixed duplication...
andrewbranch Mar 5, 2021
0ae905c
Fix remaining completion tests
andrewbranch Mar 5, 2021
e9f3ec1
Refactor to support multiple origins for same symbol
andrewbranch Mar 5, 2021
b5b58f8
Make import fixes make slightly more sense
andrewbranch Mar 5, 2021
c7e9bc7
Add cache back in
andrewbranch Mar 8, 2021
393fce5
Set insertText based on import kind
andrewbranch Mar 8, 2021
8999db9
Update API baselines
andrewbranch Mar 8, 2021
6c8457b
Add semicolons, snippet support, and sourceDisplay
andrewbranch Mar 11, 2021
db75d56
Add some tests
andrewbranch Mar 12, 2021
6e6c8ff
Update baselines
andrewbranch Mar 12, 2021
6382ece
Fix pattern ambient modules appearing in auto imports
andrewbranch Mar 12, 2021
409fa90
Fix tests
andrewbranch Mar 13, 2021
2ae85af
Remove commented code
andrewbranch Mar 15, 2021
77b6e3d
Switch to valueDeclaration for getting module source file
andrewbranch Mar 15, 2021
5388b30
Small optimizations
andrewbranch Mar 16, 2021
99ec664
Cache module specifiers / importableness and export map separately
andrewbranch Mar 19, 2021
630f200
Fix and test cache invalidation logic
andrewbranch Mar 21, 2021
f60ac89
Update API baselines
andrewbranch Mar 21, 2021
32fccbb
Add separate user preference for snippet-formatted completions
andrewbranch Mar 21, 2021
eb421c0
Require first character to match when resolving module specifiers
andrewbranch Mar 22, 2021
2506173
Merge branch 'master' into feature/31658
andrewbranch Mar 22, 2021
cdb7efd
Fix AutoImportProvider export map cache invalidation
andrewbranch Mar 22, 2021
9976d3f
Really fix auto import provider export map invalidation
andrewbranch Mar 22, 2021
d1afa7a
Merge branch 'master' into feature/31658
andrewbranch Mar 23, 2021
8550be7
Update test added in master
andrewbranch Mar 26, 2021
66caaf2
Use logical or assignment
andrewbranch Mar 26, 2021
d10aa0c
Simply conditional by reversing
andrewbranch Mar 26, 2021
5e868e3
Merge branch 'master' into feature/31658
andrewbranch Mar 26, 2021
9ea1bd4
When file is deleted need to marked correctly in the project as remov…
sheetalkamat Oct 9, 2020
eb52faa
Simplify hasAddedOrRemovedSymlinks with cherry-picked fix
andrewbranch Mar 26, 2021
f7028f6
Merge branch 'master' into feature/31658
andrewbranch Mar 26, 2021
f5df94b
Ensure replacement range is on one line
andrewbranch Mar 26, 2021
badcd83
Update baselines
andrewbranch Mar 26, 2021
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
Prev Previous commit
Next Next commit
Fix export=
  • Loading branch information
@andrewbranch
andrewbranch committed Mar 4, 2021
commit 89dba0815cb3486ebbee3cf74bd8d3211b7154a3
35 changes: 18 additions & 17 deletions src/services/codefixes/importFixes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ namespace ts.codefix {
interface SymbolExportInfo {
readonly symbol: Symbol;
readonly moduleSymbol: Symbol;
readonly isExportEquals: boolean
readonly importKind: ImportKind;
Copy link
Member Author

Choose a reason for hiding this comment

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

Some of the refactors here weren’t strictly necessary, but are a step forward in understandability and hopefully cacheability in the future—SymbolExportInfo previously had info about how a specific file would want to import the exported symbol instead of just plain info about how the symbol is exported, which made it a misnomer and uncacheable.

/** If true, can't use an es6 import from a js file. */
readonly exportedSymbolIsTypeOnly: boolean;
Expand Down Expand Up @@ -246,11 +247,11 @@ namespace ts.codefix {
function getInfoWithChecker(checker: TypeChecker, isFromPackageJson: boolean): SymbolExportInfo | undefined {
const defaultInfo = getDefaultLikeExportInfo(importingFile, moduleSymbol, checker, compilerOptions);
if (defaultInfo && skipAlias(defaultInfo.symbol, checker) === symbol) {
return { symbol: defaultInfo.symbol, moduleSymbol, importKind: defaultInfo.kind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(symbol, checker), isFromPackageJson };
return { symbol: defaultInfo.symbol, moduleSymbol, isExportEquals: defaultInfo.isExportEquals, importKind: defaultInfo.kind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(symbol, checker), isFromPackageJson };
}
const named = checker.tryGetMemberInModuleExportsAndProperties(symbol.name, moduleSymbol);
if (named && skipAlias(named, checker) === symbol) {
return { symbol: named, moduleSymbol, importKind: ImportKind.Named, exportedSymbolIsTypeOnly: isTypeOnlySymbol(symbol, checker), isFromPackageJson };
return { symbol: named, moduleSymbol, isExportEquals: false, importKind: ImportKind.Named, exportedSymbolIsTypeOnly: isTypeOnlySymbol(symbol, checker), isFromPackageJson };
}
}
}
Expand All @@ -267,12 +268,12 @@ namespace ts.codefix {

const defaultInfo = getDefaultLikeExportInfo(importingFile, moduleSymbol, checker, compilerOptions);
if (defaultInfo && (defaultInfo.name === symbolName || moduleSymbolToValidIdentifier(moduleSymbol, compilerOptions.target) === symbolName) && skipAlias(defaultInfo.symbol, checker) === exportedSymbol) {
result.push({ symbol: defaultInfo.symbol, moduleSymbol, importKind: defaultInfo.kind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(defaultInfo.symbol, checker), isFromPackageJson });
result.push({ symbol: defaultInfo.symbol, moduleSymbol, isExportEquals: defaultInfo.isExportEquals, importKind: defaultInfo.kind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(defaultInfo.symbol, checker), isFromPackageJson });
}

for (const exported of checker.getExportsAndPropertiesOfModule(moduleSymbol)) {
if (exported.name === symbolName && skipAlias(exported, checker) === exportedSymbol) {
result.push({ symbol: exported, moduleSymbol, importKind: ImportKind.Named, exportedSymbolIsTypeOnly: isTypeOnlySymbol(exported, checker), isFromPackageJson });
result.push({ symbol: exported, moduleSymbol, isExportEquals: false, importKind: ImportKind.Named, exportedSymbolIsTypeOnly: isTypeOnlySymbol(exported, checker), isFromPackageJson });
}
}
});
Expand All @@ -292,11 +293,11 @@ namespace ts.codefix {
const defaultInfo = getDefaultLikeExportInfo(importingFile, moduleSymbol, checker, compilerOptions);
if (defaultInfo) {
const name = getNameForExportedSymbol(getLocalSymbolForExportDefault(defaultInfo.symbol) || defaultInfo.symbol, target);
result.add(key(name, defaultInfo.symbol, moduleSymbol, checker), { symbol: defaultInfo.symbol, moduleSymbol, importKind: defaultInfo.kind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(defaultInfo.symbol, checker), isFromPackageJson });
result.add(key(name, defaultInfo.symbol, moduleSymbol, checker), { symbol: defaultInfo.symbol, moduleSymbol, isExportEquals: defaultInfo.isExportEquals, importKind: defaultInfo.kind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(defaultInfo.symbol, checker), isFromPackageJson });
}
for (const exported of checker.getExportsAndPropertiesOfModule(moduleSymbol)) {
if (exported !== defaultInfo?.symbol) {
result.add(key(getNameForExportedSymbol(exported, target), exported, moduleSymbol, checker), { symbol: exported, moduleSymbol, importKind: ImportKind.Named, exportedSymbolIsTypeOnly: isTypeOnlySymbol(exported, checker), isFromPackageJson });
result.add(key(getNameForExportedSymbol(exported, target), exported, moduleSymbol, checker), { symbol: exported, moduleSymbol, isExportEquals: false, importKind: ImportKind.Named, exportedSymbolIsTypeOnly: isTypeOnlySymbol(exported, checker), isFromPackageJson });
}
}
});
Expand Down Expand Up @@ -530,7 +531,7 @@ namespace ts.codefix {
if (!umdSymbol) return undefined;
const symbol = checker.getAliasedSymbol(umdSymbol);
const symbolName = umdSymbol.name;
const exportInfos: readonly SymbolExportInfo[] = [{ symbol: umdSymbol, moduleSymbol: symbol, importKind: getUmdImportKind(sourceFile, program.getCompilerOptions()), exportedSymbolIsTypeOnly: false, isFromPackageJson: false }];
const exportInfos: readonly SymbolExportInfo[] = [{ symbol: umdSymbol, moduleSymbol: symbol, isExportEquals: false, importKind: getUmdImportKind(sourceFile, program.getCompilerOptions()), exportedSymbolIsTypeOnly: false, isFromPackageJson: false }];
const useRequire = shouldUseRequire(sourceFile, program);
const fixes = getImportFixes(exportInfos, symbolName, isIdentifier(token) ? token.getStart(sourceFile) : undefined, /*preferTypeOnlyImport*/ false, useRequire, program, sourceFile, host, preferences);
return { fixes, symbolName };
Expand Down Expand Up @@ -614,8 +615,8 @@ namespace ts.codefix {
// For each original symbol, keep all re-exports of that symbol together so we can call `getCodeActionsForImport` on the whole group at once.
// Maps symbol id to info for modules providing that symbol (original export + re-exports).
const originalSymbolToExportInfos = createMultiMap<SymbolExportInfo>();
function addSymbol(moduleSymbol: Symbol, exportedSymbol: Symbol, importKind: ImportKind, checker: TypeChecker, isFromPackageJson: boolean): void {
originalSymbolToExportInfos.add(getUniqueSymbolId(exportedSymbol, checker).toString(), { symbol: exportedSymbol, moduleSymbol, importKind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(exportedSymbol, checker), isFromPackageJson });
function addSymbol(moduleSymbol: Symbol, exportedSymbol: Symbol, isExportEquals: boolean, importKind: ImportKind, checker: TypeChecker, isFromPackageJson: boolean): void {
originalSymbolToExportInfos.add(getUniqueSymbolId(exportedSymbol, checker).toString(), { symbol: exportedSymbol, moduleSymbol, isExportEquals, importKind, exportedSymbolIsTypeOnly: isTypeOnlySymbol(exportedSymbol, checker), isFromPackageJson });
}
forEachExternalModuleToImportFrom(program, host, sourceFile, /*filterByPackageJson*/ true, useAutoImportProvider, (moduleSymbol, _, program, isFromPackageJson) => {
const checker = program.getTypeChecker();
Expand All @@ -624,33 +625,33 @@ namespace ts.codefix {
const compilerOptions = program.getCompilerOptions();
const defaultInfo = getDefaultLikeExportInfo(sourceFile, moduleSymbol, checker, compilerOptions);
if (defaultInfo && (defaultInfo.name === symbolName || moduleSymbolToValidIdentifier(moduleSymbol, compilerOptions.target) === symbolName) && symbolHasMeaning(defaultInfo.symbolForMeaning, currentTokenMeaning)) {
addSymbol(moduleSymbol, defaultInfo.symbol, defaultInfo.kind, checker, isFromPackageJson);
addSymbol(moduleSymbol, defaultInfo.symbol, defaultInfo.isExportEquals, defaultInfo.kind, checker, isFromPackageJson);
}

// check exports with the same name
const exportSymbolWithIdenticalName = checker.tryGetMemberInModuleExportsAndProperties(symbolName, moduleSymbol);
if (exportSymbolWithIdenticalName && symbolHasMeaning(exportSymbolWithIdenticalName, currentTokenMeaning)) {
addSymbol(moduleSymbol, exportSymbolWithIdenticalName, ImportKind.Named, checker, isFromPackageJson);
addSymbol(moduleSymbol, exportSymbolWithIdenticalName, /*isExportEquals*/ false, ImportKind.Named, checker, isFromPackageJson);
}
});
return originalSymbolToExportInfos;
}

function getDefaultLikeExportInfo(
importingFile: SourceFile, moduleSymbol: Symbol, checker: TypeChecker, compilerOptions: CompilerOptions,
): { readonly symbol: Symbol, readonly symbolForMeaning: Symbol, readonly name: string, readonly kind: ImportKind } | undefined {
): { readonly symbol: Symbol, readonly symbolForMeaning: Symbol, readonly name: string, readonly kind: ImportKind, isExportEquals: boolean } | undefined {
const exported = getDefaultLikeExportWorker(importingFile, moduleSymbol, checker, compilerOptions);
if (!exported) return undefined;
const { symbol, kind } = exported;
const { symbol, kind, isExportEquals } = exported;
const info = getDefaultExportInfoWorker(symbol, checker, compilerOptions);
return info && { symbol, kind, ...info };
return info && { symbol, kind, isExportEquals, ...info };
}

function getDefaultLikeExportWorker(importingFile: SourceFile, moduleSymbol: Symbol, checker: TypeChecker, compilerOptions: CompilerOptions): { readonly symbol: Symbol, readonly kind: ImportKind } | undefined {
function getDefaultLikeExportWorker(importingFile: SourceFile, moduleSymbol: Symbol, checker: TypeChecker, compilerOptions: CompilerOptions): { readonly symbol: Symbol, readonly kind: ImportKind, isExportEquals: boolean } | undefined {
const defaultExport = checker.tryGetMemberInModuleExports(InternalSymbolName.Default, moduleSymbol);
if (defaultExport) return { symbol: defaultExport, kind: ImportKind.Default };
if (defaultExport) return { symbol: defaultExport, kind: ImportKind.Default, isExportEquals: false };
const exportEquals = checker.resolveExternalModuleSymbol(moduleSymbol);
return exportEquals === moduleSymbol ? undefined : { symbol: exportEquals, kind: getExportEqualsImportKind(importingFile, compilerOptions) };
return exportEquals === moduleSymbol ? undefined : { symbol: exportEquals, kind: getExportEqualsImportKind(importingFile, compilerOptions), isExportEquals: true };
}

function getExportEqualsImportKind(importingFile: SourceFile, compilerOptions: CompilerOptions): ImportKind {
Expand Down
2 changes: 1 addition & 1 deletion src/services/completions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1742,7 +1742,7 @@ namespace ts.Completions {
kind: resolveModuleSpecifiers ? SymbolOriginInfoKind.ResolvedExport : SymbolOriginInfoKind.Export,
moduleSpecifier,
symbolName,
exportName: exportInfo.symbol.name,
exportName: exportInfo.isExportEquals ? InternalSymbolName.ExportEquals : exportInfo.symbol.name,
fileName: isAmbientModule ? undefined : cast(exportInfo.moduleSymbol.valueDeclaration, isSourceFile).fileName,
isDefaultExport,
moduleSymbol: exportInfo.moduleSymbol,
Expand Down
0