@astrojs/language-server 0.18.1 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @astrojs/language-server
 
+## 0.19.0
+
+### Minor Changes
+
+- a97b9a4: Add support for Inlay Hints. Minimum VS Code version supported starting from this update is 1.67.0 (April 2022)
+
 ## 0.18.1
 
 ### Patch Changes

package/dist/core/config/ConfigManager.d.ts

@@ -2,7 +2,7 @@ import { VSCodeEmmetConfig } from '@vscode/emmet-helper';
 import { LSConfig, LSCSSConfig, LSFormatConfig, LSHTMLConfig, LSTypescriptConfig } from './interfaces';
 import { Connection, FormattingOptions } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import { FormatCodeSettings, UserPreferences } from 'typescript';
+import { FormatCodeSettings, InlayHintsOptions, UserPreferences } from 'typescript';
 export declare const defaultLSConfig: LSConfig;
 declare type DeepPartial<T> = T extends Record<string, unknown> ? {
     [P in keyof T]?: DeepPartial<T[P]>;
@@ -25,14 +25,18 @@ export declare class ConfigManager {
     getAstroFormatConfig(document: TextDocument): Promise<LSFormatConfig>;
     getTSFormatConfig(document: TextDocument, vscodeOptions?: FormattingOptions): Promise<FormatCodeSettings>;
     getTSPreferences(document: TextDocument): Promise<UserPreferences>;
+    getTSInlayHintsPreferences(document: TextDocument): Promise<InlayHintsOptions>;
     /**
      * Return true if a plugin and an optional feature is enabled
      */
     isEnabled(document: TextDocument, plugin: keyof LSConfig, feature?: keyof LSTypescriptConfig | keyof LSCSSConfig | keyof LSHTMLConfig): Promise<boolean>;
     /**
      * Updating the global config should only be done in cases where the client doesn't support `workspace/configuration`
-     * or inside of tests
+     * or inside of tests.
+     *
+     * The `outsideAstro` parameter can be set to true to change configurations in the global scope.
+     * For example, to change TypeScript settings
      */
-    updateGlobalConfig(config: DeepPartial<LSConfig>): void;
+    updateGlobalConfig(config: DeepPartial<LSConfig> | any, outsideAstro?: boolean): void;
 }
 export {};

package/dist/core/config/ConfigManager.js

@@ -124,6 +124,20 @@ class ConfigManager {
             includeCompletionsWithInsertText: true,
         };
     }
+    async getTSInlayHintsPreferences(document) {
+        const config = (await this.getConfig('typescript', document.uri)) ?? {};
+        const tsPreferences = this.getTSPreferences(document);
+        return {
+            ...tsPreferences,
+            includeInlayParameterNameHints: getInlayParameterNameHintsPreference(config),
+            includeInlayParameterNameHintsWhenArgumentMatchesName: !(config.inlayHints?.parameterNames?.suppressWhenArgumentMatchesName ?? true),
+            includeInlayFunctionParameterTypeHints: config.inlayHints?.parameterTypes?.enabled ?? false,
+            includeInlayVariableTypeHints: config.inlayHints?.variableTypes?.enabled ?? false,
+            includeInlayPropertyDeclarationTypeHints: config.inlayHints?.propertyDeclarationTypes?.enabled ?? false,
+            includeInlayFunctionLikeReturnTypeHints: config.inlayHints?.functionLikeReturnTypes?.enabled ?? false,
+            includeInlayEnumMemberValueHints: config.inlayHints?.enumMemberValues?.enabled ?? false,
+        };
+    }
     /**
      * Return true if a plugin and an optional feature is enabled
      */
@@ -133,10 +147,18 @@ class ConfigManager {
     }
     /**
      * Updating the global config should only be done in cases where the client doesn't support `workspace/configuration`
-     * or inside of tests
+     * or inside of tests.
+     *
+     * The `outsideAstro` parameter can be set to true to change configurations in the global scope.
+     * For example, to change TypeScript settings
      */
-    updateGlobalConfig(config) {
-        this.globalConfig.astro = (0, lodash_1.merge)({}, exports.defaultLSConfig, this.globalConfig.astro, config);
+    updateGlobalConfig(config, outsideAstro) {
+        if (outsideAstro) {
+            this.globalConfig = (0, lodash_1.merge)({}, this.globalConfig, config);
+        }
+        else {
+            this.globalConfig.astro = (0, lodash_1.merge)({}, exports.defaultLSConfig, this.globalConfig.astro, config);
+        }
     }
 }
 exports.ConfigManager = ConfigManager;
@@ -174,3 +196,15 @@ function getImportModuleSpecifierEndingPreference(config) {
             return 'auto';
     }
 }
+function getInlayParameterNameHintsPreference(config) {
+    switch (config.inlayHints?.parameterNames?.enabled) {
+        case 'none':
+            return 'none';
+        case 'literals':
+            return 'literals';
+        case 'all':
+            return 'all';
+        default:
+            return undefined;
+    }
+}

package/dist/plugins/PluginHost.d.ts

@@ -1,4 +1,4 @@
-import { CancellationToken, Color, ColorInformation, ColorPresentation, CompletionContext, CompletionItem, CompletionList, DefinitionLink, Diagnostic, FoldingRange, Hover, Position, Range, Location, SignatureHelp, SignatureHelpContext, TextDocumentContentChangeEvent, TextDocumentIdentifier, WorkspaceEdit, SymbolInformation, SemanticTokens, CodeActionContext, CodeAction, FormattingOptions, TextEdit } from 'vscode-languageserver';
+import { CancellationToken, Color, ColorInformation, ColorPresentation, CompletionContext, CompletionItem, CompletionList, DefinitionLink, Diagnostic, FoldingRange, Hover, Position, Range, Location, SignatureHelp, SignatureHelpContext, TextDocumentContentChangeEvent, TextDocumentIdentifier, WorkspaceEdit, SymbolInformation, SemanticTokens, CodeActionContext, CodeAction, InlayHint, FormattingOptions, TextEdit } from 'vscode-languageserver';
 import type { AppCompletionItem, Plugin } from './interfaces';
 import { DocumentManager } from '../core/documents/DocumentManager';
 interface PluginHostConfig {
@@ -25,6 +25,7 @@ export declare class PluginHost {
     getDefinitions(textDocument: TextDocumentIdentifier, position: Position): Promise<DefinitionLink[] | Location[]>;
     rename(textDocument: TextDocumentIdentifier, position: Position, newName: string): Promise<WorkspaceEdit | null>;
     getDocumentColors(textDocument: TextDocumentIdentifier): Promise<ColorInformation[]>;
+    getInlayHints(textDocument: TextDocumentIdentifier, range: Range, cancellationToken: CancellationToken): Promise<InlayHint[]>;
     getColorPresentations(textDocument: TextDocumentIdentifier, range: Range, color: Color): Promise<ColorPresentation[]>;
     getSignatureHelp(textDocument: TextDocumentIdentifier, position: Position, context: SignatureHelpContext | undefined, cancellationToken: CancellationToken): Promise<SignatureHelp | null>;
     onWatchFileChanges(onWatchFileChangesParams: any[]): void;

package/dist/plugins/PluginHost.js

@@ -112,6 +112,10 @@ class PluginHost {
         const document = this.getDocument(textDocument.uri);
         return (0, lodash_1.flatten)(await this.execute('getDocumentColors', [document], ExecuteMode.Collect));
     }
+    async getInlayHints(textDocument, range, cancellationToken) {
+        const document = this.getDocument(textDocument.uri);
+        return (0, lodash_1.flatten)(await this.execute('getInlayHints', [document, range], ExecuteMode.FirstNonNull));
+    }
     async getColorPresentations(textDocument, range, color) {
         const document = this.getDocument(textDocument.uri);
         return (0, lodash_1.flatten)(await this.execute('getColorPresentations', [document, range, color], ExecuteMode.Collect));

package/dist/plugins/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { CodeAction, CodeActionContext, Color, ColorInformation, ColorPresentation, CompletionContext, CompletionItem, CompletionList, DefinitionLink, Diagnostic, FileChangeType, FoldingRange, FormattingOptions, Hover, LinkedEditingRanges, Position, Range, ReferenceContext, SelectionRange, SemanticTokens, SignatureHelp, SignatureHelpContext, SymbolInformation, TextDocumentContentChangeEvent, TextDocumentIdentifier, TextEdit, WorkspaceEdit } from 'vscode-languageserver';
+import { CodeAction, CodeActionContext, Color, ColorInformation, ColorPresentation, CompletionContext, CompletionItem, CompletionList, DefinitionLink, Diagnostic, FileChangeType, FoldingRange, FormattingOptions, Hover, InlayHint, LinkedEditingRanges, Position, Range, ReferenceContext, SelectionRange, SemanticTokens, SignatureHelp, SignatureHelpContext, SymbolInformation, TextDocumentContentChangeEvent, TextDocumentIdentifier, TextEdit, WorkspaceEdit } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 export declare type Resolvable<T> = T | Promise<T>;
 export interface AppCompletionItem<T extends TextDocumentIdentifier = any> extends CompletionItem {
@@ -52,6 +52,9 @@ export interface FileRename {
 export interface UpdateImportsProvider {
     updateImports(fileRename: FileRename): Resolvable<WorkspaceEdit | null>;
 }
+export interface InlayHintsProvider {
+    getInlayHints(document: TextDocument, range: Range): Resolvable<InlayHint[]>;
+}
 export interface RenameProvider {
     rename(document: TextDocument, position: Position, newName: string): Resolvable<WorkspaceEdit | null>;
     prepareRename(document: TextDocument, position: Position): Resolvable<Range | null>;
@@ -81,7 +84,7 @@ export interface OnWatchFileChangesProvider {
 export interface UpdateNonAstroFile {
     updateNonAstroFile(fileName: string, changes: TextDocumentContentChangeEvent[]): void;
 }
-declare type ProviderBase = DiagnosticsProvider & HoverProvider & CompletionsProvider & DefinitionsProvider & FormattingProvider & FoldingRangesProvider & TagCompleteProvider & DocumentColorsProvider & ColorPresentationsProvider & DocumentSymbolsProvider & UpdateImportsProvider & CodeActionsProvider & FindReferencesProvider & RenameProvider & SignatureHelpProvider & SemanticTokensProvider & SelectionRangeProvider & OnWatchFileChangesProvider & LinkedEditingRangesProvider & UpdateNonAstroFile;
+declare type ProviderBase = DiagnosticsProvider & HoverProvider & CompletionsProvider & DefinitionsProvider & FormattingProvider & FoldingRangesProvider & TagCompleteProvider & DocumentColorsProvider & ColorPresentationsProvider & DocumentSymbolsProvider & UpdateImportsProvider & CodeActionsProvider & FindReferencesProvider & RenameProvider & SignatureHelpProvider & SemanticTokensProvider & SelectionRangeProvider & OnWatchFileChangesProvider & LinkedEditingRangesProvider & InlayHintsProvider & UpdateNonAstroFile;
 export declare type LSProvider = ProviderBase;
 export declare type Plugin = Partial<ProviderBase> & {
     __name: string;

package/dist/plugins/typescript/TypeScriptPlugin.d.ts

@@ -1,4 +1,4 @@
-import { CancellationToken, CodeAction, CodeActionContext, CompletionContext, DefinitionLink, Diagnostic, FoldingRange, FormattingOptions, Hover, Position, Range, SemanticTokens, SignatureHelp, SignatureHelpContext, SymbolInformation, TextDocumentContentChangeEvent, TextEdit, WorkspaceEdit } from 'vscode-languageserver';
+import { CancellationToken, CodeAction, CodeActionContext, CompletionContext, DefinitionLink, Diagnostic, FoldingRange, FormattingOptions, Hover, InlayHint, Position, Range, SemanticTokens, SignatureHelp, SignatureHelpContext, SymbolInformation, TextDocumentContentChangeEvent, TextEdit, WorkspaceEdit } from 'vscode-languageserver';
 import { ConfigManager } from '../../core/config';
 import { AstroDocument, DocumentManager } from '../../core/documents';
 import { AppCompletionItem, AppCompletionList, OnWatchFileChangesParam, Plugin } from '../interfaces';
@@ -14,6 +14,7 @@ export declare class TypeScriptPlugin implements Plugin {
     private readonly signatureHelpProvider;
     private readonly diagnosticsProvider;
     private readonly documentSymbolsProvider;
+    private readonly inlayHintsProvider;
     private readonly semanticTokensProvider;
     private readonly foldingRangesProvider;
     private readonly formattingProvider;
@@ -27,6 +28,7 @@ export declare class TypeScriptPlugin implements Plugin {
     getCodeActions(document: AstroDocument, range: Range, context: CodeActionContext, cancellationToken?: CancellationToken): Promise<CodeAction[]>;
     getCompletions(document: AstroDocument, position: Position, completionContext?: CompletionContext, cancellationToken?: CancellationToken): Promise<AppCompletionList<CompletionItemData> | null>;
     resolveCompletion(document: AstroDocument, completionItem: AppCompletionItem<CompletionItemData>, cancellationToken?: CancellationToken): Promise<AppCompletionItem<CompletionItemData>>;
+    getInlayHints(document: AstroDocument, range: Range): Promise<InlayHint[]>;
     getDefinitions(document: AstroDocument, position: Position): Promise<DefinitionLink[]>;
     getDiagnostics(document: AstroDocument, cancellationToken?: CancellationToken): Promise<Diagnostic[]>;
     onWatchFileChanges(onWatchFileChangesParas: OnWatchFileChangesParam[]): Promise<void>;

package/dist/plugins/typescript/TypeScriptPlugin.js

@@ -17,6 +17,7 @@ const SemanticTokenProvider_1 = require("./features/SemanticTokenProvider");
 const FoldingRangesProvider_1 = require("./features/FoldingRangesProvider");
 const CodeActionsProvider_1 = require("./features/CodeActionsProvider");
 const DefinitionsProvider_1 = require("./features/DefinitionsProvider");
+const InlayHintsProvider_1 = require("./features/InlayHintsProvider");
 const FormattingProvider_1 = require("./features/FormattingProvider");
 class TypeScriptPlugin {
     constructor(docManager, configManager, workspaceUris) {
@@ -31,6 +32,7 @@ class TypeScriptPlugin {
         this.diagnosticsProvider = new DiagnosticsProvider_1.DiagnosticsProviderImpl(this.languageServiceManager);
         this.documentSymbolsProvider = new DocumentSymbolsProvider_1.DocumentSymbolsProviderImpl(this.languageServiceManager);
         this.semanticTokensProvider = new SemanticTokenProvider_1.SemanticTokensProviderImpl(this.languageServiceManager);
+        this.inlayHintsProvider = new InlayHintsProvider_1.InlayHintsProviderImpl(this.languageServiceManager, this.configManager);
         this.foldingRangesProvider = new FoldingRangesProvider_1.FoldingRangesProviderImpl(this.languageServiceManager);
         this.formattingProvider = new FormattingProvider_1.FormattingProviderImpl(this.languageServiceManager, this.configManager);
     }
@@ -98,6 +100,9 @@ class TypeScriptPlugin {
     async resolveCompletion(document, completionItem, cancellationToken) {
         return this.completionProvider.resolveCompletion(document, completionItem, cancellationToken);
     }
+    async getInlayHints(document, range) {
+        return this.inlayHintsProvider.getInlayHints(document, range);
+    }
     async getDefinitions(document, position) {
         return this.definitionsProvider.getDefinitions(document, position);
     }

package/dist/plugins/typescript/features/InlayHintsProvider.d.ts

@@ -0,0 +1,12 @@
+import { InlayHint } from 'vscode-languageserver';
+import { AstroDocument } from '../../../core/documents';
+import { InlayHintsProvider } from '../../interfaces';
+import { LanguageServiceManager } from '../LanguageServiceManager';
+import { Range } from 'vscode-languageserver-types';
+import { ConfigManager } from '../../../core/config';
+export declare class InlayHintsProviderImpl implements InlayHintsProvider {
+    private languageServiceManager;
+    private configManager;
+    constructor(languageServiceManager: LanguageServiceManager, configManager: ConfigManager);
+    getInlayHints(document: AstroDocument, range: Range): Promise<InlayHint[]>;
+}

package/dist/plugins/typescript/features/InlayHintsProvider.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InlayHintsProviderImpl = void 0;
+const vscode_languageserver_1 = require("vscode-languageserver");
+const utils_1 = require("../utils");
+const vscode_languageserver_types_1 = require("vscode-languageserver-types");
+const typescript_1 = __importDefault(require("typescript"));
+class InlayHintsProviderImpl {
+    constructor(languageServiceManager, configManager) {
+        this.languageServiceManager = languageServiceManager;
+        this.configManager = configManager;
+    }
+    async getInlayHints(document, range) {
+        const { lang, tsDoc } = await this.languageServiceManager.getLSAndTSDoc(document);
+        const filePath = (0, utils_1.toVirtualAstroFilePath)(tsDoc.filePath);
+        const fragment = await tsDoc.createFragment();
+        const start = fragment.offsetAt(fragment.getGeneratedPosition(range.start));
+        const end = fragment.offsetAt(fragment.getGeneratedPosition(range.end));
+        const tsPreferences = await this.configManager.getTSInlayHintsPreferences(document);
+        const inlayHints = lang.provideInlayHints(filePath, { start, length: end - start }, tsPreferences);
+        return inlayHints.map((hint) => {
+            const result = vscode_languageserver_1.InlayHint.create(fragment.getOriginalPosition(fragment.positionAt(hint.position)), hint.text, hint.kind === typescript_1.default.InlayHintKind.Type
+                ? vscode_languageserver_types_1.InlayHintKind.Type
+                : hint.kind === typescript_1.default.InlayHintKind.Parameter
+                    ? vscode_languageserver_types_1.InlayHintKind.Parameter
+                    : undefined);
+            result.paddingLeft = hint.whitespaceBefore;
+            result.paddingRight = hint.whitespaceAfter;
+            return result;
+        });
+    }
+}
+exports.InlayHintsProviderImpl = InlayHintsProviderImpl;

package/dist/server.js

@@ -134,6 +134,7 @@ function startLanguageServer(connection) {
                     range: true,
                     full: true,
                 },
+                inlayHintProvider: true,
                 signatureHelpProvider: {
                     triggerCharacters: ['(', ',', '<'],
                     retriggerCharacters: [')'],
@@ -197,6 +198,7 @@ function startLanguageServer(connection) {
     connection.onDocumentFormatting((params) => pluginHost.formatDocument(params.textDocument, params.options));
     connection.onDocumentColor((params) => pluginHost.getDocumentColors(params.textDocument));
     connection.onColorPresentation((params) => pluginHost.getColorPresentations(params.textDocument, params.range, params.color));
+    connection.onRequest(vscode_languageserver_1.InlayHintRequest.type, (params, cancellationToken) => pluginHost.getInlayHints(params.textDocument, params.range, cancellationToken));
     connection.onRequest(TagCloseRequest, (evt) => pluginHost.doTagComplete(evt.textDocument, evt.position));
     connection.onSignatureHelp((evt, cancellationToken) => pluginHost.getSignatureHelp(evt.textDocument, evt.position, evt.context, cancellationToken));
     connection.onRenameRequest((evt) => pluginHost.rename(evt.textDocument, evt.position, evt.newName));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/language-server",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "author": "withastro",
   "license": "MIT",
   "type": "commonjs",
@@ -24,14 +24,14 @@
     "@vscode/emmet-helper": "^2.8.4",
     "lodash": "^4.17.21",
     "source-map": "^0.7.3",
-    "typescript": "~4.6.2",
-    "vscode-css-languageservice": "^5.1.13",
-    "vscode-html-languageservice": "^4.2.5",
-    "vscode-languageserver": "7.0.0",
-    "vscode-languageserver-protocol": "^3.16.0",
-    "vscode-languageserver-textdocument": "^1.0.1",
-    "vscode-languageserver-types": "^3.16.0",
-    "vscode-uri": "^3.0.2"
+    "typescript": "~4.6.4",
+    "vscode-css-languageservice": "^6.0.1",
+    "vscode-html-languageservice": "^5.0.0",
+    "vscode-languageserver": "^8.0.1",
+    "vscode-languageserver-protocol": "^3.17.1",
+    "vscode-languageserver-textdocument": "^1.0.4",
+    "vscode-languageserver-types": "^3.17.1",
+    "vscode-uri": "^3.0.3"
   },
   "devDependencies": {
     "@types/chai": "^4.3.0",