Skip to content

Commit df57cdc

Browse files
author
Andy
authored
Have CompletionEntryDetails source use a relative path (#19917) (#20022)
* Have CompletionEntryDetails source use a relative path * Use getCanonicalFileName from services Instead of creating a new one
1 parent adfd5d3 commit df57cdc

24 files changed

+97
-49
lines changed

‎src/compiler/builder.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ namespace ts {
7777
}
7878

7979
export interface BuilderOptions {
80-
getCanonicalFileName: (fileName: string) => string;
80+
getCanonicalFileName: GetCanonicalFileName;
8181
computeHash: (data: string) => string;
8282
}
8383

‎src/compiler/commandLineParser.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1532,7 +1532,7 @@ namespace ts {
15321532
host: ParseConfigHost,
15331533
basePath: string,
15341534
configFileName: string,
1535-
getCanonicalFileName: (fileName: string) => string,
1535+
getCanonicalFileName: GetCanonicalFileName,
15361536
resolutionStack: Path[],
15371537
errors: Push<Diagnostic>,
15381538
): ParsedTsconfig {
@@ -1580,7 +1580,7 @@ namespace ts {
15801580
json: any,
15811581
host: ParseConfigHost,
15821582
basePath: string,
1583-
getCanonicalFileName: (fileName: string) => string,
1583+
getCanonicalFileName: GetCanonicalFileName,
15841584
configFileName: string | undefined,
15851585
errors: Push<Diagnostic>
15861586
): ParsedTsconfig {
@@ -1611,7 +1611,7 @@ namespace ts {
16111611
sourceFile: JsonSourceFile,
16121612
host: ParseConfigHost,
16131613
basePath: string,
1614-
getCanonicalFileName: (fileName: string) => string,
1614+
getCanonicalFileName: GetCanonicalFileName,
16151615
configFileName: string | undefined,
16161616
errors: Push<Diagnostic>
16171617
): ParsedTsconfig {
@@ -1680,7 +1680,7 @@ namespace ts {
16801680
extendedConfig: string,
16811681
host: ParseConfigHost,
16821682
basePath: string,
1683-
getCanonicalFileName: (fileName: string) => string,
1683+
getCanonicalFileName: GetCanonicalFileName,
16841684
errors: Push<Diagnostic>,
16851685
createDiagnostic: (message: DiagnosticMessage, arg1?: string) => Diagnostic) {
16861686
extendedConfig = normalizeSlashes(extendedConfig);
@@ -1705,7 +1705,7 @@ namespace ts {
17051705
extendedConfigPath: Path,
17061706
host: ts.ParseConfigHost,
17071707
basePath: string,
1708-
getCanonicalFileName: (fileName: string) => string,
1708+
getCanonicalFileName: GetCanonicalFileName,
17091709
resolutionStack: Path[],
17101710
errors: Push<Diagnostic>,
17111711
): ParsedTsconfig | undefined {

‎src/compiler/core.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1814,7 +1814,7 @@ namespace ts {
18141814
}
18151815
}
18161816

1817-
export function getRelativePathToDirectoryOrUrl(directoryPathOrUrl: string, relativeOrAbsolutePath: string, currentDirectory: string, getCanonicalFileName: (fileName: string) => string, isAbsolutePathAnUrl: boolean) {
1817+
export function getRelativePathToDirectoryOrUrl(directoryPathOrUrl: string, relativeOrAbsolutePath: string, currentDirectory: string, getCanonicalFileName: GetCanonicalFileName, isAbsolutePathAnUrl: boolean) {
18181818
const pathComponents = getNormalizedPathOrUrlComponents(relativeOrAbsolutePath, currentDirectory);
18191819
const directoryComponents = getNormalizedPathOrUrlComponents(directoryPathOrUrl, currentDirectory);
18201820
if (directoryComponents.length > 1 && lastOrUndefined(directoryComponents) === "") {
@@ -2587,7 +2587,8 @@ namespace ts {
25872587
}
25882588
}
25892589

2590-
export function createGetCanonicalFileName(useCaseSensitiveFileNames: boolean): (fileName: string) => string {
2590+
export type GetCanonicalFileName = (fileName: string) => string;
2591+
export function createGetCanonicalFileName(useCaseSensitiveFileNames: boolean): GetCanonicalFileName {
25912592
return useCaseSensitiveFileNames
25922593
? ((fileName) => fileName)
25932594
: ((fileName) => fileName.toLowerCase());

‎src/compiler/program.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ namespace ts {
2828
}
2929

3030
/* @internal */
31-
export function computeCommonSourceDirectoryOfFilenames(fileNames: string[], currentDirectory: string, getCanonicalFileName: (fileName: string) => string): string {
31+
export function computeCommonSourceDirectoryOfFilenames(fileNames: string[], currentDirectory: string, getCanonicalFileName: GetCanonicalFileName): string {
3232
let commonPathComponents: string[];
3333
const failed = forEach(fileNames, sourceFile => {
3434
// Each file contributes into common source file path

‎src/harness/fourslash.ts

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -783,10 +783,10 @@ namespace FourSlash {
783783
});
784784
}
785785

786-
public verifyCompletionListContains(entryId: ts.Completions.CompletionEntryIdentifier, text?: string, documentation?: string, kind?: string, spanIndex?: number, hasAction?: boolean, options?: ts.GetCompletionsAtPositionOptions) {
786+
public verifyCompletionListContains(entryId: ts.Completions.CompletionEntryIdentifier, text?: string, documentation?: string, kind?: string, spanIndex?: number, hasAction?: boolean, options?: FourSlashInterface.VerifyCompletionListContainsOptions) {
787787
const completions = this.getCompletionListAtCaret(options);
788788
if (completions) {
789-
this.assertItemInCompletionList(completions.entries, entryId, text, documentation, kind, spanIndex, hasAction);
789+
this.assertItemInCompletionList(completions.entries, entryId, text, documentation, kind, spanIndex, hasAction, options);
790790
}
791791
else {
792792
this.raiseError(`No completions at position '${this.currentCaretPosition}' when looking for '${JSON.stringify(entryId)}'.`);
@@ -2990,6 +2990,7 @@ Actual: ${stringify(fullActual)}`);
29902990
kind: string | undefined,
29912991
spanIndex: number | undefined,
29922992
hasAction: boolean | undefined,
2993+
options: FourSlashInterface.VerifyCompletionListContainsOptions | undefined,
29932994
) {
29942995
for (const item of items) {
29952996
if (item.name === entryId.name && item.source === entryId.source) {
@@ -3003,7 +3004,12 @@ Actual: ${stringify(fullActual)}`);
30033004
assert.equal(ts.displayPartsToString(details.displayParts), text, this.assertionMessageAtLastKnownMarker("completion item detail text for " + entryId));
30043005
}
30053006

3006-
assert.deepEqual(details.source, entryId.source === undefined ? undefined : [ts.textPart(entryId.source)]);
3007+
if (entryId.source === undefined) {
3008+
assert.equal(options && options.sourceDisplay, undefined);
3009+
}
3010+
else {
3011+
assert.deepEqual(details.source, [ts.textPart(options!.sourceDisplay)]);
3012+
}
30073013
}
30083014

30093015
if (kind !== undefined) {
@@ -3734,7 +3740,7 @@ namespace FourSlashInterface {
37343740

37353741
// Verifies the completion list contains the specified symbol. The
37363742
// completion list is brought up if necessary
3737-
public completionListContains(entryId: string | ts.Completions.CompletionEntryIdentifier, text?: string, documentation?: string, kind?: string, spanIndex?: number, hasAction?: boolean, options?: ts.GetCompletionsAtPositionOptions) {
3743+
public completionListContains(entryId: string | ts.Completions.CompletionEntryIdentifier, text?: string, documentation?: string, kind?: string, spanIndex?: number, hasAction?: boolean, options?: VerifyCompletionListContainsOptions) {
37383744
if (typeof entryId === "string") {
37393745
entryId = { name: entryId, source: undefined };
37403746
}
@@ -4472,6 +4478,10 @@ namespace FourSlashInterface {
44724478
isNewIdentifierLocation?: boolean;
44734479
}
44744480

4481+
export interface VerifyCompletionListContainsOptions extends ts.GetCompletionsAtPositionOptions {
4482+
sourceDisplay: string;
4483+
}
4484+
44754485
export interface NewContentOptions {
44764486
// Exactly one of these should be defined.
44774487
newFileContent?: string;

‎src/services/codefixes/importFixes.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ namespace ts.codefix {
3434
host: LanguageServiceHost;
3535
checker: TypeChecker;
3636
compilerOptions: CompilerOptions;
37-
getCanonicalFileName(fileName: string): string;
37+
getCanonicalFileName: GetCanonicalFileName;
3838
cachedImportDeclarations?: ImportDeclarationMap;
3939
}
4040

@@ -298,7 +298,7 @@ namespace ts.codefix {
298298
}
299299
}
300300

301-
function getModuleSpecifierForNewImport(sourceFile: SourceFile, moduleSymbol: Symbol, options: CompilerOptions, getCanonicalFileName: (file: string) => string, host: LanguageServiceHost): string | undefined {
301+
export function getModuleSpecifierForNewImport(sourceFile: SourceFile, moduleSymbol: Symbol, options: CompilerOptions, getCanonicalFileName: (file: string) => string, host: LanguageServiceHost): string | undefined {
302302
const moduleFileName = moduleSymbol.valueDeclaration.getSourceFile().fileName;
303303
const sourceDirectory = getDirectoryPath(sourceFile.fileName);
304304

@@ -508,7 +508,7 @@ namespace ts.codefix {
508508
return state > States.NodeModules ? { topLevelNodeModulesIndex, topLevelPackageNameIndex, packageRootIndex, fileNameIndex } : undefined;
509509
}
510510

511-
function getPathRelativeToRootDirs(path: string, rootDirs: ReadonlyArray<string>, getCanonicalFileName: (fileName: string) => string): string | undefined {
511+
function getPathRelativeToRootDirs(path: string, rootDirs: ReadonlyArray<string>, getCanonicalFileName: GetCanonicalFileName): string | undefined {
512512
return firstDefined(rootDirs, rootDir => getRelativePathIfInDirectory(path, rootDir, getCanonicalFileName));
513513
}
514514

@@ -520,12 +520,12 @@ namespace ts.codefix {
520520
return fileName;
521521
}
522522

523-
function getRelativePathIfInDirectory(path: string, directoryPath: string, getCanonicalFileName: (fileName: string) => string): string | undefined {
523+
function getRelativePathIfInDirectory(path: string, directoryPath: string, getCanonicalFileName: GetCanonicalFileName): string | undefined {
524524
const relativePath = getRelativePathToDirectoryOrUrl(directoryPath, path, directoryPath, getCanonicalFileName, /*isAbsolutePathAnUrl*/ false);
525525
return isRootedDiskPath(relativePath) || startsWith(relativePath, "..") ? undefined : relativePath;
526526
}
527527

528-
function getRelativePath(path: string, directoryPath: string, getCanonicalFileName: (fileName: string) => string) {
528+
function getRelativePath(path: string, directoryPath: string, getCanonicalFileName: GetCanonicalFileName) {
529529
const relativePath = getRelativePathToDirectoryOrUrl(directoryPath, path, directoryPath, getCanonicalFileName, /*isAbsolutePathAnUrl*/ false);
530530
return !pathIsRelative(relativePath) ? "./" + relativePath : relativePath;
531531
}

‎src/services/completions.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -404,8 +404,9 @@ namespace ts.Completions {
404404
allSourceFiles: ReadonlyArray<SourceFile>,
405405
host: LanguageServiceHost,
406406
rulesProvider: formatting.RulesProvider,
407+
getCanonicalFileName: GetCanonicalFileName,
407408
): CompletionEntryDetails {
408-
const { name, source } = entryId;
409+
const { name } = entryId;
409410
// Compute all the completion symbols again.
410411
const symbolCompletion = getSymbolCompletionFromEntryId(typeChecker, log, compilerOptions, sourceFile, position, entryId, allSourceFiles);
411412
switch (symbolCompletion.type) {
@@ -424,10 +425,10 @@ namespace ts.Completions {
424425
}
425426
case "symbol": {
426427
const { symbol, location, symbolToOriginInfoMap } = symbolCompletion;
427-
const codeActions = getCompletionEntryCodeActions(symbolToOriginInfoMap, symbol, typeChecker, host, compilerOptions, sourceFile, rulesProvider);
428+
const { codeActions, sourceDisplay } = getCompletionEntryCodeActionsAndSourceDisplay(symbolToOriginInfoMap, symbol, typeChecker, host, compilerOptions, sourceFile, rulesProvider, getCanonicalFileName);
428429
const kindModifiers = SymbolDisplay.getSymbolModifiers(symbol);
429430
const { displayParts, documentation, symbolKind, tags } = SymbolDisplay.getSymbolDisplayPartsDocumentationAndSymbolKind(typeChecker, symbol, sourceFile, location, location, SemanticMeaning.All);
430-
return { name, kindModifiers, kind: symbolKind, displayParts, documentation, tags, codeActions, source: source === undefined ? undefined : [textPart(source)] };
431+
return { name, kindModifiers, kind: symbolKind, displayParts, documentation, tags, codeActions, source: sourceDisplay };
431432
}
432433
case "none": {
433434
// Didn't find a symbol with this name. See if we can find a keyword instead.
@@ -448,33 +449,37 @@ namespace ts.Completions {
448449
}
449450
}
450451

451-
function getCompletionEntryCodeActions(
452+
function getCompletionEntryCodeActionsAndSourceDisplay(
452453
symbolToOriginInfoMap: SymbolOriginInfoMap,
453454
symbol: Symbol,
454455
checker: TypeChecker,
455456
host: LanguageServiceHost,
456457
compilerOptions: CompilerOptions,
457458
sourceFile: SourceFile,
458459
rulesProvider: formatting.RulesProvider,
459-
): CodeAction[] | undefined {
460+
getCanonicalFileName: GetCanonicalFileName,
461+
): { codeActions: CodeAction[] | undefined, sourceDisplay: SymbolDisplayPart[] | undefined } {
460462
const symbolOriginInfo = symbolToOriginInfoMap[getSymbolId(symbol)];
461463
if (!symbolOriginInfo) {
462-
return undefined;
464+
return { codeActions: undefined, sourceDisplay: undefined };
463465
}
464466

465467
const { moduleSymbol, isDefaultExport } = symbolOriginInfo;
466-
return codefix.getCodeActionForImport(moduleSymbol, {
468+
469+
const sourceDisplay = [textPart(codefix.getModuleSpecifierForNewImport(sourceFile, moduleSymbol, compilerOptions, getCanonicalFileName, host))];
470+
const codeActions = codefix.getCodeActionForImport(moduleSymbol, {
467471
host,
468472
checker,
469473
newLineCharacter: host.getNewLine(),
470474
compilerOptions,
471475
sourceFile,
472476
rulesProvider,
473477
symbolName: getSymbolName(symbol, symbolOriginInfo, compilerOptions.target),
474-
getCanonicalFileName: createGetCanonicalFileName(host.useCaseSensitiveFileNames ? host.useCaseSensitiveFileNames() : false),
478+
getCanonicalFileName,
475479
symbolToken: undefined,
476480
kind: isDefaultExport ? codefix.ImportKind.Default : codefix.ImportKind.Named,
477481
});
482+
return { sourceDisplay, codeActions };
478483
}
479484

480485
export function getCompletionEntrySymbol(

‎src/services/rename.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/* @internal */
22
namespace ts.Rename {
3-
export function getRenameInfo(typeChecker: TypeChecker, defaultLibFileName: string, getCanonicalFileName: (fileName: string) => string, sourceFile: SourceFile, position: number): RenameInfo {
3+
export function getRenameInfo(typeChecker: TypeChecker, defaultLibFileName: string, getCanonicalFileName: GetCanonicalFileName, sourceFile: SourceFile, position: number): RenameInfo {
44
const getCanonicalDefaultLibName = memoize(() => getCanonicalFileName(ts.normalizePath(defaultLibFileName)));
55
const node = getTouchingWord(sourceFile, position, /*includeJsDocComment*/ true);
66
const renameInfo = node && nodeIsEligibleForRename(node)

‎src/services/services.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ namespace ts {
831831
private _compilationSettings: CompilerOptions;
832832
private currentDirectory: string;
833833

834-
constructor(private host: LanguageServiceHost, getCanonicalFileName: (fileName: string) => string) {
834+
constructor(private host: LanguageServiceHost, getCanonicalFileName: GetCanonicalFileName) {
835835
// script id => script index
836836
this.currentDirectory = host.getCurrentDirectory();
837837
this.fileNameToEntry = createMap<CachedHostFileInformation>();
@@ -1347,7 +1347,8 @@ namespace ts {
13471347
{ name, source },
13481348
program.getSourceFiles(),
13491349
host,
1350-
ruleProvider);
1350+
ruleProvider,
1351+
getCanonicalFileName);
13511352
}
13521353

13531354
function getCompletionEntrySymbol(fileName: string, position: number, name: string, source?: string): Symbol {

‎tests/cases/fourslash/completionsImport_default_addToNamedImports.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@
99
////f/**/;
1010

1111
goTo.marker("");
12-
verify.completionListContains({ name: "foo", source: "/a" }, "function foo(): void", "", "function", /*spanIndex*/ undefined, /*hasAction*/ true, { includeExternalModuleExports: true });
12+
verify.completionListContains({ name: "foo", source: "/a" }, "function foo(): void", "", "function", /*spanIndex*/ undefined, /*hasAction*/ true, {
13+
includeExternalModuleExports: true,
14+
sourceDisplay: "./a",
15+
});
1316

1417
verify.applyCodeActionFromCompletion("", {
1518
name: "foo",

0 commit comments

Comments
 (0)