75 lines
2.8 KiB
TypeScript
75 lines
2.8 KiB
TypeScript
|
import { WorkspaceFolder } from 'vscode-languageserver-types';
|
||
|
|
import { RequestHandler0, NotificationHandler, HandlerResult, CancellationToken } from 'vscode-jsonrpc';
|
||
|
|
import { MessageDirection, ProtocolRequestType0, ProtocolNotificationType } from './messages';
|
||
|
|
export interface WorkspaceFoldersInitializeParams {
|
||
|
|
/**
|
||
|
|
* The workspace folders configured in the client when the server starts.
|
||
|
|
*
|
||
|
|
* This property is only available if the client supports workspace folders.
|
||
|
|
* It can be `null` if the client supports workspace folders but none are
|
||
|
|
* configured.
|
||
|
|
*
|
||
|
|
* @since 3.6.0
|
||
|
|
*/
|
||
|
|
workspaceFolders?: WorkspaceFolder[] | null;
|
||
|
|
}
|
||
|
|
export interface WorkspaceFoldersServerCapabilities {
|
||
|
|
/**
|
||
|
|
* The server has support for workspace folders
|
||
|
|
*/
|
||
|
|
supported?: boolean;
|
||
|
|
/**
|
||
|
|
* Whether the server wants to receive workspace folder
|
||
|
|
* change notifications.
|
||
|
|
*
|
||
|
|
* If a string is provided the string is treated as an ID
|
||
|
|
* under which the notification is registered on the client
|
||
|
|
* side. The ID can be used to unregister for these events
|
||
|
|
* using the `client/unregisterCapability` request.
|
||
|
|
*/
|
||
|
|
changeNotifications?: string | boolean;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
|
||
|
|
*/
|
||
|
|
export declare namespace WorkspaceFoldersRequest {
|
||
|
|
const method: 'workspace/workspaceFolders';
|
||
|
|
const messageDirection: MessageDirection;
|
||
|
|
const type: ProtocolRequestType0<WorkspaceFolder[] | null, never, void, void>;
|
||
|
|
type HandlerSignature = RequestHandler0<WorkspaceFolder[] | null, void>;
|
||
|
|
type MiddlewareSignature = (token: CancellationToken, next: HandlerSignature) => HandlerResult<WorkspaceFolder[] | null, void>;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The `workspace/didChangeWorkspaceFolders` notification is sent from the client to the server when the workspace
|
||
|
|
* folder configuration changes.
|
||
|
|
*/
|
||
|
|
export declare namespace DidChangeWorkspaceFoldersNotification {
|
||
|
|
const method: 'workspace/didChangeWorkspaceFolders';
|
||
|
|
const messageDirection: MessageDirection;
|
||
|
|
const type: ProtocolNotificationType<DidChangeWorkspaceFoldersParams, void>;
|
||
|
|
type HandlerSignature = NotificationHandler<DidChangeWorkspaceFoldersParams>;
|
||
|
|
type MiddlewareSignature = (params: DidChangeWorkspaceFoldersParams, next: HandlerSignature) => void;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The parameters of a `workspace/didChangeWorkspaceFolders` notification.
|
||
|
|
*/
|
||
|
|
export interface DidChangeWorkspaceFoldersParams {
|
||
|
|
/**
|
||
|
|
* The actual workspace folder change event.
|
||
|
|
*/
|
||
|
|
event: WorkspaceFoldersChangeEvent;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The workspace folder change event.
|
||
|
|
*/
|
||
|
|
export interface WorkspaceFoldersChangeEvent {
|
||
|
|
/**
|
||
|
|
* The array of added workspace folders
|
||
|
|
*/
|
||
|
|
added: WorkspaceFolder[];
|
||
|
|
/**
|
||
|
|
* The array of the removed workspace folders
|
||
|
|
*/
|
||
|
|
removed: WorkspaceFolder[];
|
||
|
|
}
|