vscode-languageserver-protocol

import { InitializeParams, TextDocumentSyncKind, TextDocumentSyncOptions, ServerCapabilities, CompletionItemKind, MarkupKind, Connection, InitializeRequest, InitializeResult, InitializeError, } from 'vscode-languageserver-protocol'; // Define a custom initialization options interface interface MyServerInitializationOptions { enableCustomFeature: boolean; } // Example of how a server might define its capabilities, // leveraging the protocol types. const serverCapabilities: ServerCapabilities = { textDocumentSync: { openClose: true, change: TextDocumentSyncKind.Incremental, willSave: true, willSaveWaitUntil: true, save: { includeText: true, }, } as TextDocumentSyncOptions, completionProvider: { resolveProvider: true, triggerCharacters: ['.', ':'], allCommitCharacters: ['\n', '\t'], completionItem: { labelDetailsSupport: true, }, completionItemKinds: [ CompletionItemKind.Keyword, CompletionItemKind.Variable, CompletionItemKind.Function, ], }, hoverProvider: true, }; // Types for a hypothetical server initialization logic function handleInitializeRequest(params: InitializeParams<MyServerInitializationOptions>): InitializeResult | InitializeError { console.log(`Client requested initialization with custom feature enabled: ${params.initializationOptions?.enableCustomFeature}`); if (params.processId === null) { return { jsonrpc: '2.0', id: null, error: { code: -32602, message: 'processId must not be null', }, }; } return { capabilities: serverCapabilities, serverInfo: { name: 'MyLanguageServer', version: '1.0.0', }, }; } // This connection object is typically provided by vscode-languageserver/node or browser // It's mocked here to show how protocol types fit in. const mockConnection: Connection = { sendRequest: (type, params) => Promise.resolve({ capabilities: {} }), sendNotification: (type, params) => {}, onRequest: (type, handler) => { if (type === InitializeRequest.type) { // Simulate an incoming initialize request handler({ processId: 123, capabilities: {}, initializationOptions: { enableCustomFeature: true } }); } }, onNotification: (type, handler) => {}, listen: () => {}, dispose: () => {}, } as Connection; mockConnection.onRequest(InitializeRequest.type, (params) => handleInitializeRequest(params)); console.log('Protocol types defined and a mock handler registered for demonstration.');