Expand auto-import API to work on non-existent files and symbols (microsoft#58093)

Author: andrewbranch

src/compiler/moduleSpecifiers.ts

@@ -32,6 +32,7 @@ import {
  flatten,
  forEach,
  forEachAncestorDirectory,
+ FutureSourceFile,
  getBaseFileName,
  GetCanonicalFileName,
  getConditions,
@@ -65,6 +66,7 @@ import {
  isDeclarationFileName,
  isExternalModuleAugmentation,
  isExternalModuleNameRelative,
+ isFullSourceFile,
  isMissingPackageJsonInfo,
  isModuleBlock,
  isModuleDeclaration,
@@ -141,7 +143,7 @@ export interface ModuleSpecifierPreferences {
 export function getModuleSpecifierPreferences(
  { importModuleSpecifierPreference, importModuleSpecifierEnding }: UserPreferences,
  compilerOptions: CompilerOptions,
- importingSourceFile: SourceFile,
+ importingSourceFile: Pick<SourceFile, "fileName" | "impliedNodeFormat">,
  oldImportSpecifier?: string,
 ): ModuleSpecifierPreferences {
  const filePreferredEnding = getPreferredEnding();
@@ -197,7 +199,7 @@ export function getModuleSpecifierPreferences(
  importModuleSpecifierEnding,
  resolutionMode ?? importingSourceFile.impliedNodeFormat,
  compilerOptions,
- importingSourceFile,
+ isFullSourceFile(importingSourceFile) ? importingSourceFile : undefined,
  );
  }
 }
@@ -230,7 +232,7 @@ export function updateModuleSpecifier(
 /** @internal */
 export function getModuleSpecifier(
  compilerOptions: CompilerOptions,
- importingSourceFile: SourceFile,
+ importingSourceFile: SourceFile | FutureSourceFile,
  importingSourceFileName: string,
  toFileName: string,
  host: ModuleSpecifierResolutionHost,
@@ -242,7 +244,7 @@ export function getModuleSpecifier(
 /** @internal */
 export function getNodeModulesPackageName(
  compilerOptions: CompilerOptions,
- importingSourceFile: SourceFile,
+ importingSourceFile: SourceFile | FutureSourceFile,
  nodeModulesFileName: string,
  host: ModuleSpecifierResolutionHost,
  preferences: UserPreferences,
@@ -255,7 +257,7 @@ export function getNodeModulesPackageName(
 
 function getModuleSpecifierWorker(
  compilerOptions: CompilerOptions,
- importingSourceFile: SourceFile,
+ importingSourceFile: SourceFile | FutureSourceFile,
  importingSourceFileName: string,
  toFileName: string,
  host: ModuleSpecifierResolutionHost,
@@ -272,7 +274,7 @@ function getModuleSpecifierWorker(
 /** @internal */
 export function tryGetModuleSpecifiersFromCache(
  moduleSymbol: Symbol,
- importingSourceFile: SourceFile,
+ importingSourceFile: SourceFile | FutureSourceFile,
  host: ModuleSpecifierResolutionHost,
  userPreferences: UserPreferences,
  options: ModuleSpecifierOptions = {},
@@ -288,7 +290,7 @@ export function tryGetModuleSpecifiersFromCache(
 
 function tryGetModuleSpecifiersFromCacheWorker(
  moduleSymbol: Symbol,
- importingSourceFile: SourceFile,
+ importingSourceFile: SourceFile | FutureSourceFile,
  host: ModuleSpecifierResolutionHost,
  userPreferences: UserPreferences,
  options: ModuleSpecifierOptions = {},
@@ -334,7 +336,7 @@ export function getModuleSpecifiersWithCacheInfo(
  moduleSymbol: Symbol,
  checker: TypeChecker,
  compilerOptions: CompilerOptions,
- importingSourceFile: SourceFile,
+ importingSourceFile: SourceFile | FutureSourceFile,
  host: ModuleSpecifierResolutionHost,
  userPreferences: UserPreferences,
  options: ModuleSpecifierOptions = {},
@@ -370,18 +372,38 @@ export function getModuleSpecifiersWithCacheInfo(
  return { moduleSpecifiers: result, computedWithoutCache };
 }
 
+/** @internal */
+export function getLocalModuleSpecifierBetweenFileNames(
+ importingFile: Pick<SourceFile, "fileName" | "impliedNodeFormat">,
+ targetFileName: string,
+ compilerOptions: CompilerOptions,
+ host: ModuleSpecifierResolutionHost,
+ options: ModuleSpecifierOptions = {},
+): string {
+ const info = getInfo(importingFile.fileName, host);
+ const importMode = options.overrideImportMode ?? importingFile.impliedNodeFormat;
+ return getLocalModuleSpecifier(
+ targetFileName,
+ info,
+ compilerOptions,
+ host,
+ importMode,
+ getModuleSpecifierPreferences({}, compilerOptions, importingFile),
+ );
+}
+
 function computeModuleSpecifiers(
  modulePaths: readonly ModulePath[],
  compilerOptions: CompilerOptions,
- importingSourceFile: SourceFile,
+ importingSourceFile: SourceFile | FutureSourceFile,
  host: ModuleSpecifierResolutionHost,
  userPreferences: UserPreferences,
  options: ModuleSpecifierOptions = {},
  forAutoImport: boolean,
 ): readonly string[] {
  const info = getInfo(importingSourceFile.fileName, host);
  const preferences = getModuleSpecifierPreferences(userPreferences, compilerOptions, importingSourceFile);
- const existingSpecifier = forEach(modulePaths, modulePath =>
+ const existingSpecifier = isFullSourceFile(importingSourceFile) && forEach(modulePaths, modulePath =>
  forEach(
  host.getFileIncludeReasons().get(toPath(modulePath.path, host.getCurrentDirectory(), info.getCanonicalFileName)),
  reason => {
@@ -1014,7 +1036,7 @@ function tryGetModuleNameFromRootDirs(rootDirs: readonly string[], moduleFileNam
  return processEnding(shortest, allowedEndings, compilerOptions);
 }
 
-function tryGetModuleNameAsNodeModule({ path, isRedirect }: ModulePath, { getCanonicalFileName, canonicalSourceDirectory }: Info, importingSourceFile: SourceFile, host: ModuleSpecifierResolutionHost, options: CompilerOptions, userPreferences: UserPreferences, packageNameOnly?: boolean, overrideMode?: ResolutionMode): string | undefined {
+function tryGetModuleNameAsNodeModule({ path, isRedirect }: ModulePath, { getCanonicalFileName, canonicalSourceDirectory }: Info, importingSourceFile: SourceFile | FutureSourceFile, host: ModuleSpecifierResolutionHost, options: CompilerOptions, userPreferences: UserPreferences, packageNameOnly?: boolean, overrideMode?: ResolutionMode): string | undefined {
  if (!host.fileExists || !host.readFile) {
  return undefined;
  }

src/compiler/types.ts

@@ -4217,6 +4217,18 @@ export interface SourceFileLike {
  getPositionOfLineAndCharacter?(line: number, character: number, allowEdits?: true): number;
 }
 
+/** @internal */
+export interface FutureSourceFile {
+ readonly path: Path;
+ readonly fileName: string;
+ readonly impliedNodeFormat?: ResolutionMode;
+ readonly packageJsonScope?: PackageJsonInfo;
+ readonly externalModuleIndicator?: true | undefined;
+ readonly commonJsModuleIndicator?: true | undefined;
+ readonly statements: readonly never[];
+ readonly imports: readonly never[];
+}
+
 /** @internal */
 export interface RedirectInfo {
  /** Source file this redirects to. */

src/compiler/utilities.ts

@@ -11,6 +11,7 @@ import {
  AmpersandAmpersandEqualsToken,
  AnyImportOrBareOrAccessedRequire,
  AnyImportOrReExport,
+ AnyImportOrRequireStatement,
  AnyImportSyntax,
  AnyValidImportOrReExport,
  append,
@@ -1985,6 +1986,11 @@ export function isAnyImportOrBareOrAccessedRequire(node: Node): node is AnyImpor
  return isAnyImportSyntax(node) || isVariableDeclarationInitializedToBareOrAccessedRequire(node);
 }
 
+/** @internal */
+export function isAnyImportOrRequireStatement(node: Node): node is AnyImportOrRequireStatement {
+ return isAnyImportSyntax(node) || isRequireVariableStatement(node);
+}
+
 /** @internal */
 export function isLateVisibilityPaintedStatement(node: Node): node is LateVisibilityPaintedStatement {
  switch (node.kind) {
@@ -3461,6 +3467,11 @@ export function isInternalModuleImportEqualsDeclaration(node: Node): node is Imp
  return node.kind === SyntaxKind.ImportEqualsDeclaration && (node as ImportEqualsDeclaration).moduleReference.kind !== SyntaxKind.ExternalModuleReference;
 }
 
+/** @internal */
+export function isFullSourceFile(sourceFile: object): sourceFile is SourceFile {
+ return (sourceFile as Partial<SourceFile>)?.kind === SyntaxKind.SourceFile;
+}
+
 /** @internal */
 export function isSourceFileJS(file: SourceFile): boolean {
  return isInJSFile(file);
@@ -9576,7 +9587,7 @@ export function usesExtensionsOnImports({ imports }: SourceFile, hasExtension: (
 }
 
 /** @internal */
-export function getModuleSpecifierEndingPreference(preference: UserPreferences["importModuleSpecifierEnding"], resolutionMode: ResolutionMode, compilerOptions: CompilerOptions, sourceFile: SourceFile): ModuleSpecifierEnding {
+export function getModuleSpecifierEndingPreference(preference: UserPreferences["importModuleSpecifierEnding"], resolutionMode: ResolutionMode, compilerOptions: CompilerOptions, sourceFile?: SourceFile): ModuleSpecifierEnding {
  const moduleResolution = getEmitModuleResolutionKind(compilerOptions);
  const moduleResolutionIsNodeNext = ModuleResolutionKind.Node16 <= moduleResolution && moduleResolution <= ModuleResolutionKind.NodeNext;
  if (preference === "js" || resolutionMode === ModuleKind.ESNext && moduleResolutionIsNodeNext) {
@@ -9603,22 +9614,22 @@ export function getModuleSpecifierEndingPreference(preference: UserPreferences["
  // accurately, and more importantly, literally nobody wants `Index` and its existence is a mystery.
  if (!shouldAllowImportingTsExtension(compilerOptions)) {
  // If .ts imports are not valid, we only need to see one .js import to go with that.
- return usesExtensionsOnImports(sourceFile) ? ModuleSpecifierEnding.JsExtension : ModuleSpecifierEnding.Minimal;
+ return sourceFile && usesExtensionsOnImports(sourceFile) ? ModuleSpecifierEnding.JsExtension : ModuleSpecifierEnding.Minimal;
  }
 
  return inferPreference();
 
  function inferPreference() {
  let usesJsExtensions = false;
- const specifiers = sourceFile.imports.length ? sourceFile.imports :
- isSourceFileJS(sourceFile) ? getRequiresAtTopOfFile(sourceFile).map(r => r.arguments[0]) :
+ const specifiers = sourceFile?.imports.length ? sourceFile.imports :
+ sourceFile && isSourceFileJS(sourceFile) ? getRequiresAtTopOfFile(sourceFile).map(r => r.arguments[0]) :
  emptyArray;
  for (const specifier of specifiers) {
  if (pathIsRelative(specifier.text)) {
  if (
  moduleResolutionIsNodeNext &&
  resolutionMode === ModuleKind.CommonJS &&
- getModeForUsageLocation(sourceFile, specifier, compilerOptions) === ModuleKind.ESNext
+ getModeForUsageLocation(sourceFile!, specifier, compilerOptions) === ModuleKind.ESNext
  ) {
  // We're trying to decide a preference for a CommonJS module specifier, but looking at an ESM import.
  continue;