构建VSCode语言服务器的完整实现指南

<font face="monospace">
/my-lang-server
  /client     # VSCode 扩展部分
  /server     # 语言服务器逻辑
  package.json
</font>

<font face="monospace">
npm install vscode-languageserver vscode-languageserver-textdocument
npm install -D typescript ts-node @types/node
</font>

<font face="monospace">
import {
  createConnection,
  TextDocuments,
  ProposedFeatures,
  InitializeParams,
  InitializeResult
} from 'vscode-languageserver';
<p>import { TextDocument } from 'vscode-languageserver-textdocument';</p><p>// 创建双向连接
const connection = createConnection(ProposedFeatures.all);</p><p>// 管理打开的文档
const documents: TextDocuments<TextDocument> = new TextDocuments(TextDocument);</p><p>// 初始化钩子
connection.onInitialize((params: InitializeParams): InitializeResult => {
return {
capabilities: {
textDocumentSync: documents.syncKind,
completionProvider: { triggerCharacters: ['.'] }
}
};
});</p><p>// 注册补全功能
connection.onCompletion(() => {
return [
{ label: 'hello', kind: 1 },
{ label: 'world', kind: 1 }
];
});</p><p>// 文档变更监听
documents.listen(connection);
connection.listen();
</font>

<font face="monospace">
import * as cp from 'child_process';
import * as path from 'path';
import { ExtensionContext, languages, workspace } from 'vscode';
import { LanguageClient, ServerOptions, TransportKind } from 'vscode-languageclient/node';
<p>let client: LanguageClient;</p><p>export function activate(context: ExtensionContext) {
const serverModule = context.asAbsolutePath(path.join('..', 'server', 'out', 'server.js'));</p><p>const serverOptions: ServerOptions = {
run: { module: serverModule, transport: TransportKind.ipc },
debug: { 
module: serverModule,
transport: TransportKind.ipc,
options: { execArgv: ['--nolazy', '--inspect=6009'] }
}
};</p><p>const disposable = new LanguageClient(
'myLang',
'My Language',
serverOptions,
{ documentSelector: [{ language: 'javascript' }] }
);</p><p>context.subscriptions.push(disposable.start());
}
</font>

<font face="monospace">
"activationEvents": [
  "onLanguage:javascript"
],
"contributes": {
  "languages": [{
    "id": "javascript",
    "aliases": ["JavaScript"]
  }]
}
</font>

<font face="monospace">
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "outDir": "./out",
    "rootDir": "./src",
    "strict": true
  },
  "include": ["src"]
}
</font>

<font face="monospace">
{
  "name": "Run Extension",
  "type": "pwa-extensionHost",
  "request": "launch",
  "runtimeExecutable": "${execPath}",
  "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
  "outFiles": ["${workspaceFolder}/client/out/**/*.js"]
}
</font>

<font face="monospace">
documents.onDidChangeContent(change => {
  const diagnostics = [];
  const text = change.document.getText();
  if (text.includes('error')) {
    diagnostics.push({
      severity: 1,
      range: { ... },
      message: 'Found "error"'
    });
  }
  connection.sendDiagnostics({ uri: change.document.uri, diagnostics });
});
</font>