[Interactive inlay hints] Get source file from parameter node (microsoft#55476)

MariaSolOs · web-flow · commit 5fe88ea04433 · 2023-08-23T16:40:49.000-07:00
diff --git a/src/server/session.ts b/src/server/session.ts
@@ -1875,14 +1875,24 @@ export class Session<TMessage = string> implements EventSender {
             return {
                 ...hint,
                 position: scriptInfo.positionToLineOffset(position),
-                displayParts: displayParts?.map(({ text, span, file }) => ({
-                    text,
-                    span: span && {
-                        start: scriptInfo.positionToLineOffset(span.start),
-                        end: scriptInfo.positionToLineOffset(span.start + span.length),
-                        file: file!,
-                    },
-                })),
+                displayParts: displayParts?.map(({ text, span, file }) => {
+                    if (span) {
+                        Debug.assertIsDefined(file, "Target file should be defined together with its span.");
+                        const scriptInfo = this.projectService.getScriptInfo(file)!;
+
+                        return {
+                            text,
+                            span: {
+                                start: scriptInfo.positionToLineOffset(span.start),
+                                end: scriptInfo.positionToLineOffset(span.start + span.length),
+                                file,
+                            },
+                        };
+                    }
+                    else {
+                        return { text };
+                    }
+                }),
             };
         });
     }
diff --git a/src/services/inlayHints.ts b/src/services/inlayHints.ts
@@ -62,7 +62,6 @@ import {
     Signature,
     skipParentheses,
     some,
-    SourceFile,
     Symbol,
     SymbolFlags,
     SyntaxKind,
@@ -157,11 +156,11 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
         return isArrowFunction(node) || isFunctionExpression(node) || isFunctionDeclaration(node) || isMethodDeclaration(node) || isGetAccessorDeclaration(node);
     }
 
-    function addParameterHints(text: string, parameter: Identifier, position: number, isFirstVariadicArgument: boolean, sourceFile: SourceFile | undefined) {
+    function addParameterHints(text: string, parameter: Identifier, position: number, isFirstVariadicArgument: boolean) {
         let hintText = `${isFirstVariadicArgument ? "..." : ""}${text}`;
         let displayParts: InlayHintDisplayPart[] | undefined;
         if (shouldUseInteractiveInlayHints(preferences)) {
-            displayParts = [getNodeDisplayPart(hintText, parameter, sourceFile!), { text: ":" }];
+            displayParts = [getNodeDisplayPart(hintText, parameter), { text: ":" }];
             hintText = "";
         }
         else {
@@ -247,8 +246,6 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
             return;
         }
 
-        const sourceFile = shouldUseInteractiveInlayHints(preferences) ? expr.getSourceFile() : undefined;
-
         let signatureParamPos = 0;
         for (const originalArg of args) {
             const arg = skipParentheses(originalArg);
@@ -287,7 +284,7 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
                     continue;
                 }
 
-                addParameterHints(name, parameter, originalArg.getStart(), isFirstVariadicArgument, sourceFile);
+                addParameterHints(name, parameter, originalArg.getStart(), isFirstVariadicArgument);
             }
         }
     }
@@ -437,7 +434,8 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
         return true;
     }
 
-    function getNodeDisplayPart(text: string, node: Node, sourceFile: SourceFile): InlayHintDisplayPart {
+    function getNodeDisplayPart(text: string, node: Node): InlayHintDisplayPart {
+        const sourceFile = node.getSourceFile();
         return {
             text,
             span: createTextSpanFromNode(node, sourceFile),
diff --git a/tests/baselines/reference/inlayHintsInteractiveMultifileFunctionCalls.baseline b/tests/baselines/reference/inlayHintsInteractiveMultifileFunctionCalls.baseline
@@ -0,0 +1,21 @@
+helperB("hello, world!");
+        ^
+{
+  "text": "",
+  "position": 45,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
+    {
+      "text": "bParam",
+      "span": {
+        "start": 61,
+        "length": 6
+      },
+      "file": "/tests/cases/fourslash/bbb.mts"
+    },
+    {
+      "text": ":"
+    }
+  ]
+}
diff --git a/tests/cases/fourslash/inlayHintsInteractiveMultifileFunctionCalls.ts b/tests/cases/fourslash/inlayHintsInteractiveMultifileFunctionCalls.ts
@@ -0,0 +1,24 @@
+/// <reference path="fourslash.ts" />
+
+// @Target: esnext
+// @module: nodenext
+
+// @Filename: aaa.mts
+////import { helperB } from "./bbb.mjs";
+////helperB("hello, world!");
+
+// @Filename: bbb.mts
+////import { helperC } from "./ccc.mjs";
+
+////export function helperB(bParam: string) {
+////    helperC(bParam);
+////}
+
+// @Filename: ccc.mts
+////export function helperC(cParam: string) {}
+
+goTo.file("./aaa.mts");
+verify.baselineInlayHints(undefined, {
+    includeInlayParameterNameHints: "all",
+    interactiveInlayHints: true
+});

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,6 @@ import {`
`62`	`62`	`Signature,`
`63`	`63`	`skipParentheses,`
`64`	`64`	`some,`
`65`		`- SourceFile,`
`66`	`65`	`Symbol,`
`67`	`66`	`SymbolFlags,`
`68`	`67`	`SyntaxKind,`
`@@ -157,11 +156,11 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {`
`157`	`156`	`return isArrowFunction(node) \|\| isFunctionExpression(node) \|\| isFunctionDeclaration(node) \|\| isMethodDeclaration(node) \|\| isGetAccessorDeclaration(node);`
`158`	`157`	`}`
`159`	`158`
`160`		`- function addParameterHints(text: string, parameter: Identifier, position: number, isFirstVariadicArgument: boolean, sourceFile: SourceFile \| undefined) {`
	`159`	`+ function addParameterHints(text: string, parameter: Identifier, position: number, isFirstVariadicArgument: boolean) {`
`161`	`160`	let hintText = `${isFirstVariadicArgument ? "..." : ""}${text}`;
`162`	`161`	`let displayParts: InlayHintDisplayPart[] \| undefined;`
`163`	`162`	`if (shouldUseInteractiveInlayHints(preferences)) {`
`164`		`- displayParts = [getNodeDisplayPart(hintText, parameter, sourceFile!), { text: ":" }];`
	`163`	`+ displayParts = [getNodeDisplayPart(hintText, parameter), { text: ":" }];`
`165`	`164`	`hintText = "";`
`166`	`165`	`}`
`167`	`166`	`else {`
`@@ -247,8 +246,6 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {`
`247`	`246`	`return;`
`248`	`247`	`}`
`249`	`248`
`250`		`- const sourceFile = shouldUseInteractiveInlayHints(preferences) ? expr.getSourceFile() : undefined;`
`251`		`-`
`252`	`249`	`let signatureParamPos = 0;`
`253`	`250`	`for (const originalArg of args) {`
`254`	`251`	`const arg = skipParentheses(originalArg);`
`@@ -287,7 +284,7 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {`
`287`	`284`	`continue;`
`288`	`285`	`}`
`289`	`286`
`290`		`- addParameterHints(name, parameter, originalArg.getStart(), isFirstVariadicArgument, sourceFile);`
	`287`	`+ addParameterHints(name, parameter, originalArg.getStart(), isFirstVariadicArgument);`
`291`	`288`	`}`
`292`	`289`	`}`
`293`	`290`	`}`
`@@ -437,7 +434,8 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {`
`437`	`434`	`return true;`
`438`	`435`	`}`
`439`	`436`
`440`		`- function getNodeDisplayPart(text: string, node: Node, sourceFile: SourceFile): InlayHintDisplayPart {`
	`437`	`+ function getNodeDisplayPart(text: string, node: Node): InlayHintDisplayPart {`
	`438`	`+ const sourceFile = node.getSourceFile();`
`441`	`439`	`return {`
`442`	`440`	`text,`
`443`	`441`	`span: createTextSpanFromNode(node, sourceFile),`