From 55b6438cfdd5f28a5aaa2813f2d3367fc10fc645 Mon Sep 17 00:00:00 2001 From: "N. Taylor Mullen" Date: Thu, 10 Jun 2021 21:35:33 -0700 Subject: [PATCH] Continue adding linkability to the protocol. - Linked down to OnTypeFormatting. --- _data/linkableTypes.yml | 98 +++++++++++++++++++++++- _specifications/specification-3-17.md | 104 +++++++++++++++++++++++--- 2 files changed, 191 insertions(+), 11 deletions(-) diff --git a/_data/linkableTypes.yml b/_data/linkableTypes.yml index 62632df..d08713b 100644 --- a/_data/linkableTypes.yml +++ b/_data/linkableTypes.yml @@ -224,6 +224,8 @@ link: '#workspaceSymbolRegistrationOptions' - type: 'WorkspaceSymbolParams' link: '#workspaceSymbolParams' + - type: 'workspace/executeCommand' + link: '#workspace_executeCommand' - type: 'ExecuteCommandClientCapabilities' link: '#executeCommandClientCapabilities' - type: 'ExecuteCommandOptions' @@ -467,4 +469,98 @@ - type: 'DocumentSymbol' link: '#documentSymbol' - type: 'SymbolInformation' - link: '#symbolInformation' \ No newline at end of file + link: '#symbolInformation' + - type: 'textDocument/codeAction' + link: '#textDocument_codeAction' + - type: 'CodeActionClientCapabilities' + link: '#codeActionClientCapabilities' + - type: 'CodeActionOptions' + link: '#codeActionOptions' + - type: 'CodeActionRegistrationOptions' + link: '#codeActionRegistrationOptions' + - type: 'CodeActionParams' + link: '#codeActionParams' + - type: 'CodeActionKind' + link: '#codeActionKind' + - type: 'CodeActionContext' + link: '#codeActionContext' + - type: 'CodeAction' + link: '#codeAction' + - type: 'codeAction/resolve' + link: '#codeAction_resolve' + - type: 'textDocument/codeLens' + link: '#textDocument_codeLens' + - type: 'CodeLensClientCapabilities' + link: '#codeLensClientCapabilities' + - type: 'CodeLensOptions' + link: '#codeLensOptions' + - type: 'CodeLensRegistrationOptions' + link: '#codeLensRegistrationOptions' + - type: 'CodeLensParams' + link: '#codeLensParams' + - type: 'CodeLens' + link: '#codeLens' + - type: 'codeLens/resolve' + link: '#codeLens_resolve' + - type: 'CodeLensWorkspaceClientCapabilities' + link: '#codeLensWorkspaceClientCapabilities' + - type: 'workspace/codeLens/refresh' + link: '#codeLens_refresh' + - type: 'DocumentLinkClientCapabilities' + link: '#documentLinkClientCapabilities' + - type: 'textDocument/documentLink' + link: '#textDocument_documentLink' + - type: 'DocumentLinkOptions' + link: '#documentLinkOptions' + - type: 'DocumentLinkRegistrationOptions' + link: '#documentLinkRegistrationOptions' + - type: 'DocumentLinkParams' + link: '#documentLinkParams' + - type: 'DocumentLink' + link: '#documentLink' + - type: 'documentLink/resolve' + link: '#documentLink_resolve' + - type: 'textDocument/documentColor' + link: '#textDocument_documentColor' + - type: 'DocumentColorClientCapabilities' + link: '#documentColorClientCapabilities' + - type: 'DocumentColorOptions' + link: '#documentColorOptions' + - type: 'DocumentColorRegistrationOptions' + link: '#documentColorRegistrationOptions' + - type: 'DocumentColorParams' + link: '#documentColorParams' + - type: 'ColorInformation' + link: '#colorInformation' + - type: 'Color' + link: '#color' + - type: 'textDocument/colorPresentation' + link: '#textDocument_colorPresentation' + - type: 'ColorPresentationParams' + link: '#colorPresentationParams' + - type: 'ColorPresentation' + link: '#colorPresentation' + - type: 'DocumentFormattingClientCapabilities' + link: '#documentFormattingClientCapabilities' + - type: 'textDocument/formatting' + link: '#textDocument_formatting' + - type: 'DocumentFormattingClientCapabilities' + link: '#documentFormattingClientCapabilities' + - type: 'DocumentFormattingOptions' + link: '#documentFormattingOptions' + - type: 'DocumentFormattingRegistrationOptions' + link: '#documentFormattingRegistrationOptions' + - type: 'DocumentFormattingParams' + link: '#documentFormattingParams' + - type: 'FormattingOptions' + link: '#formattingOptions' + - type: 'textDocument/rangeFormatting' + link: '#textDocument_rangeFormatting' + - type: 'DocumentRangeFormattingClientCapabilities' + link: '#documentRangeFormattingClientCapabilities' + - type: 'DocumentRangeFormattingOptions' + link: '#documentRangeFormattingOptions' + - type: 'DocumentRangeFormattingRegistrationOptions' + link: '#documentRangeFormattingRegistrationOptions' + - type: 'DocumentRangeFormattingParams' + link: '#documentRangeFormattingParams' \ No newline at end of file diff --git a/_specifications/specification-3-17.md b/_specifications/specification-3-17.md index 98ae2e8..584428e 100644 --- a/_specifications/specification-3-17.md +++ b/_specifications/specification-3-17.md @@ -6455,6 +6455,8 @@ _Client Capability_: * property name (optional): `textDocument.codeAction` * property type: `CodeActionClientCapabilities` defined as follows: +
+ ```typescript export interface CodeActionClientCapabilities { /** @@ -6539,6 +6541,8 @@ _Server Capability_: * property name (optional): `codeActionProvider` * property type: `boolean | CodeActionOptions` where `CodeActionOptions` is defined as follows: +
+ ```typescript export interface CodeActionOptions extends WorkDoneProgressOptions { /** @@ -6560,6 +6564,9 @@ export interface CodeActionOptions extends WorkDoneProgressOptions { ``` _Registration Options_: `CodeActionRegistrationOptions` defined as follows: + +
+ ```typescript export interface CodeActionRegistrationOptions extends TextDocumentRegistrationOptions, CodeActionOptions { @@ -6567,9 +6574,11 @@ export interface CodeActionRegistrationOptions extends ``` _Request_: -* method: 'textDocument/codeAction' +* method: `textDocument/codeAction` * params: `CodeActionParams` defined as follows: +
+ ```typescript /** * Params for the CodeActionRequest @@ -6591,7 +6600,11 @@ export interface CodeActionParams extends WorkDoneProgressParams, */ context: CodeActionContext; } +``` +
+ +```typescript /** * The kind of a code action. * @@ -6676,7 +6689,11 @@ export namespace CodeActionKind { export const SourceOrganizeImports: CodeActionKind = 'source.organizeImports'; } +``` +
+ +```typescript /** * Contains additional diagnostic information about the context in which * a code action is run. @@ -6705,6 +6722,8 @@ export interface CodeActionContext { _Response_: * result: `(Command | CodeAction)[]` \| `null` where `CodeAction` is defined as follows: +
+ ```typescript /** * A code action represents a change that can be performed in code, e.g. to fix @@ -6826,7 +6845,7 @@ _Client Capability_: * property type: `{ properties: string[]; }` _Request_: -* method: 'codeAction/resolve' +* method: `codeAction/resolve` * params: `CodeAction` _Response_: @@ -6841,6 +6860,8 @@ _Client Capability_: * property name (optional): `textDocument.codeLens` * property type: `CodeLensClientCapabilities` defined as follows: +
+ ```typescript export interface CodeLensClientCapabilities { /** @@ -6854,6 +6875,8 @@ _Server Capability_: * property name (optional): `codeLensProvider` * property type: `CodeLensOptions` defined as follows: +
+ ```typescript export interface CodeLensOptions extends WorkDoneProgressOptions { /** @@ -6864,6 +6887,9 @@ export interface CodeLensOptions extends WorkDoneProgressOptions { ``` _Registration Options_: `CodeLensRegistrationOptions` defined as follows: + +
+ ```typescript export interface CodeLensRegistrationOptions extends TextDocumentRegistrationOptions, CodeLensOptions { @@ -6871,9 +6897,11 @@ export interface CodeLensRegistrationOptions extends ``` _Request_: -* method: 'textDocument/codeLens' +* method: `textDocument/codeLens` * params: `CodeLensParams` defined as follows: +
+ ```typescript interface CodeLensParams extends WorkDoneProgressParams, PartialResultParams { /** @@ -6886,6 +6914,8 @@ interface CodeLensParams extends WorkDoneProgressParams, PartialResultParams { _Response_: * result: `CodeLens[]` \| `null` defined as follows: +
+ ```typescript /** * A code lens represents a command that should be shown along with @@ -6922,7 +6952,7 @@ interface CodeLens { The code lens resolve request is sent from the client to the server to resolve the command for a given code lens item. _Request_: -* method: 'codeLens/resolve' +* method: `codeLens/resolve` * params: `CodeLens` _Response_: @@ -6940,6 +6970,8 @@ _Client Capability_: * property name (optional): `workspace.codeLens` * property type: `CodeLensWorkspaceClientCapabilities` defined as follows: +
+ ```typescript export interface CodeLensWorkspaceClientCapabilities { /** @@ -6973,6 +7005,8 @@ _Client Capability_: * property name (optional): `textDocument.documentLink` * property type: `DocumentLinkClientCapabilities` defined as follows: +
+ ```typescript export interface DocumentLinkClientCapabilities { /** @@ -6993,6 +7027,8 @@ _Server Capability_: * property name (optional): `documentLinkProvider` * property type: `DocumentLinkOptions` defined as follows: +
+ ```typescript export interface DocumentLinkOptions extends WorkDoneProgressOptions { /** @@ -7003,6 +7039,9 @@ export interface DocumentLinkOptions extends WorkDoneProgressOptions { ``` _Registration Options_: `DocumentLinkRegistrationOptions` defined as follows: + +
+ ```typescript export interface DocumentLinkRegistrationOptions extends TextDocumentRegistrationOptions, DocumentLinkOptions { @@ -7010,9 +7049,11 @@ export interface DocumentLinkRegistrationOptions extends ``` _Request_: -* method: 'textDocument/documentLink' +* method: `textDocument/documentLink` * params: `DocumentLinkParams` defined as follows: +
+ ```typescript interface DocumentLinkParams extends WorkDoneProgressParams, PartialResultParams { @@ -7026,6 +7067,8 @@ interface DocumentLinkParams extends WorkDoneProgressParams, _Response_: * result: `DocumentLink[]` \| `null`. +
+ ```typescript /** * A document link is a range in a text document that links to an internal or @@ -7069,7 +7112,7 @@ interface DocumentLink { The document link resolve request is sent from the client to the server to resolve the target of a given document link. _Request_: -* method: 'documentLink/resolve' +* method: `documentLink/resolve` * params: `DocumentLink` _Response_: @@ -7090,6 +7133,8 @@ _Client Capability_: * property name (optional): `textDocument.colorProvider` * property type: `DocumentColorClientCapabilities` defined as follows: +
+ ```typescript export interface DocumentColorClientCapabilities { /** @@ -7103,12 +7148,17 @@ _Server Capability_: * property name (optional): `colorProvider` * property type: `boolean | DocumentColorOptions | DocumentColorRegistrationOptions` where `DocumentColorOptions` is defined as follows: +
+ ```typescript export interface DocumentColorOptions extends WorkDoneProgressOptions { } ``` _Registration Options_: `DocumentColorRegistrationOptions` defined as follows: + +
+ ```typescript export interface DocumentColorRegistrationOptions extends TextDocumentRegistrationOptions, StaticRegistrationOptions, @@ -7118,9 +7168,11 @@ export interface DocumentColorRegistrationOptions extends _Request_: -* method: 'textDocument/documentColor' +* method: `textDocument/documentColor` * params: `DocumentColorParams` defined as follows +
+ ```typescript interface DocumentColorParams extends WorkDoneProgressParams, PartialResultParams { @@ -7134,6 +7186,8 @@ interface DocumentColorParams extends WorkDoneProgressParams, _Response_: * result: `ColorInformation[]` defined as follows: +
+ ```typescript interface ColorInformation { /** @@ -7146,7 +7200,11 @@ interface ColorInformation { */ color: Color; } +``` +
+ +```typescript /** * Represents a color in RGBA space. */ @@ -7188,9 +7246,11 @@ This request has no special capabilities and registration options since it is se _Request_: -* method: 'textDocument/colorPresentation' +* method: `textDocument/colorPresentation` * params: `ColorPresentationParams` defined as follows +
+ ```typescript interface ColorPresentationParams extends WorkDoneProgressParams, PartialResultParams { @@ -7214,6 +7274,8 @@ interface ColorPresentationParams extends WorkDoneProgressParams, _Response_: * result: `ColorPresentation[]` defined as follows: +
+ ```typescript interface ColorPresentation { /** @@ -7248,6 +7310,8 @@ _Client Capability_: * property name (optional): `textDocument.formatting` * property type: `DocumentFormattingClientCapabilities` defined as follows: +
+ ```typescript export interface DocumentFormattingClientCapabilities { /** @@ -7261,12 +7325,17 @@ _Server Capability_: * property name (optional): `documentFormattingProvider` * property type: `boolean | DocumentFormattingOptions` where `DocumentFormattingOptions` is defined as follows: +
+ ```typescript export interface DocumentFormattingOptions extends WorkDoneProgressOptions { } ``` _Registration Options_: `DocumentFormattingRegistrationOptions` defined as follows: + +
+ ```typescript export interface DocumentFormattingRegistrationOptions extends TextDocumentRegistrationOptions, DocumentFormattingOptions { @@ -7274,9 +7343,11 @@ export interface DocumentFormattingRegistrationOptions extends ``` _Request_: -* method: 'textDocument/formatting' +* method: `textDocument/formatting` * params: `DocumentFormattingParams` defined as follows +
+ ```typescript interface DocumentFormattingParams extends WorkDoneProgressParams { /** @@ -7289,7 +7360,11 @@ interface DocumentFormattingParams extends WorkDoneProgressParams { */ options: FormattingOptions; } +``` +
+ +```typescript /** * Value-object describing what options formatting should use. */ @@ -7344,6 +7419,8 @@ _Client Capability_: * property name (optional): `textDocument.rangeFormatting` * property type: `DocumentRangeFormattingClientCapabilities` defined as follows: +
+ ```typescript export interface DocumentRangeFormattingClientCapabilities { /** @@ -7357,6 +7434,8 @@ _Server Capability_: * property name (optional): `documentRangeFormattingProvider` * property type: `boolean | DocumentRangeFormattingOptions` where `DocumentRangeFormattingOptions` is defined as follows: +
+ ```typescript export interface DocumentRangeFormattingOptions extends WorkDoneProgressOptions { @@ -7364,6 +7443,9 @@ export interface DocumentRangeFormattingOptions extends ``` _Registration Options_: `DocumentFormattingRegistrationOptions` defined as follows: + +
+ ```typescript export interface DocumentRangeFormattingRegistrationOptions extends TextDocumentRegistrationOptions, DocumentRangeFormattingOptions { @@ -7371,9 +7453,11 @@ export interface DocumentRangeFormattingRegistrationOptions extends ``` _Request_: -* method: 'textDocument/rangeFormatting', +* method: `textDocument/rangeFormatting`, * params: `DocumentRangeFormattingParams` defined as follows: +
+ ```typescript interface DocumentRangeFormattingParams extends WorkDoneProgressParams { /**