Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Add capability information to the metamodel #1591

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
dbaeumer merged 2 commits into from
Feb 5, 2025
Merged

Add capability information to the metamodel #1591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c0bc9b
Add capability information to the metamodel
MariaSolOs Nov 30, 2024
82f55fd
Merge branch 'main' into capabilities
dbaeumer Feb 5, 2025
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
126 changes: 126 additions & 0 deletions 126 protocol/metaModel.json
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions 16 protocol/metaModel.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,10 @@
"additionalProperties": false,
"description": "Represents a LSP notification",
"properties": {
"clientCapability": {
"description": "The client capability property path if any.",
"type": "string"
},
"deprecated": {
"description": "Whether the notification is deprecated or not. If deprecated the property contains the deprecation message.",
"type": "string"
Expand Down Expand Up @@ -404,6 +408,10 @@
"$ref": "#/definitions/Type",
"description": "Optional registration options if the notification supports dynamic registration."
},
"serverCapability": {
"description": "The server capability property path if any.",
"type": "string"
},
"since": {
"description": "Since when (release number) this notification is available. Is undefined if not known.",
"type": "string"
Expand Down Expand Up @@ -515,6 +523,10 @@
"additionalProperties": false,
"description": "Represents a LSP request",
"properties": {
"clientCapability": {
"description": "The client capability property path if any.",
"type": "string"
},
"deprecated": {
"description": "Whether the request is deprecated or not. If deprecated the property contains the deprecation message.",
"type": "string"
Expand Down Expand Up @@ -569,6 +581,10 @@
"$ref": "#/definitions/Type",
"description": "The result type."
},
"serverCapability": {
"description": "The server capability property path if any.",
"type": "string"
},
"since": {
"description": "Since when (release number) this request is available. Is undefined if not known.",
"type": "string"
Expand Down
8 changes: 5 additions & 3 deletions 8 protocol/src/common/protocol.callHierarchy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ import { RequestHandler } from 'vscode-jsonrpc';
import { CallHierarchyItem, CallHierarchyIncomingCall, CallHierarchyOutgoingCall } from 'vscode-languageserver-types';

import { MessageDirection, ProtocolRequestType } from './messages';
import type {
TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams,
WorkDoneProgressParams, WorkDoneProgressOptions
import {
type TextDocumentRegistrationOptions, type StaticRegistrationOptions, type TextDocumentPositionParams, type PartialResultParams,
type WorkDoneProgressParams, type WorkDoneProgressOptions,
CM
} from './protocol';

/**
Expand Down Expand Up @@ -59,6 +60,7 @@ export namespace CallHierarchyPrepareRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<CallHierarchyPrepareParams, CallHierarchyItem[] | null, never, void, CallHierarchyRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<CallHierarchyPrepareParams, CallHierarchyItem[] | null, void>;
export const capabilities = CM.create('textDocument.callHierarchy', 'callHierarchyProvider');
}

/**
Expand Down
6 changes: 4 additions & 2 deletions 6 protocol/src/common/protocol.colorProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ import { RequestHandler } from 'vscode-jsonrpc';
import { TextDocumentIdentifier, Range, Color, ColorInformation, ColorPresentation } from 'vscode-languageserver-types';

import { MessageDirection, ProtocolRequestType } from './messages';
import type {
TextDocumentRegistrationOptions, StaticRegistrationOptions, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions
import {
type TextDocumentRegistrationOptions, type StaticRegistrationOptions, type PartialResultParams, type WorkDoneProgressParams, type WorkDoneProgressOptions,
CM
} from './protocol';

//---- Client capability ----
Expand Down Expand Up @@ -51,6 +52,7 @@ export namespace DocumentColorRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<DocumentColorParams, ColorInformation[], ColorInformation[], void, DocumentColorRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<DocumentColorParams, ColorInformation[], void>;
export const capabilities = CM.create('textDocument.colorProvider', 'colorProvider');
}

/**
Expand Down
2 changes: 2 additions & 0 deletions 2 protocol/src/common/protocol.configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { RequestHandler, HandlerResult, CancellationToken } from 'vscode-jsonrpc
import { LSPAny, URI } from 'vscode-languageserver-types';

import { MessageDirection, ProtocolRequestType } from './messages';
import { CM } from './protocol';

//---- Get Configuration request ----

Expand All @@ -25,6 +26,7 @@ export namespace ConfigurationRequest {
export const type = new ProtocolRequestType<ConfigurationParams, LSPAny[], never, void, void>(method);
export type HandlerSignature = RequestHandler<ConfigurationParams, LSPAny[], void>;
export type MiddlewareSignature = (params: ConfigurationParams, token: CancellationToken, next: HandlerSignature) => HandlerResult<LSPAny[], void>;
export const capabilities = CM.create('workspace.configuration', undefined);
}


Expand Down
8 changes: 5 additions & 3 deletions 8 protocol/src/common/protocol.declaration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ import { RequestHandler } from 'vscode-jsonrpc';
import { Declaration, DeclarationLink, Location, LocationLink } from 'vscode-languageserver-types';

import { MessageDirection, ProtocolRequestType } from './messages';
import type {
TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams,
WorkDoneProgressOptions
import {
type TextDocumentRegistrationOptions, type StaticRegistrationOptions, type TextDocumentPositionParams, type PartialResultParams, type WorkDoneProgressParams,
type WorkDoneProgressOptions,
CM
} from './protocol';

// @ts-ignore: to avoid inlining LocationLink as dynamic import
Expand Down Expand Up @@ -52,4 +53,5 @@ export namespace DeclarationRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<DeclarationParams, Declaration | DeclarationLink[] | null, Location[] | DeclarationLink[], void, DeclarationRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<DeclarationParams, Declaration | DeclarationLink[] | null, void>;
export const capabilities = CM.create('textDocument.declaration', 'declarationProvider');
}
11 changes: 7 additions & 4 deletions 11 protocol/src/common/protocol.diagnostic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ import { TextDocumentIdentifier, Diagnostic, DocumentUri, integer } from 'vscode

import * as Is from './utils/is';
import { MessageDirection, ProtocolRequestType0, ProtocolRequestType } from './messages';
import type {
PartialResultParams, StaticRegistrationOptions, WorkDoneProgressParams, TextDocumentRegistrationOptions, WorkDoneProgressOptions,
DiagnosticsCapabilities
import {
type PartialResultParams, type StaticRegistrationOptions, type WorkDoneProgressParams, type TextDocumentRegistrationOptions, type WorkDoneProgressOptions,
type DiagnosticsCapabilities,
CM
} from './protocol';


/**
* Client capabilities specific to diagnostic pull requests.
*
Expand Down Expand Up @@ -269,6 +269,7 @@ export namespace DocumentDiagnosticRequest {
export const type = new ProtocolRequestType<DocumentDiagnosticParams, DocumentDiagnosticReport, DocumentDiagnosticReportPartialResult, DiagnosticServerCancellationData, DiagnosticRegistrationOptions>(method);
export const partialResult = new ProgressType<DocumentDiagnosticReportPartialResult>();
export type HandlerSignature = RequestHandler<DocumentDiagnosticParams, DocumentDiagnosticReport, void>;
export const capabilities = CM.create('textDocument.diagnostic', 'diagnosticProvider');
}

/**
Expand Down Expand Up @@ -382,6 +383,7 @@ export namespace WorkspaceDiagnosticRequest {
export const type = new ProtocolRequestType<WorkspaceDiagnosticParams, WorkspaceDiagnosticReport, WorkspaceDiagnosticReportPartialResult, DiagnosticServerCancellationData, void>(method);
export const partialResult = new ProgressType<WorkspaceDiagnosticReportPartialResult>();
export type HandlerSignature = RequestHandler<WorkspaceDiagnosticParams, WorkspaceDiagnosticReport | null, void>;
export const capabilities = CM.create('workspace.diagnostics', 'diagnosticProvider.workspaceDiagnostics');
}

/**
Expand All @@ -394,4 +396,5 @@ export namespace DiagnosticRefreshRequest {
export const messageDirection: MessageDirection = MessageDirection.serverToClient;
export const type = new ProtocolRequestType0<void, void, void, void>(method);
export type HandlerSignature = RequestHandler0<void, void>;
export const capabilities = CM.create('workspace.diagnostics.refreshSupport', undefined);
}
7 changes: 7 additions & 0 deletions 7 protocol/src/common/protocol.fileOperations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import { NotificationHandler, RequestHandler } from 'vscode-jsonrpc';
import { WorkspaceEdit } from 'vscode-languageserver-types';
import { MessageDirection, ProtocolNotificationType, ProtocolRequestType } from './messages';
import { CM } from './protocol';

/**
* Options for notifications/requests for user operations on files.
Expand Down Expand Up @@ -292,6 +293,7 @@ export namespace WillCreateFilesRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<CreateFilesParams, WorkspaceEdit | null, never, void, FileOperationRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<CreateFilesParams, WorkspaceEdit | undefined | null, void>;
export const capabilities = CM.create('workspace.fileOperations.willCreate', 'workspace.fileOperations.willCreate');
}

/**
Expand All @@ -305,6 +307,7 @@ export namespace DidCreateFilesNotification {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolNotificationType<CreateFilesParams, FileOperationRegistrationOptions>(method);
export type HandlerSignature = NotificationHandler<CreateFilesParams>;
export const capabilities = CM.create('workspace.fileOperations.didCreate', 'workspace.fileOperations.didCreate');
}

/**
Expand All @@ -318,6 +321,7 @@ export namespace WillRenameFilesRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<RenameFilesParams, WorkspaceEdit | null, never, void, FileOperationRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<RenameFilesParams, WorkspaceEdit | undefined | null, void>;
export const capabilities = CM.create('workspace.fileOperations.willRename', 'workspace.fileOperations.willRename');
}

/**
Expand All @@ -331,6 +335,7 @@ export namespace DidRenameFilesNotification {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolNotificationType<RenameFilesParams, FileOperationRegistrationOptions>(method);
export type HandlerSignature = NotificationHandler<RenameFilesParams>;
export const capabilities = CM.create('workspace.fileOperations.didRename', 'workspace.fileOperations.didRename');
}

/**
Expand All @@ -344,6 +349,7 @@ export namespace DidDeleteFilesNotification {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolNotificationType<DeleteFilesParams, FileOperationRegistrationOptions>(method);
export type HandlerSignature = NotificationHandler<DeleteFilesParams>;
export const capabilities = CM.create('workspace.fileOperations.didDelete', 'workspace.fileOperations.didDelete');
}

/**
Expand All @@ -357,4 +363,5 @@ export namespace WillDeleteFilesRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<DeleteFilesParams, WorkspaceEdit | null, never, void, FileOperationRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<DeleteFilesParams, WorkspaceEdit | undefined | null, void>;
export const capabilities = CM.create('workspace.fileOperations.willDelete', 'workspace.fileOperations.willDelete');
}
7 changes: 5 additions & 2 deletions 7 protocol/src/common/protocol.foldingRange.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ import { RequestHandler, RequestHandler0 } from 'vscode-jsonrpc';
import { TextDocumentIdentifier, uinteger, FoldingRange, FoldingRangeKind } from 'vscode-languageserver-types';

import { MessageDirection, ProtocolRequestType, ProtocolRequestType0 } from './messages';
import type {
TextDocumentRegistrationOptions, StaticRegistrationOptions, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions
import {
type TextDocumentRegistrationOptions, type StaticRegistrationOptions, type PartialResultParams, type WorkDoneProgressParams, type WorkDoneProgressOptions,
CM
} from './protocol';

// ---- capabilities
Expand Down Expand Up @@ -128,6 +129,7 @@ export namespace FoldingRangeRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<FoldingRangeParams, FoldingRange[] | null, FoldingRange[], void, FoldingRangeRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<FoldingRangeParams, FoldingRange[] | null, void>;
export const capabilities = CM.create('textDocument.foldingRange', 'foldingRangeProvider');
}

/**
Expand All @@ -139,4 +141,5 @@ export namespace FoldingRangeRefreshRequest {
export const messageDirection: MessageDirection = MessageDirection.serverToClient;
export const type = new ProtocolRequestType0<void, void, void, void>(method);
export type HandlerSignature = RequestHandler0<void, void>;
export const capabilities = CM.create('workspace.foldingRange.refreshSupport', undefined);
}
8 changes: 5 additions & 3 deletions 8 protocol/src/common/protocol.implementation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ import { RequestHandler } from 'vscode-jsonrpc';
import { Definition, DefinitionLink, Location, LocationLink } from 'vscode-languageserver-types';

import { MessageDirection, ProtocolRequestType } from './messages';
import type {
TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams,
WorkDoneProgressOptions
import {
type TextDocumentRegistrationOptions, type StaticRegistrationOptions, type TextDocumentPositionParams, type PartialResultParams, type WorkDoneProgressParams,
type WorkDoneProgressOptions,
CM
} from './protocol';

// @ts-ignore: to avoid inlining LocationLink as dynamic import
Expand Down Expand Up @@ -53,4 +54,5 @@ export namespace ImplementationRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<ImplementationParams, Definition | DefinitionLink[] | null, Location[] | DefinitionLink[], void, ImplementationRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<ImplementationParams, Definition | DefinitionLink[] | null, void>;
export const capabilities = CM.create('textDocument.implementation', 'implementationProvider');
}
5 changes: 4 additions & 1 deletion 5 protocol/src/common/protocol.inlayHint.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { RequestHandler, RequestHandler0 } from 'vscode-jsonrpc';
import { Range, TextDocumentIdentifier, InlayHint } from 'vscode-languageserver-types';
import { MessageDirection, ProtocolRequestType, ProtocolRequestType0 } from './messages';

import type { StaticRegistrationOptions, TextDocumentRegistrationOptions, WorkDoneProgressOptions, WorkDoneProgressParams } from './protocol';
import { CM, type StaticRegistrationOptions, type TextDocumentRegistrationOptions, type WorkDoneProgressOptions, type WorkDoneProgressParams } from './protocol';

/**
* @since 3.18.0
Expand Down Expand Up @@ -105,6 +105,7 @@ export namespace InlayHintRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<InlayHintParams, InlayHint[] | null, InlayHint[], void, InlayHintRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<InlayHintParams, InlayHint[] | null, void>;
export const capabilities = CM.create('textDocument.inlayHint', 'inlayHintProvider');
}

/**
Expand All @@ -119,6 +120,7 @@ export namespace InlayHintResolveRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<InlayHint, InlayHint, never, void, void>(method);
export type HandlerSignature = RequestHandler<InlayHint, InlayHint, void>;
export const capabilities = CM.create('textDocument.inlayHint.resolveSupport', 'inlayHintProvider.resolveProvider');
}

/**
Expand All @@ -129,4 +131,5 @@ export namespace InlayHintRefreshRequest {
export const messageDirection: MessageDirection = MessageDirection.serverToClient;
export const type = new ProtocolRequestType0<void, void, void, void>(method);
export type HandlerSignature = RequestHandler0<void, void>;
export const capabilities = CM.create('workspace.inlayHint.refreshSupport', undefined);
}
3 changes: 2 additions & 1 deletion 3 protocol/src/common/protocol.inlineCompletion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { InlineCompletionItem, InlineCompletionContext, InlineCompletionList } f
import { RequestHandler } from 'vscode-jsonrpc';

import { MessageDirection, ProtocolRequestType } from './messages';
import type { TextDocumentRegistrationOptions, WorkDoneProgressOptions, StaticRegistrationOptions, WorkDoneProgressParams, TextDocumentPositionParams } from './protocol';
import { type TextDocumentRegistrationOptions, type WorkDoneProgressOptions, type StaticRegistrationOptions, type WorkDoneProgressParams, type TextDocumentPositionParams, CM } from './protocol';

// ---- capabilities

Expand Down Expand Up @@ -67,4 +67,5 @@ export namespace InlineCompletionRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<InlineCompletionParams, InlineCompletionList | InlineCompletionItem[] | null, InlineCompletionItem[], void, InlineCompletionRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<InlineCompletionParams, InlineCompletionList | InlineCompletionItem[] | null, void>;
export const capabilities = CM.create('textDocument.inlineCompletion', 'inlineCompletionProvider');
}
4 changes: 3 additions & 1 deletion 4 protocol/src/common/protocol.inlineValue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { TextDocumentIdentifier, Range, InlineValue, InlineValueContext } from '
import { RequestHandler, RequestHandler0 } from 'vscode-jsonrpc';

import { MessageDirection, ProtocolRequestType, ProtocolRequestType0 } from './messages';
import type { TextDocumentRegistrationOptions, WorkDoneProgressOptions, StaticRegistrationOptions, WorkDoneProgressParams } from './protocol';
import { type TextDocumentRegistrationOptions, type WorkDoneProgressOptions, type StaticRegistrationOptions, type WorkDoneProgressParams, CM } from './protocol';

// ---- capabilities

Expand Down Expand Up @@ -90,6 +90,7 @@ export namespace InlineValueRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<InlineValueParams, InlineValue[] | null, InlineValue[], void, InlineValueRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<InlineValueParams, InlineValue[] | null, void>;
export const capabilities = CM.create('textDocument.inlineValue', 'inlineValueProvider');
}

/**
Expand All @@ -100,4 +101,5 @@ export namespace InlineValueRefreshRequest {
export const messageDirection: MessageDirection = MessageDirection.serverToClient;
export const type = new ProtocolRequestType0<void, void, void, void>(method);
export type HandlerSignature = RequestHandler0<void, void>;
export const capabilities = CM.create('workspace.inlineValue.refreshSupport', undefined);
}
8 changes: 5 additions & 3 deletions 8 protocol/src/common/protocol.linkedEditingRange.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ import { RequestHandler } from 'vscode-jsonrpc';
import { Range } from 'vscode-languageserver-types';

import { MessageDirection, ProtocolRequestType } from './messages';
import type {
StaticRegistrationOptions, TextDocumentPositionParams, TextDocumentRegistrationOptions, WorkDoneProgressOptions,
WorkDoneProgressParams
import {
type StaticRegistrationOptions, type TextDocumentPositionParams, type TextDocumentRegistrationOptions, type WorkDoneProgressOptions,
type WorkDoneProgressParams,
CM
} from './protocol';

/**
Expand Down Expand Up @@ -65,4 +66,5 @@ export namespace LinkedEditingRangeRequest {
export const messageDirection: MessageDirection = MessageDirection.clientToServer;
export const type = new ProtocolRequestType<LinkedEditingRangeParams, LinkedEditingRanges | null, void, void, LinkedEditingRangeRegistrationOptions>(method);
export type HandlerSignature = RequestHandler<LinkedEditingRangeParams, LinkedEditingRanges | null, void>;
export const capabilities = CM.create('textDocument.linkedEditingRange', 'linkedEditingRangeProvider');
}
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.