Skip to content

Commit 304fcee

Browse files
andrewbranchandrewbranch
authored
Updated: Only auto-import from package.json (#32517)
* Move package.json related utils to utilities * Add failing test * Make first test pass * Don’t filter when there’s no package.json, fix scoped package imports * Use type acquisition as a heuristic for whether a JS project is using node core * Make same fix in getCompletionDetails * Fix re-exporting * Change JS node core module heuristic to same-file utilization * Remove unused method * Remove other unused method * Remove unused triple-slash ref * Update comment * Refactor findAlias to forEachAlias to reduce iterations * Really fix re-exporting * Use getModuleSpecifier instead of custom hack * Fix offering auto imports to paths within node modules * Rename things and make comments better * Add another reexport test * Inline `symbolHasBeenSeen` * Simplify forEachAlias to findAlias * Add note that symbols is mutated * Symbol order doesn’t matter here * Style nits * Add test with nested package.jsons * Fix and add tests for export * re-exports * Don’t fail when alias isn’t found * Make some easy optimizations * Clean up memoization when done * Remove unnecessary semicolon * Make getSymbolsFromOtherSourceFileExports pure * Cache auto imports * Revert "Cache auto imports" This reverts commit 8ea4829. * Handle merged symbols through cache * Be safer with symbol declarations, add logging * Improve cache invalidation for imports and exports * Check symbol presence first * Only run cache invalidation logic if there’s something to clear * Consolidate cache invalidation logic * Fix reuseProgramStructure test * Add more logging * Only clear cache if symbols are different * Refactor ambient module handling * Start caching package.json stuff * Support package.json searching in fourslash * Move import suggestions cache to Project * Start making more module specifier work available without having the importing file * Going to backtrack some from here * Get rid of dumb cache, fix node core modules stuff * Start determining changes to a file have invalidated its own auto imports * Move package.json related utils to utilities * Add failing test * Make first test pass * Don’t filter when there’s no package.json, fix scoped package imports * Use type acquisition as a heuristic for whether a JS project is using node core * Make same fix in getCompletionDetails * Fix re-exporting * Change JS node core module heuristic to same-file utilization * Remove unused method * Remove other unused method * Remove unused triple-slash ref * Update comment * Refactor findAlias to forEachAlias to reduce iterations * Really fix re-exporting * Use getModuleSpecifier instead of custom hack * Fix offering auto imports to paths within node modules * Rename things and make comments better * Add another reexport test * Inline `symbolHasBeenSeen` * Simplify forEachAlias to findAlias * Add note that symbols is mutated * Symbol order doesn’t matter here * Style nits * Add test with nested package.jsons * Fix and add tests for export * re-exports * Don’t fail when alias isn’t found * Make some easy optimizations * Clean up memoization when done * Remove unnecessary semicolon * Make getSymbolsFromOtherSourceFileExports pure * Cache auto imports * Revert "Cache auto imports" This reverts commit 8ea4829. * Handle merged symbols through cache * Be safer with symbol declarations, add logging * Improve cache invalidation for imports and exports * Check symbol presence first * Only run cache invalidation logic if there’s something to clear * Consolidate cache invalidation logic * Fix reuseProgramStructure test * Add more logging * Only clear cache if symbols are different * Refactor ambient module handling * Finish(?) sourceFileHasChangedOwnImportSuggestions * Make package.json info model better * Fix misplaced paren * Use file structure cache for package.json detection when possible * Revert unnecessary changes in moduleSpecifiers * Revert more unnecessary changes * Don’t watch package.jsons inside node_modules, fix tests * Work around declaration emit bug * Sync submodules? * Delete unused type * Add server cache tests * Fix server fourslash editing * Fix packageJsonInfo tests * Add node core modules cache test and fix more fourslash * Clean up symlink caching * Improve logging * Function name doesn’t make any sense anymore * Move symlinks cache to host * Fix markFileAsDirty from ScriptInfo * Mark new Project members internal * Use Path instead of fileName * Rename AutoImportSuggestionsCache * Improve WatchType description * Remove entries() from packageJsonCache * Fix path/fileName bug * Also cache symlinks on Program for benefit of d.ts emit * Let language service use Program’s symlink cache
1 parent 558ece7 commit 304fcee

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1964
-211
lines changed

‎src/compiler/checker.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3682,7 +3682,8 @@ namespace ts {
36823682
tracker: tracker && tracker.trackSymbol ? tracker : { trackSymbol: noop, moduleResolverHost: flags! & NodeBuilderFlags.DoNotIncludeSymbolChain ? {
36833683
getCommonSourceDirectory: (host as Program).getCommonSourceDirectory ? () => (host as Program).getCommonSourceDirectory() : () => "",
36843684
getSourceFiles: () => host.getSourceFiles(),
3685-
getCurrentDirectory: host.getCurrentDirectory && (() => host.getCurrentDirectory!())
3685+
getCurrentDirectory: maybeBind(host, host.getCurrentDirectory),
3686+
getProbableSymlinks: maybeBind(host, host.getProbableSymlinks),
36863687
} : undefined },
36873688
encounteredError: false,
36883689
visitedTypes: undefined,

‎src/compiler/moduleSpecifiers.ts‎

Lines changed: 39 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,20 @@ namespace ts.moduleSpecifiers {
6464
return getModuleSpecifierWorker(compilerOptions, importingSourceFileName, toFileName, host, files, redirectTargetsMap, getPreferences(preferences, compilerOptions, importingSourceFile));
6565
}
6666

67+
export function getNodeModulesPackageName(
68+
compilerOptions: CompilerOptions,
69+
importingSourceFileName: Path,
70+
nodeModulesFileName: string,
71+
host: ModuleSpecifierResolutionHost,
72+
files: readonly SourceFile[],
73+
redirectTargetsMap: RedirectTargetsMap,
74+
): string | undefined {
75+
const info = getInfo(importingSourceFileName, host);
76+
const modulePaths = getAllModulePaths(files, importingSourceFileName, nodeModulesFileName, info.getCanonicalFileName, host, redirectTargetsMap);
77+
return firstDefined(modulePaths,
78+
moduleFileName => tryGetModuleNameAsNodeModule(moduleFileName, info, host, compilerOptions, /*packageNameOnly*/ true));
79+
}
80+
6781
function getModuleSpecifierWorker(
6882
compilerOptions: CompilerOptions,
6983
importingSourceFileName: Path,
@@ -79,7 +93,7 @@ namespace ts.moduleSpecifiers {
7993
getLocalModuleSpecifier(toFileName, info, compilerOptions, preferences);
8094
}
8195

82-
// Returns an import for each symlink and for the realpath.
96+
/** Returns an import for each symlink and for the realpath. */
8397
export function getModuleSpecifiers(
8498
moduleSymbol: Symbol,
8599
compilerOptions: CompilerOptions,
@@ -152,40 +166,6 @@ namespace ts.moduleSpecifiers {
152166
return firstDefined(imports, ({ text }) => pathIsRelative(text) ? hasJSOrJsonFileExtension(text) : undefined) || false;
153167
}
154168

155-
function stringsEqual(a: string, b: string, getCanonicalFileName: GetCanonicalFileName): boolean {
156-
return getCanonicalFileName(a) === getCanonicalFileName(b);
157-
}
158-
159-
// KLUDGE: Don't assume one 'node_modules' links to another. More likely a single directory inside the node_modules is the symlink.
160-
// ALso, don't assume that an `@foo` directory is linked. More likely the contents of that are linked.
161-
function isNodeModulesOrScopedPackageDirectory(s: string, getCanonicalFileName: GetCanonicalFileName): boolean {
162-
return getCanonicalFileName(s) === "node_modules" || startsWith(s, "@");
163-
}
164-
165-
function guessDirectorySymlink(a: string, b: string, cwd: string, getCanonicalFileName: GetCanonicalFileName): [string, string] {
166-
const aParts = getPathComponents(toPath(a, cwd, getCanonicalFileName));
167-
const bParts = getPathComponents(toPath(b, cwd, getCanonicalFileName));
168-
while (!isNodeModulesOrScopedPackageDirectory(aParts[aParts.length - 2], getCanonicalFileName) &&
169-
!isNodeModulesOrScopedPackageDirectory(bParts[bParts.length - 2], getCanonicalFileName) &&
170-
stringsEqual(aParts[aParts.length - 1], bParts[bParts.length - 1], getCanonicalFileName)) {
171-
aParts.pop();
172-
bParts.pop();
173-
}
174-
return [getPathFromPathComponents(aParts), getPathFromPathComponents(bParts)];
175-
}
176-
177-
function discoverProbableSymlinks(files: readonly SourceFile[], getCanonicalFileName: GetCanonicalFileName, cwd: string): ReadonlyMap<string> {
178-
const result = createMap<string>();
179-
const symlinks = flatten<readonly [string, string]>(mapDefined(files, sf =>
180-
sf.resolvedModules && compact(arrayFrom(mapIterator(sf.resolvedModules.values(), res =>
181-
res && res.originalPath && res.resolvedFileName !== res.originalPath ? [res.resolvedFileName, res.originalPath] as const : undefined)))));
182-
for (const [resolvedPath, originalPath] of symlinks) {
183-
const [commonResolved, commonOriginal] = guessDirectorySymlink(resolvedPath, originalPath, cwd, getCanonicalFileName);
184-
result.set(commonOriginal, commonResolved);
185-
}
186-
return result;
187-
}
188-
189169
function numberOfDirectorySeparators(str: string) {
190170
const match = str.match(/\//g);
191171
return match ? match.length : 0;
@@ -207,7 +187,9 @@ namespace ts.moduleSpecifiers {
207187
const importedFileNames = redirects ? [...redirects, importedFileName] : [importedFileName];
208188
const cwd = host.getCurrentDirectory ? host.getCurrentDirectory() : "";
209189
const targets = importedFileNames.map(f => getNormalizedAbsolutePath(f, cwd));
210-
const links = discoverProbableSymlinks(files, getCanonicalFileName, cwd);
190+
const links = host.getProbableSymlinks
191+
? host.getProbableSymlinks(files)
192+
: discoverProbableSymlinks(files, getCanonicalFileName, cwd);
211193

212194
const result: string[] = [];
213195
const compareStrings = (!host.useCaseSensitiveFileNames || host.useCaseSensitiveFileNames()) ? compareStringsCaseSensitive : compareStringsCaseInsensitive;
@@ -299,7 +281,7 @@ namespace ts.moduleSpecifiers {
299281
: removeFileExtension(relativePath);
300282
}
301283

302-
function tryGetModuleNameAsNodeModule(moduleFileName: string, { getCanonicalFileName, sourceDirectory }: Info, host: ModuleSpecifierResolutionHost, options: CompilerOptions): string | undefined {
284+
function tryGetModuleNameAsNodeModule(moduleFileName: string, { getCanonicalFileName, sourceDirectory }: Info, host: ModuleSpecifierResolutionHost, options: CompilerOptions, packageNameOnly?: boolean): string | undefined {
303285
if (!host.fileExists || !host.readFile) {
304286
return undefined;
305287
}
@@ -308,30 +290,33 @@ namespace ts.moduleSpecifiers {
308290
return undefined;
309291
}
310292

293+
let packageJsonContent: any | undefined;
311294
const packageRootPath = moduleFileName.substring(0, parts.packageRootIndex);
312-
const packageJsonPath = combinePaths(packageRootPath, "package.json");
313-
const packageJsonContent = host.fileExists(packageJsonPath)
314-
? JSON.parse(host.readFile(packageJsonPath)!)
315-
: undefined;
316-
const versionPaths = packageJsonContent && packageJsonContent.typesVersions
317-
? getPackageJsonTypesVersionsPaths(packageJsonContent.typesVersions)
318-
: undefined;
319-
if (versionPaths) {
320-
const subModuleName = moduleFileName.slice(parts.packageRootIndex + 1);
321-
const fromPaths = tryGetModuleNameFromPaths(
322-
removeFileExtension(subModuleName),
323-
removeExtensionAndIndexPostFix(subModuleName, Ending.Minimal, options),
324-
versionPaths.paths
325-
);
326-
if (fromPaths !== undefined) {
327-
moduleFileName = combinePaths(moduleFileName.slice(0, parts.packageRootIndex), fromPaths);
295+
if (!packageNameOnly) {
296+
const packageJsonPath = combinePaths(packageRootPath, "package.json");
297+
packageJsonContent = host.fileExists(packageJsonPath)
298+
? JSON.parse(host.readFile(packageJsonPath)!)
299+
: undefined;
300+
const versionPaths = packageJsonContent && packageJsonContent.typesVersions
301+
? getPackageJsonTypesVersionsPaths(packageJsonContent.typesVersions)
302+
: undefined;
303+
if (versionPaths) {
304+
const subModuleName = moduleFileName.slice(parts.packageRootIndex + 1);
305+
const fromPaths = tryGetModuleNameFromPaths(
306+
removeFileExtension(subModuleName),
307+
removeExtensionAndIndexPostFix(subModuleName, Ending.Minimal, options),
308+
versionPaths.paths
309+
);
310+
if (fromPaths !== undefined) {
311+
moduleFileName = combinePaths(moduleFileName.slice(0, parts.packageRootIndex), fromPaths);
312+
}
328313
}
329314
}
330315

331316
// Simplify the full file path to something that can be resolved by Node.
332317

333318
// If the module could be imported by a directory name, use that directory's name
334-
const moduleSpecifier = getDirectoryOrExtensionlessFileName(moduleFileName);
319+
const moduleSpecifier = packageNameOnly ? moduleFileName : getDirectoryOrExtensionlessFileName(moduleFileName);
335320
// Get a path that's relative to node_modules or the importing file's path
336321
// if node_modules folder is in this folder or any of its parent folders, no need to keep it.
337322
if (!startsWith(sourceDirectory, getCanonicalFileName(moduleSpecifier.substring(0, parts.topLevelNodeModulesIndex)))) return undefined;

‎src/compiler/program.ts‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -715,6 +715,7 @@ namespace ts {
715715
let processingDefaultLibFiles: SourceFile[] | undefined;
716716
let processingOtherFiles: SourceFile[] | undefined;
717717
let files: SourceFile[];
718+
let symlinks: ReadonlyMap<string> | undefined;
718719
let commonSourceDirectory: string;
719720
let diagnosticsProducingTypeChecker: TypeChecker;
720721
let noDiagnosticsTypeChecker: TypeChecker;
@@ -973,7 +974,8 @@ namespace ts {
973974
getResolvedProjectReferenceByPath,
974975
forEachResolvedProjectReference,
975976
isSourceOfProjectReferenceRedirect,
976-
emitBuildInfo
977+
emitBuildInfo,
978+
getProbableSymlinks
977979
};
978980

979981
verifyCompilerOptions();
@@ -1472,6 +1474,7 @@ namespace ts {
14721474
getLibFileFromReference: program.getLibFileFromReference,
14731475
isSourceFileFromExternalLibrary,
14741476
getResolvedProjectReferenceToRedirect,
1477+
getProbableSymlinks,
14751478
writeFile: writeFileCallback || (
14761479
(fileName, data, writeByteOrderMark, onError, sourceFiles) => host.writeFile(fileName, data, writeByteOrderMark, onError, sourceFiles)),
14771480
isEmitBlocked,
@@ -3358,6 +3361,16 @@ namespace ts {
33583361
function isSameFile(file1: string, file2: string) {
33593362
return comparePaths(file1, file2, currentDirectory, !host.useCaseSensitiveFileNames()) === Comparison.EqualTo;
33603363
}
3364+
3365+
function getProbableSymlinks(): ReadonlyMap<string> {
3366+
if (host.getSymlinks) {
3367+
return host.getSymlinks();
3368+
}
3369+
return symlinks || (symlinks = discoverProbableSymlinks(
3370+
files,
3371+
getCanonicalFileName,
3372+
host.getCurrentDirectory()));
3373+
}
33613374
}
33623375

33633376
/*@internal*/

‎src/compiler/types.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3068,6 +3068,7 @@ namespace ts {
30683068
/*@internal*/ isSourceOfProjectReferenceRedirect(fileName: string): boolean;
30693069
/*@internal*/ getProgramBuildInfo?(): ProgramBuildInfo | undefined;
30703070
/*@internal*/ emitBuildInfo(writeFile?: WriteFileCallback, cancellationToken?: CancellationToken): EmitResult;
3071+
/*@internal*/ getProbableSymlinks(): ReadonlyMap<string>;
30713072
}
30723073

30733074
/* @internal */
@@ -4885,7 +4886,8 @@ namespace ts {
48854886
}
48864887

48874888
export interface TypeAcquisition {
4888-
/* @deprecated typingOptions.enableAutoDiscovery
4889+
/**
4890+
* @deprecated typingOptions.enableAutoDiscovery
48894891
* Use typeAcquisition.enable instead.
48904892
*/
48914893
enableAutoDiscovery?: boolean;
@@ -5335,6 +5337,7 @@ namespace ts {
53355337

53365338
// TODO: later handle this in better way in builder host instead once the api for tsbuild finalizes and doesn't use compilerHost as base
53375339
/*@internal*/createDirectory?(directory: string): void;
5340+
/*@internal*/getSymlinks?(): ReadonlyMap<string>;
53385341
}
53395342

53405343
/** true if --out otherwise source file name */
@@ -6020,11 +6023,13 @@ namespace ts {
60206023
directoryExists?(directoryName: string): boolean;
60216024
getCurrentDirectory?(): string;
60226025
}
6023-
/** @internal */
6026+
60246027
export interface ModuleSpecifierResolutionHost extends GetEffectiveTypeRootsHost {
60256028
useCaseSensitiveFileNames?(): boolean;
60266029
fileExists?(path: string): boolean;
60276030
readFile?(path: string): string | undefined;
6031+
/* @internal */
6032+
getProbableSymlinks?(files: readonly SourceFile[]): ReadonlyMap<string>;
60286033
}
60296034

60306035
// Note: this used to be deprecated in our public API, but is still used internally

‎src/compiler/utilities.ts‎

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4624,7 +4624,9 @@ namespace ts {
46244624
}
46254625

46264626
/** Calls `callback` on `directory` and every ancestor directory it has, returning the first defined result. */
4627-
export function forEachAncestorDirectory<T>(directory: string, callback: (directory: string) => T | undefined): T | undefined {
4627+
export function forEachAncestorDirectory<T>(directory: Path, callback: (directory: Path) => T | undefined): T | undefined;
4628+
export function forEachAncestorDirectory<T>(directory: string, callback: (directory: string) => T | undefined): T | undefined;
4629+
export function forEachAncestorDirectory<T>(directory: Path, callback: (directory: Path) => T | undefined): T | undefined {
46284630
while (true) {
46294631
const result = callback(directory);
46304632
if (result !== undefined) {
@@ -7627,7 +7629,7 @@ namespace ts {
76277629

76287630
/**
76297631
* Returns the path except for its basename. Semantics align with NodeJS's `path.dirname`
7630-
* except that we support URL's as well.
7632+
* except that we support URLs as well.
76317633
*
76327634
* ```ts
76337635
* getDirectoryPath("/path/to/file.ext") === "/path/to"
@@ -7638,7 +7640,7 @@ namespace ts {
76387640
export function getDirectoryPath(path: Path): Path;
76397641
/**
76407642
* Returns the path except for its basename. Semantics align with NodeJS's `path.dirname`
7641-
* except that we support URL's as well.
7643+
* except that we support URLs as well.
76427644
*
76437645
* ```ts
76447646
* getDirectoryPath("/path/to/file.ext") === "/path/to"
@@ -7773,6 +7775,36 @@ namespace ts {
77737775
if (pathComponents.length === 0) return "";
77747776
return pathComponents.slice(1).join(directorySeparator);
77757777
}
7778+
7779+
export function discoverProbableSymlinks(files: readonly SourceFile[], getCanonicalFileName: GetCanonicalFileName, cwd: string): ReadonlyMap<string> {
7780+
const result = createMap<string>();
7781+
const symlinks = flatten<readonly [string, string]>(mapDefined(files, sf =>
7782+
sf.resolvedModules && compact(arrayFrom(mapIterator(sf.resolvedModules.values(), res =>
7783+
res && res.originalPath && res.resolvedFileName !== res.originalPath ? [res.resolvedFileName, res.originalPath] as const : undefined)))));
7784+
for (const [resolvedPath, originalPath] of symlinks) {
7785+
const [commonResolved, commonOriginal] = guessDirectorySymlink(resolvedPath, originalPath, cwd, getCanonicalFileName);
7786+
result.set(commonOriginal, commonResolved);
7787+
}
7788+
return result;
7789+
}
7790+
7791+
function guessDirectorySymlink(a: string, b: string, cwd: string, getCanonicalFileName: GetCanonicalFileName): [string, string] {
7792+
const aParts = getPathComponents(toPath(a, cwd, getCanonicalFileName));
7793+
const bParts = getPathComponents(toPath(b, cwd, getCanonicalFileName));
7794+
while (!isNodeModulesOrScopedPackageDirectory(aParts[aParts.length - 2], getCanonicalFileName) &&
7795+
!isNodeModulesOrScopedPackageDirectory(bParts[bParts.length - 2], getCanonicalFileName) &&
7796+
getCanonicalFileName(aParts[aParts.length - 1]) === getCanonicalFileName(bParts[bParts.length - 1])) {
7797+
aParts.pop();
7798+
bParts.pop();
7799+
}
7800+
return [getPathFromPathComponents(aParts), getPathFromPathComponents(bParts)];
7801+
}
7802+
7803+
// KLUDGE: Don't assume one 'node_modules' links to another. More likely a single directory inside the node_modules is the symlink.
7804+
// ALso, don't assume that an `@foo` directory is linked. More likely the contents of that are linked.
7805+
function isNodeModulesOrScopedPackageDirectory(s: string, getCanonicalFileName: GetCanonicalFileName): boolean {
7806+
return getCanonicalFileName(s) === "node_modules" || startsWith(s, "@");
7807+
}
77767808
}
77777809

77787810
/* @internal */

‎src/harness/client.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,13 @@ namespace ts.server {
124124
return response;
125125
}
126126

127+
/*@internal*/
128+
configure(preferences: UserPreferences) {
129+
const args: protocol.ConfigureRequestArguments = { preferences };
130+
const request = this.processRequest(CommandNames.Configure, args);
131+
this.processResponse(request, /*expectEmptyBody*/ true);
132+
}
133+
127134
openFile(file: string, fileContent?: string, scriptKindName?: "TS" | "JS" | "TSX" | "JSX"): void {
128135
const args: protocol.OpenRequestArgs = { file, fileContent, scriptKindName };
129136
this.processRequest(CommandNames.Open, args);

0 commit comments

Comments
 (0)