Skip to content

Move to vscode-languageclient 8.0.2 for Qute LS #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 26, 2023
+147 −297
Merged

Move to vscode-languageclient 8.0.2 for Qute LS #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 47 additions & 43 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,8 +480,8 @@
"lodash": "^4.17.21",
"request": "^2.88.0",
"request-promise": "^4.2.4",
"vscode-languageclient": "^7.0.0",
"vscode-languageserver-protocol": "^3.17.1",
"vscode-languageclient": "^8.0.2",
"vscode-languageserver-protocol": "^3.17.2",
"which": "^2.0.2",
"yauzl": "^2.10.0"
}
Expand Down
205 changes: 98 additions & 107 deletions src/qute/languageServer/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,130 +1,121 @@
import * as requirements from './requirements';
import { resolveRequirements } from './requirements';

import { DidChangeConfigurationNotification, LanguageClientOptions } from 'vscode-languageclient';
import { LanguageClient } from 'vscode-languageclient/node';
import { ExtensionContext, commands, workspace, window, ConfigurationTarget, languages } from 'vscode';
import { ExtensionContext, commands, workspace, window, ConfigurationTarget } from 'vscode';
import { prepareExecutable } from './quteServerStarter';
import { registerQuteExecuteWorkspaceCommand, registerVSCodeQuteCommands, synchronizeQuteValidationButton } from '../commands/registerCommands';
import { QuteClientCommandConstants } from '../commands/commandConstants';
import { QuteSettings } from './settings';
import { JavaExtensionAPI } from '../../extension';
import { QuteInlayHintsProvider } from './inlayHintsProvider';

export function connectToQuteLS(context: ExtensionContext, api: JavaExtensionAPI) {
export async function connectToQuteLS(context: ExtensionContext, api: JavaExtensionAPI) {
registerVSCodeQuteCommands(context);

return requirements.resolveRequirements(api).then(requirements => {
const clientOptions: LanguageClientOptions = {
documentSelector: [
{ scheme: 'file', language: 'qute-html' },
{ scheme: 'file', language: 'qute-json' },
{ scheme: 'file', language: 'qute-yaml' },
{ scheme: 'file', language: 'qute-txt' },
{ scheme: 'untitled', language: 'qute-html' },
{ scheme: 'vscode-notebook-cell', language: 'qute-html' },
{ scheme: 'file', language: 'java' }
],
// wrap with key 'settings' so it can be handled same a DidChangeConfiguration
initializationOptions: {
settings: getQuteSettings(),
extendedClientCapabilities: {
commands: {
commandsKind: {
valueSet: [
QuteClientCommandConstants.OPEN_URI,
QuteClientCommandConstants.JAVA_DEFINTION,
QuteClientCommandConstants.COMMAND_CONFIGURATION_UPDATE
]
}
},
shouldLanguageServerExitOnShutdown: true
}
},
synchronize: {
// preferences starting with these will trigger didChangeConfiguration
configurationSection: ['qute']
},
middleware: {
workspace: {
didChangeConfiguration: async () => {
// A settings.json is updated:
// 1. send the new Quet settings to the Qute language server
quteLanguageClient.sendNotification(DidChangeConfigurationNotification.type, { settings: getQuteSettings() });
// 2. synchronize the Qute toggle button for validation
await synchronizeQuteValidationButton(window.activeTextEditor);
const requirements = await resolveRequirements(api);

const clientOptions: LanguageClientOptions = {
documentSelector: [
{ scheme: 'file', language: 'qute-html' },
{ scheme: 'file', language: 'qute-json' },
{ scheme: 'file', language: 'qute-yaml' },
{ scheme: 'file', language: 'qute-txt' },
{ scheme: 'untitled', language: 'qute-html' },
{ scheme: 'vscode-notebook-cell', language: 'qute-html' },
{ scheme: 'file', language: 'java' }
],
// wrap with key 'settings' so it can be handled same a DidChangeConfiguration
initializationOptions: {
settings: getQuteSettings(),
extendedClientCapabilities: {
commands: {
commandsKind: {
valueSet: [
QuteClientCommandConstants.OPEN_URI,
QuteClientCommandConstants.JAVA_DEFINTION,
QuteClientCommandConstants.COMMAND_CONFIGURATION_UPDATE
]
}
}
}
};

function bindQuteRequest(request: string) {
quteLanguageClient.onRequest(request, async (params: any) =>
<any>await commands.executeCommand("java.execute.workspaceCommand", request, params)
);
}

function bindQuteNotification(notification: string) {
context.subscriptions.push(commands.registerCommand(notification, (event: any) => {
quteLanguageClient.sendNotification(notification, event);
}));
},
synchronize: {
// preferences starting with these will trigger didChangeConfiguration
configurationSection: ['qute']
},
middleware: {
workspace: {
didChangeConfiguration: async () => {
// A settings.json is updated:
// 1. send the new Quet settings to the Qute language server
const result = quteLanguageClient.sendNotification(DidChangeConfigurationNotification.type, { settings: getQuteSettings() });
// 2. synchronize the Qute toggle button for validation
await synchronizeQuteValidationButton(window.activeTextEditor);
return result;
}
}
}
};

const serverOptions = prepareExecutable(requirements);
const quteLanguageClient = new LanguageClient('qute', 'Qute Support', serverOptions, clientOptions);
context.subscriptions.push(quteLanguageClient.start());
function bindQuteRequest(request: string) {
quteLanguageClient.onRequest(request, async (params: any) =>
<any>await commands.executeCommand("java.execute.workspaceCommand", request, params)
);
}

return quteLanguageClient.onReady().then(async () => {
bindQuteRequest('qute/template/project');
bindQuteRequest('qute/template/projectDataModel');
bindQuteRequest('qute/template/userTags');
bindQuteRequest('qute/template/javaTypes');
bindQuteRequest('qute/template/resolvedJavaType');
bindQuteRequest('qute/template/javaDefinition');
bindQuteRequest('qute/template/javadoc');
bindQuteRequest('qute/template/generateMissingJavaMember');
bindQuteRequest('qute/java/codeLens');
bindQuteRequest('qute/java/diagnostics');
bindQuteRequest('qute/java/documentLink');
bindQuteNotification('qute/dataModelChanged');
function bindQuteNotification(notification: string) {
context.subscriptions.push(commands.registerCommand(notification, (event: any) => {
quteLanguageClient.sendNotification(notification, event);
}));
}

registerQuteExecuteWorkspaceCommand(context, quteLanguageClient);
// Refresh the Qute context when editor tab has the focus
context.subscriptions.push(
window.onDidChangeActiveTextEditor(async editor => {
await synchronizeQuteValidationButton(editor);
})
);
// Refresh the Qute context when the language id changed (HTML -> Qute HTML or Qute HTML -> HTML)
context.subscriptions.push(
workspace.onDidOpenTextDocument(async (document) => {
// when settings.json is updated, onDidOpenTextDocument is called,
// the Qute context must be refreshed only for the activate text editor.
if (window.activeTextEditor?.document === document) {
await synchronizeQuteValidationButton(window.activeTextEditor);
}
// Display the experimental Qute validation pop-up if it hasn't been displayed and a Qute file is open
if (!hasShownQuteValidationPopUp(context) && document.languageId.includes('qute')) {
showQuteValidationPopUp(context);
}
})
);
const serverOptions = prepareExecutable(requirements);
const quteLanguageClient = new LanguageClient('qute', 'Qute Support', serverOptions, clientOptions);
await quteLanguageClient.start();

bindQuteRequest('qute/template/project');
bindQuteRequest('qute/template/projectDataModel');
bindQuteRequest('qute/template/userTags');
bindQuteRequest('qute/template/javaTypes');
bindQuteRequest('qute/template/resolvedJavaType');
bindQuteRequest('qute/template/javaDefinition');
bindQuteRequest('qute/template/javadoc');
bindQuteRequest('qute/template/generateMissingJavaMember');
bindQuteRequest('qute/java/codeLens');
bindQuteRequest('qute/java/diagnostics');
bindQuteRequest('qute/java/documentLink');
bindQuteNotification('qute/dataModelChanged');

registerQuteExecuteWorkspaceCommand(context, quteLanguageClient);
// Refresh the Qute context when editor tab has the focus
context.subscriptions.push(
window.onDidChangeActiveTextEditor(async editor => {
await synchronizeQuteValidationButton(editor);
})
);
// Refresh the Qute context when the language id changed (HTML -> Qute HTML or Qute HTML -> HTML)
context.subscriptions.push(
workspace.onDidOpenTextDocument(async (document) => {
// when settings.json is updated, onDidOpenTextDocument is called,
// the Qute context must be refreshed only for the activate text editor.
if (window.activeTextEditor?.document === document) {
await synchronizeQuteValidationButton(window.activeTextEditor);
}
// Display the experimental Qute validation pop-up if it hasn't been displayed and a Qute file is open
if (!hasShownQuteValidationPopUp(context)) {
for (const textDocument of workspace.textDocuments) {
if (textDocument.languageId.includes('qute')) {
showQuteValidationPopUp(context);
}
}
if (!hasShownQuteValidationPopUp(context) && document.languageId.includes('qute')) {
showQuteValidationPopUp(context);
}
await setQuteValidationEnabledContext();
await synchronizeQuteValidationButton(window.activeTextEditor);

const supportRegisterInlayHintsProvider = (languages as any).registerInlayHintsProvider;
if (supportRegisterInlayHintsProvider) {
context.subscriptions.push(languages.registerInlayHintsProvider(clientOptions.documentSelector, new QuteInlayHintsProvider(quteLanguageClient)));
})
);
// Display the experimental Qute validation pop-up if it hasn't been displayed and a Qute file is open
if (!hasShownQuteValidationPopUp(context)) {
for (const textDocument of workspace.textDocuments) {
if (textDocument.languageId.includes('qute')) {
showQuteValidationPopUp(context);
}
});
});
}
}
await setQuteValidationEnabledContext();
await synchronizeQuteValidationButton(window.activeTextEditor);
}

/**
Expand Down
Loading