Some cleanup around inlay hints types to get more-precise checking.

microsoft · Aug 21, 2021 · a2cefc5 · a2cefc5
1 parent 08358f3
commit a2cefc5
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 9 deletions.
diff --git a/src/harness/client.ts b/src/harness/client.ts
@@ -653,7 +653,7 @@ namespace ts.server {
 
             return response.body!.map(item => ({ // TODO: GH#18217
                 ...item,
-                kind: item.kind as InlayHintKind | undefined,
+                kind: item.kind as InlayHintKind,
                 position: this.lineOffsetToPosition(file, item.position),
             }));
         }

diff --git a/src/server/protocol.ts b/src/server/protocol.ts
@@ -2562,11 +2562,7 @@ namespace ts.server.protocol {
         body?: SignatureHelpItems;
     }
 
-    export const enum InlayHintKind {
-        Type = "Type",
-        Parameter = "Parameter",
-        Enum = "Enum",
-    }
+    export type InlayHintKind = "Type" | "Parameter" | "Enum";
 
     export interface InlayHintsRequestArgs extends FileRequestArgs {
         /**
@@ -2587,7 +2583,7 @@ namespace ts.server.protocol {
     export interface InlayHintItem {
         text: string;
         position: Location;
-        kind?: InlayHintKind;
+        kind: InlayHintKind;
         whitespaceBefore?: boolean;
         whitespaceAfter?: boolean;
     }

diff --git a/src/server/session.ts b/src/server/session.ts
@@ -1452,7 +1452,7 @@ namespace ts.server {
             });
         }
 
-        private provideInlayHints(args: protocol.InlayHintsRequestArgs) {
+        private provideInlayHints(args: protocol.InlayHintsRequestArgs): readonly protocol.InlayHintItem[] {
             const { file, project } = this.getFileAndProject(args);
             const scriptInfo = this.projectService.getScriptInfoForNormalizedPath(file)!;
             const hints = project.getLanguageService().provideInlayHints(file, args, this.getPreferences(file));

diff --git a/src/services/types.ts b/src/services/types.ts
@@ -720,7 +720,7 @@ namespace ts {
     export interface InlayHint {
         text: string;
         position: number;
-        kind?: InlayHintKind;
+        kind: InlayHintKind;
         whitespaceBefore?: boolean;
         whitespaceAfter?: boolean;
     }