Modify interactive inlay hints API to be more backwards compatible (#…

…55274)
microsoft · Aug 5, 2023 · 87c986c · 87c986c
1 parent ad01270
commit 87c986c
Show file tree

Hide file tree

Showing 31 changed files with 573 additions and 473 deletions.
diff --git a/src/harness/client.ts b/src/harness/client.ts
@@ -760,21 +760,20 @@ export class SessionClient implements LanguageService {
         const response = this.processResponse<protocol.InlayHintsResponse>(request);
 
         return response.body!.map(item => {
-            const { text, position } = item;
-            const hint = typeof text === "string" ? text : text.map(({ text, span }) => ({
-                text,
-                span: span && {
-                    start: this.lineOffsetToPosition(span.file, span.start),
-                    length: this.lineOffsetToPosition(span.file, span.end) - this.lineOffsetToPosition(span.file, span.start),
-                },
-                file: span && span.file
-            }));
+            const { position, displayParts } = item;
 
             return ({
                 ...item,
                 position: this.lineOffsetToPosition(file, position),
-                text: hint,
-                kind: item.kind as InlayHintKind
+                kind: item.kind as InlayHintKind,
+                displayParts: displayParts?.map(({ text, span }) => ({
+                    text,
+                    span: span && {
+                        start: this.lineOffsetToPosition(span.file, span.start),
+                        length: this.lineOffsetToPosition(span.file, span.end) - this.lineOffsetToPosition(span.file, span.start),
+                    },
+                    file: span && span.file
+                })),
             });
         });
     }

diff --git a/src/server/protocol.ts b/src/server/protocol.ts
@@ -2675,11 +2675,13 @@ export interface InlayHintsRequest extends Request {
 }
 
 export interface InlayHintItem {
-    text: string | InlayHintItemDisplayPart[];
+    /** This property will be the empty string when displayParts is set. */
+    text: string;
     position: Location;
     kind: InlayHintKind;
     whitespaceBefore?: boolean;
     whitespaceAfter?: boolean;
+    displayParts?: InlayHintItemDisplayPart[];
 }
 
 export interface InlayHintItemDisplayPart {

diff --git a/src/server/session.ts b/src/server/session.ts
@@ -1845,20 +1845,19 @@ export class Session<TMessage = string> implements EventSender {
         const hints = project.getLanguageService().provideInlayHints(file, args, this.getPreferences(file));
 
         return hints.map(hint => {
-            const { text, position } = hint;
-            const hintText = typeof text === "string" ? text : text.map(({ text, span, file }) => ({
-                text,
-                span: span && {
-                    start: scriptInfo.positionToLineOffset(span.start),
-                    end: scriptInfo.positionToLineOffset(span.start + span.length),
-                    file: file!
-                }
-            }));
+            const { position, displayParts } = hint;
 
             return {
                 ...hint,
                 position: scriptInfo.positionToLineOffset(position),
-                text: hintText
+                displayParts: displayParts?.map(({ text, span, file }) => ({
+                    text,
+                    span: span && {
+                        start: scriptInfo.positionToLineOffset(span.start),
+                        end: scriptInfo.positionToLineOffset(span.start + span.length),
+                        file: file!
+                    }
+                })),
             };
         });
     }

diff --git a/src/services/inlayHints.ts b/src/services/inlayHints.ts
@@ -159,9 +159,11 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
     }
 
     function addParameterHints(text: string, parameter: Identifier, position: number, isFirstVariadicArgument: boolean, sourceFile: SourceFile | undefined) {
-        let hintText: string | InlayHintDisplayPart[] = `${isFirstVariadicArgument ? "..." : ""}${text}`;
+        let hintText = `${isFirstVariadicArgument ? "..." : ""}${text}`;
+        let displayParts: InlayHintDisplayPart[] | undefined;
         if (shouldUseInteractiveInlayHints(preferences)) {
-            hintText = [getNodeDisplayPart(hintText, parameter, sourceFile!), { text: ":" }];
+            displayParts = [getNodeDisplayPart(hintText, parameter, sourceFile!), { text: ":" }];
+            hintText = "";
         }
         else {
             hintText += ":";
@@ -172,6 +174,7 @@ export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
             position,
             kind: InlayHintKind.Parameter,
             whitespaceAfter: true,
+            displayParts,
         });
     }
 

diff --git a/src/services/types.ts b/src/services/types.ts
@@ -866,11 +866,13 @@ export const enum InlayHintKind {
 }
 
 export interface InlayHint {
-    text: string | InlayHintDisplayPart[];
+    /** This property will be the empty string when displayParts is set. */
+    text: string;
     position: number;
     kind: InlayHintKind;
     whitespaceBefore?: boolean;
     whitespaceAfter?: boolean;
+    displayParts?: InlayHintDisplayPart[];
 }
 
 export interface InlayHintDisplayPart {

diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -2124,11 +2124,13 @@ declare namespace ts {
                 arguments: InlayHintsRequestArgs;
             }
             interface InlayHintItem {
-                text: string | InlayHintItemDisplayPart[];
+                /** This property will be the empty string when displayParts is set. */
+                text: string;
                 position: Location;
                 kind: InlayHintKind;
                 whitespaceBefore?: boolean;
                 whitespaceAfter?: boolean;
+                displayParts?: InlayHintItemDisplayPart[];
             }
             interface InlayHintItemDisplayPart {
                 text: string;
@@ -10390,11 +10392,13 @@ declare namespace ts {
         Enum = "Enum"
     }
     interface InlayHint {
-        text: string | InlayHintDisplayPart[];
+        /** This property will be the empty string when displayParts is set. */
+        text: string;
         position: number;
         kind: InlayHintKind;
         whitespaceBefore?: boolean;
         whitespaceAfter?: boolean;
+        displayParts?: InlayHintDisplayPart[];
     }
     interface InlayHintDisplayPart {
         text: string;

diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -6416,11 +6416,13 @@ declare namespace ts {
         Enum = "Enum"
     }
     interface InlayHint {
-        text: string | InlayHintDisplayPart[];
+        /** This property will be the empty string when displayParts is set. */
+        text: string;
         position: number;
         kind: InlayHintKind;
         whitespaceBefore?: boolean;
         whitespaceAfter?: boolean;
+        displayParts?: InlayHintDisplayPart[];
     }
     interface InlayHintDisplayPart {
         text: string;

diff --git a/tests/baselines/reference/inlayHintsShouldWork1.baseline b/tests/baselines/reference/inlayHintsShouldWork1.baseline
@@ -1,7 +1,11 @@
 foo(1, 2);
     ^
 {
-  "text": [
+  "text": "",
+  "position": 43,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "a",
       "span": {
@@ -13,16 +17,17 @@ foo(1, 2);
     {
       "text": ":"
     }
-  ],
-  "position": 43,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
 
 foo(1, 2);
        ^
 {
-  "text": [
+  "text": "",
+  "position": 46,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "b",
       "span": {
@@ -34,8 +39,5 @@ foo(1, 2);
     {
       "text": ":"
     }
-  ],
-  "position": 46,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
diff --git a/tests/baselines/reference/inlayHintsShouldWork11.baseline b/tests/baselines/reference/inlayHintsShouldWork11.baseline
@@ -1,7 +1,11 @@
 foo(1)(2);
     ^
 {
-  "text": [
+  "text": "",
+  "position": 87,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "a",
       "span": {
@@ -13,16 +17,17 @@ foo(1)(2);
     {
       "text": ":"
     }
-  ],
-  "position": 87,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
 
 foo(1)(2);
        ^
 {
-  "text": [
+  "text": "",
+  "position": 90,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "b",
       "span": {
@@ -34,8 +39,5 @@ foo(1)(2);
     {
       "text": ":"
     }
-  ],
-  "position": 90,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
diff --git a/tests/baselines/reference/inlayHintsShouldWork12.baseline b/tests/baselines/reference/inlayHintsShouldWork12.baseline
@@ -1,7 +1,11 @@
     return a(1) + 2
              ^
 {
-  "text": [
+  "text": "",
+  "position": 54,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "b",
       "span": {
@@ -13,16 +17,17 @@
     {
       "text": ":"
     }
-  ],
-  "position": 54,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
 
 foo((c: number) => c + 1);
     ^
 {
-  "text": [
+  "text": "",
+  "position": 67,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "a",
       "span": {
@@ -34,8 +39,5 @@ foo((c: number) => c + 1);
     {
       "text": ":"
     }
-  ],
-  "position": 67,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
diff --git a/tests/baselines/reference/inlayHintsShouldWork13.baseline b/tests/baselines/reference/inlayHintsShouldWork13.baseline
@@ -1,7 +1,11 @@
 foo(a, 2);
        ^
 {
-  "text": [
+  "text": "",
+  "position": 66,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "b",
       "span": {
@@ -13,8 +17,5 @@ foo(a, 2);
     {
       "text": ":"
     }
-  ],
-  "position": 66,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
diff --git a/tests/baselines/reference/inlayHintsShouldWork2.baseline b/tests/baselines/reference/inlayHintsShouldWork2.baseline
@@ -1,7 +1,11 @@
 foo(1, { c: 1 });
     ^
 {
-  "text": [
+  "text": "",
+  "position": 44,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "a",
       "span": {
@@ -13,8 +17,5 @@ foo(1, { c: 1 });
     {
       "text": ":"
     }
-  ],
-  "position": 44,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
diff --git a/tests/baselines/reference/inlayHintsShouldWork3.baseline b/tests/baselines/reference/inlayHintsShouldWork3.baseline
@@ -1,7 +1,11 @@
 foo(1, 1, 1, 1);
     ^
 {
-  "text": [
+  "text": "",
+  "position": 48,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "a",
       "span": {
@@ -13,16 +17,17 @@ foo(1, 1, 1, 1);
     {
       "text": ":"
     }
-  ],
-  "position": 48,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }
 
 foo(1, 1, 1, 1);
        ^
 {
-  "text": [
+  "text": "",
+  "position": 51,
+  "kind": "Parameter",
+  "whitespaceAfter": true,
+  "displayParts": [
     {
       "text": "...b",
       "span": {
@@ -34,8 +39,5 @@ foo(1, 1, 1, 1);
     {
       "text": ":"
     }
-  ],
-  "position": 51,
-  "kind": "Parameter",
-  "whitespaceAfter": true
+  ]
 }