Skip to content

Add WorkspaceFoldersClientCapabilites #1627

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add WorkspaceFoldersClientCapabilites #1627

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
10 changes: 5 additions & 5 deletions client/src/common/workspaceFolder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import * as UUID from './utils/uuid';

import { workspace, Disposable, WorkspaceFolder as VWorkspaceFolder, WorkspaceFoldersChangeEvent as VWorkspaceFoldersChangeEvent } from 'vscode';

import { DynamicFeature, RegistrationData, FeatureClient, NextSignature, FeatureState } from './features';
import { DynamicFeature, RegistrationData, FeatureClient, NextSignature, FeatureState, ensure } from './features';
import {
ClientCapabilities, InitializeParams, CancellationToken, ServerCapabilities, WorkspaceFoldersRequest, WorkspaceFolder,
DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, RegistrationType
ClientCapabilities, WorkspaceFoldersClientCapabilities, InitializeParams, CancellationToken, ServerCapabilities, WorkspaceFoldersRequest, WorkspaceFolder,
DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, RegistrationType,
} from 'vscode-languageserver-protocol';

function access<T, K extends keyof T>(target: T | undefined, key: K): T[K] | undefined {
Expand Down Expand Up @@ -68,8 +68,8 @@ export class WorkspaceFoldersFeature implements DynamicFeature<void> {
}

public fillClientCapabilities(capabilities: ClientCapabilities): void {
capabilities.workspace = capabilities.workspace || {};
capabilities.workspace.workspaceFolders = true;
const workspaceFoldersSupport = ensure(ensure(ensure(capabilities, 'workspace')!, 'workspaceFolders')! as WorkspaceFoldersClientCapabilities, 'changeNotifications')!;
workspaceFoldersSupport.dynamicRegistration = true;
}

public initialize(capabilities: ServerCapabilities): void {
Expand Down
41 changes: 39 additions & 2 deletions protocol/metaModel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2081,6 +2081,7 @@
"method": "workspace/didChangeWorkspaceFolders",
"typeName": "DidChangeWorkspaceFoldersNotification",
"messageDirection": "clientToServer",
"clientCapability": "workspace.workspaceFolders.changeNotifications",
"serverCapability": "workspace.workspaceFolders.changeNotifications",
"params": {
"kind": "reference",
Expand Down Expand Up @@ -11206,8 +11207,17 @@
{
"name": "workspaceFolders",
"type": {
"kind": "base",
"name": "boolean"
"kind": "or",
"items": [
{
"kind": "base",
"name": "boolean"
},
{
"kind": "reference",
"name": "WorkspaceFoldersClientCapabilities"
}
]
},
"optional": true,
"documentation": "The client has support for workspace folders.\n\n@since 3.6.0",
Expand Down Expand Up @@ -12256,6 +12266,33 @@
],
"documentation": "The client capabilities of a {@link ExecuteCommandRequest}."
},
{
"name": "WorkspaceFoldersClientCapabilities",
"properties": [
{
"name": "changeNotifications",
"type": {
"kind": "literal",
"value": {
"properties": [
{
"name": "dynamicRegistration",
"type": {
"kind": "base",
"name": "boolean"
},
"optional": true,
"documentation": "Whether the client supports dynamic registration for the\n`workspace/didChangeWorkspaceFolders` notification."
}
]
}
},
"optional": true,
"documentation": "The client has support for workspace folder change notifications.\n\n@since 3.18.0",
"since": "3.18.0"
}
]
},
{
"name": "SemanticTokensWorkspaceClientCapabilities",
"properties": [
Expand Down
8 changes: 5 additions & 3 deletions protocol/src/common/protocol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import {

import {
WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams,
WorkspaceFoldersChangeEvent, WorkspaceFoldersInitializeParams, WorkspaceFoldersServerCapabilities
WorkspaceFoldersChangeEvent, WorkspaceFoldersInitializeParams, WorkspaceFoldersClientCapabilities, WorkspaceFoldersServerCapabilities
} from './protocol.workspaceFolder';

import {
Expand Down Expand Up @@ -605,7 +605,7 @@ export interface WorkspaceClientCapabilities {
*
* @since 3.6.0
*/
workspaceFolders?: boolean;
workspaceFolders?: boolean | WorkspaceFoldersClientCapabilities;

/**
* The client supports `workspace/configuration` requests.
Expand Down Expand Up @@ -4404,7 +4404,9 @@ export {
InlineCompletionClientCapabilities, InlineCompletionOptions, InlineCompletionParams, InlineCompletionRegistrationOptions, InlineCompletionRequest,
// Text Document Content
TextDocumentContentClientCapabilities, TextDocumentContentOptions, TextDocumentContentRegistrationOptions, TextDocumentContentParams, TextDocumentContentResult,
TextDocumentContentRequest, TextDocumentContentRefreshParams, TextDocumentContentRefreshRequest
TextDocumentContentRequest, TextDocumentContentRefreshParams, TextDocumentContentRefreshRequest,
// Workspace Folders
WorkspaceFoldersClientCapabilities
};

// To be backwards compatible
Expand Down
17 changes: 16 additions & 1 deletion protocol/src/common/protocol.workspaceFolder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@ export interface WorkspaceFoldersInitializeParams {
workspaceFolders?: WorkspaceFolder[] | null;
}

export interface WorkspaceFoldersClientCapabilities {
/**
* The client has support for workspace folder change notifications.
*
* @since 3.18.0
*/
changeNotifications?: {
/**
* Whether the client supports dynamic registration for the
* `workspace/didChangeWorkspaceFolders` notification.
*/
dynamicRegistration?: boolean;
};
}

export interface WorkspaceFoldersServerCapabilities {

/**
Expand Down Expand Up @@ -62,7 +77,7 @@ export namespace DidChangeWorkspaceFoldersNotification {
export const type = new ProtocolNotificationType<DidChangeWorkspaceFoldersParams, void>(method);
export type HandlerSignature = NotificationHandler<DidChangeWorkspaceFoldersParams>;
export type MiddlewareSignature = (params: DidChangeWorkspaceFoldersParams, next: HandlerSignature) => void;
export const capabilities = CM.create(undefined, 'workspace.workspaceFolders.changeNotifications');
export const capabilities = CM.create('workspace.workspaceFolders.changeNotifications', 'workspace.workspaceFolders.changeNotifications');
}

/**
Expand Down
6 changes: 3 additions & 3 deletions server/src/common/workspaceFolder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

import {
Event, Emitter, Disposable, ClientCapabilities, WorkspaceFolder, WorkspaceFoldersChangeEvent, DidChangeWorkspaceFoldersNotification,
WorkspaceFoldersRequest, ServerCapabilities
WorkspaceFoldersRequest, ServerCapabilities, WorkspaceFoldersClientCapabilities
} from 'vscode-languageserver-protocol';

import type { Feature, _RemoteWorkspace } from './server';
Expand All @@ -28,7 +28,7 @@ export const WorkspaceFoldersFeature: Feature<_RemoteWorkspace, WorkspaceFolders
public initialize(capabilities: ClientCapabilities): void {
super.initialize(capabilities);
const workspaceCapabilities = capabilities.workspace;
if (workspaceCapabilities && workspaceCapabilities.workspaceFolders) {
if (workspaceCapabilities && (workspaceCapabilities.workspaceFolders as WorkspaceFoldersClientCapabilities).changeNotifications) {
this._onDidChangeWorkspaceFolders = new Emitter<WorkspaceFoldersChangeEvent>();
this.connection.onNotification(DidChangeWorkspaceFoldersNotification.type, (params) => {
this._onDidChangeWorkspaceFolders!.fire(params.event);
Expand All @@ -53,4 +53,4 @@ export const WorkspaceFoldersFeature: Feature<_RemoteWorkspace, WorkspaceFolders
return this._onDidChangeWorkspaceFolders.event;
}
};
};
};