From ea2389332c42f3e42200e14104c6d971eaf12bf5 Mon Sep 17 00:00:00 2001 From: Alex Carney Date: Wed, 18 Oct 2023 22:11:40 +0100 Subject: [PATCH] docs: Add client capability index --- docs/capabilities/text-document.rst | 8 +++ .../text-document/code-action.rst | 29 ++++++++++ docs/capabilities/text-document/code-lens.rst | 9 +++ .../capabilities/text-document/completion.rst | 40 +++++++++++++ .../text-document/declaration.rst | 14 +++++ .../capabilities/text-document/definition.rst | 14 +++++ .../capabilities/text-document/diagnostic.rst | 14 +++++ .../text-document/document-color.rst | 9 +++ .../text-document/document-highlight.rst | 9 +++ .../text-document/document-link.rst | 14 +++++ .../text-document/document-symbols.rst | 19 +++++++ .../text-document/folding-range.rst | 14 +++++ .../capabilities/text-document/formatting.rst | 9 +++ docs/capabilities/text-document/hover.rst | 9 +++ .../text-document/implementation.rst | 14 +++++ .../capabilities/text-document/inlay-hint.rst | 9 +++ .../text-document/inline-value.rst | 9 +++ .../text-document/linked-editing-range.rst | 9 +++ docs/capabilities/text-document/moniker.rst | 9 +++ .../text-document/on-type-formatting.rst | 9 +++ .../text-document/preapare-call-hierachy.rst | 9 +++ .../text-document/preapare-type-hierachy.rst | 9 +++ .../text-document/publish-diagnostics.rst | 24 ++++++++ .../text-document/range-formatting.rst | 9 +++ .../capabilities/text-document/references.rst | 9 +++ docs/capabilities/text-document/rename.rst | 19 +++++++ .../text-document/selection-range.rst | 9 +++ .../text-document/semantic-tokens.rst | 45 +++++++++++++++ .../text-document/signature-help.rst | 24 ++++++++ .../text-document/type-definition.rst | 14 +++++ docs/capabilities/window.rst | 8 +++ docs/capabilities/window/progress.rst | 4 ++ docs/capabilities/window/show-document.rst | 6 ++ docs/capabilities/window/show-message.rst | 9 +++ docs/capabilities/workspace.rst | 8 +++ docs/capabilities/workspace/apply-edit.rst | 6 ++ .../workspace/code-lens-refresh.rst | 9 +++ docs/capabilities/workspace/configuration.rst | 16 ++++++ .../capabilities/workspace/executeCommand.rst | 6 ++ .../workspace/file-operations.rst | 56 +++++++++++++++++++ .../workspace/inlay-hint-refresh.rst | 9 +++ .../workspace/inline-value-refresh.rst | 9 +++ docs/capabilities/workspace/symbol.rst | 9 +++ .../workspace/workspace-folders.rst | 6 ++ docs/index.rst | 55 +++++++++++++++++- 45 files changed, 655 insertions(+), 2 deletions(-) create mode 100644 docs/capabilities/text-document.rst create mode 100644 docs/capabilities/text-document/code-action.rst create mode 100644 docs/capabilities/text-document/code-lens.rst create mode 100644 docs/capabilities/text-document/completion.rst create mode 100644 docs/capabilities/text-document/declaration.rst create mode 100644 docs/capabilities/text-document/definition.rst create mode 100644 docs/capabilities/text-document/diagnostic.rst create mode 100644 docs/capabilities/text-document/document-color.rst create mode 100644 docs/capabilities/text-document/document-highlight.rst create mode 100644 docs/capabilities/text-document/document-link.rst create mode 100644 docs/capabilities/text-document/document-symbols.rst create mode 100644 docs/capabilities/text-document/folding-range.rst create mode 100644 docs/capabilities/text-document/formatting.rst create mode 100644 docs/capabilities/text-document/hover.rst create mode 100644 docs/capabilities/text-document/implementation.rst create mode 100644 docs/capabilities/text-document/inlay-hint.rst create mode 100644 docs/capabilities/text-document/inline-value.rst create mode 100644 docs/capabilities/text-document/linked-editing-range.rst create mode 100644 docs/capabilities/text-document/moniker.rst create mode 100644 docs/capabilities/text-document/on-type-formatting.rst create mode 100644 docs/capabilities/text-document/preapare-call-hierachy.rst create mode 100644 docs/capabilities/text-document/preapare-type-hierachy.rst create mode 100644 docs/capabilities/text-document/publish-diagnostics.rst create mode 100644 docs/capabilities/text-document/range-formatting.rst create mode 100644 docs/capabilities/text-document/references.rst create mode 100644 docs/capabilities/text-document/rename.rst create mode 100644 docs/capabilities/text-document/selection-range.rst create mode 100644 docs/capabilities/text-document/semantic-tokens.rst create mode 100644 docs/capabilities/text-document/signature-help.rst create mode 100644 docs/capabilities/text-document/type-definition.rst create mode 100644 docs/capabilities/window.rst create mode 100644 docs/capabilities/window/progress.rst create mode 100644 docs/capabilities/window/show-document.rst create mode 100644 docs/capabilities/window/show-message.rst create mode 100644 docs/capabilities/workspace.rst create mode 100644 docs/capabilities/workspace/apply-edit.rst create mode 100644 docs/capabilities/workspace/code-lens-refresh.rst create mode 100644 docs/capabilities/workspace/configuration.rst create mode 100644 docs/capabilities/workspace/executeCommand.rst create mode 100644 docs/capabilities/workspace/file-operations.rst create mode 100644 docs/capabilities/workspace/inlay-hint-refresh.rst create mode 100644 docs/capabilities/workspace/inline-value-refresh.rst create mode 100644 docs/capabilities/workspace/symbol.rst create mode 100644 docs/capabilities/workspace/workspace-folders.rst diff --git a/docs/capabilities/text-document.rst b/docs/capabilities/text-document.rst new file mode 100644 index 0000000..2c9beb9 --- /dev/null +++ b/docs/capabilities/text-document.rst @@ -0,0 +1,8 @@ +Text Document +============= + +.. toctree:: + :maxdepth: 1 + :glob: + + text-document/* diff --git a/docs/capabilities/text-document/code-action.rst b/docs/capabilities/text-document/code-action.rst new file mode 100644 index 0000000..7e0d351 --- /dev/null +++ b/docs/capabilities/text-document/code-action.rst @@ -0,0 +1,29 @@ +``textDocument/codeAction`` +=========================== + +Capabilities relating to the :lsp:`textDocument/codeAction` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.code_action.dynamic_registration + +Honors Change Annotations +------------------------- + +.. capabilities:bool-table:: text_document.code_action.honors_change_annotations + +``CodeAction.isPreferred`` +-------------------------- + +.. capabilities:bool-table:: text_document.code_action.is_preferred_support + +``CodeAction.disabled`` +----------------------- + +.. capabilities:bool-table:: text_document.code_action.disabled_support + +``CodeAction.data`` +------------------- + +.. capabilities:bool-table:: text_document.code_action.data_support diff --git a/docs/capabilities/text-document/code-lens.rst b/docs/capabilities/text-document/code-lens.rst new file mode 100644 index 0000000..4371683 --- /dev/null +++ b/docs/capabilities/text-document/code-lens.rst @@ -0,0 +1,9 @@ +``textDocument/codeLens`` +========================= + +Capabilities relating to the :lsp:`textDocument/codeLens` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.code_lens.dynamic_registration diff --git a/docs/capabilities/text-document/completion.rst b/docs/capabilities/text-document/completion.rst new file mode 100644 index 0000000..c93d599 --- /dev/null +++ b/docs/capabilities/text-document/completion.rst @@ -0,0 +1,40 @@ +``textDocument/completion`` +=========================== + +Dynamic Registration +-------------------- + +Capabilities relating to the :lsp:`textDocument/completion` request. + +.. capabilities:bool-table:: text_document.completion.dynamic_registration + + +``CompletionItem.commitCharactersSupport`` +------------------------------------------ + +.. capabilities:bool-table:: text_document.completion.completion_item.commit_characters_support + +``CompletionItem.deprecatedSupport`` +------------------------------------ + +.. capabilities:bool-table:: text_document.completion.completion_item.deprecated_support + +``CompletionItem.insertReplaceSupport`` +--------------------------------------- + +.. capabilities:bool-table:: text_document.completion.completion_item.insert_replace_support + +``CompletionItem.labelDetailsSupport`` +-------------------------------------- + +.. capabilities:bool-table:: text_document.completion.completion_item.label_details_support + +``CompletionItem.preselectSupport`` +----------------------------------- + +.. capabilities:bool-table:: text_document.completion.completion_item.preselect_support + +``CompletionItem.snippetSupport`` +--------------------------------- + +.. capabilities:bool-table:: text_document.completion.completion_item.snippet_support diff --git a/docs/capabilities/text-document/declaration.rst b/docs/capabilities/text-document/declaration.rst new file mode 100644 index 0000000..a13f91b --- /dev/null +++ b/docs/capabilities/text-document/declaration.rst @@ -0,0 +1,14 @@ +``textDocument/declaration`` +============================ + +Capabilities relating to the :lsp:`textDocument/declaration` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.declaration.dynamic_registration + +Link Support +------------ + +.. capabilities:bool-table:: text_document.declaration.link_support diff --git a/docs/capabilities/text-document/definition.rst b/docs/capabilities/text-document/definition.rst new file mode 100644 index 0000000..5948986 --- /dev/null +++ b/docs/capabilities/text-document/definition.rst @@ -0,0 +1,14 @@ +``textDocument/definition`` +============================ + +Capabilities relating to the :lsp:`textDocument/definition` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.definition.dynamic_registration + +Link Support +------------ + +.. capabilities:bool-table:: text_document.definition.link_support diff --git a/docs/capabilities/text-document/diagnostic.rst b/docs/capabilities/text-document/diagnostic.rst new file mode 100644 index 0000000..8759012 --- /dev/null +++ b/docs/capabilities/text-document/diagnostic.rst @@ -0,0 +1,14 @@ +``textDocument/diagnostic`` +=========================== + +Capabilities relating to the :lsp:`textDocument/diagnostic` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.diagnostic.dynamic_registration + +Related Document Support +------------------------ + +.. capabilities:bool-table:: text_document.diagnostic.related_document_support diff --git a/docs/capabilities/text-document/document-color.rst b/docs/capabilities/text-document/document-color.rst new file mode 100644 index 0000000..fed42d6 --- /dev/null +++ b/docs/capabilities/text-document/document-color.rst @@ -0,0 +1,9 @@ +``textDocument/documentColor`` +============================== + +Capabilities relating to the :lsp:`textDocument/documentColor` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.color_provider.dynamic_registration diff --git a/docs/capabilities/text-document/document-highlight.rst b/docs/capabilities/text-document/document-highlight.rst new file mode 100644 index 0000000..78db079 --- /dev/null +++ b/docs/capabilities/text-document/document-highlight.rst @@ -0,0 +1,9 @@ +``textDocument/documentHighlight`` +================================== + +Capabilities relating to the :lsp:`textDocument/documentHighlight` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.document_highlight.dynamic_registration diff --git a/docs/capabilities/text-document/document-link.rst b/docs/capabilities/text-document/document-link.rst new file mode 100644 index 0000000..b42551f --- /dev/null +++ b/docs/capabilities/text-document/document-link.rst @@ -0,0 +1,14 @@ +``textDocument/documentLink`` +================================== + +Capabilities relating to the :lsp:`textDocument/documentLink` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.document_link.dynamic_registration + +Tooltip Support +--------------- + +.. capabilities:bool-table:: text_document.document_link.tooltip_support diff --git a/docs/capabilities/text-document/document-symbols.rst b/docs/capabilities/text-document/document-symbols.rst new file mode 100644 index 0000000..7b90608 --- /dev/null +++ b/docs/capabilities/text-document/document-symbols.rst @@ -0,0 +1,19 @@ +``textDocument/documentSymbols`` +================================ + +Capabilities relating to the :lsp:`textDocument/documentSymbols` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.document_symbol.dynamic_registration + +Hierarchical Symbols +-------------------- + +.. capabilities:bool-table:: text_document.document_symbol.hierarchical_document_symbol_support + +Label Support +------------- + +.. capabilities:bool-table:: text_document.document_symbol.label_support diff --git a/docs/capabilities/text-document/folding-range.rst b/docs/capabilities/text-document/folding-range.rst new file mode 100644 index 0000000..fb385d3 --- /dev/null +++ b/docs/capabilities/text-document/folding-range.rst @@ -0,0 +1,14 @@ +``textDocument/foldingRange`` +============================= + +Capabilities relating to the :lsp:`textDocument/foldingRange` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.folding_range.dynamic_registration + +Line Folding Only +----------------- + +.. capabilities:bool-table:: text_document.folding_range.line_folding_only diff --git a/docs/capabilities/text-document/formatting.rst b/docs/capabilities/text-document/formatting.rst new file mode 100644 index 0000000..36cb558 --- /dev/null +++ b/docs/capabilities/text-document/formatting.rst @@ -0,0 +1,9 @@ +``textDocument/formatting`` +============================= + +Capabilities relating to the :lsp:`textDocument/formatting` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.formatting.dynamic_registration diff --git a/docs/capabilities/text-document/hover.rst b/docs/capabilities/text-document/hover.rst new file mode 100644 index 0000000..fc5ab6e --- /dev/null +++ b/docs/capabilities/text-document/hover.rst @@ -0,0 +1,9 @@ +``textDocument/hover`` +====================== + +Capabilities relating to the :lsp:`textDocument/hover` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.hover.dynamic_registration diff --git a/docs/capabilities/text-document/implementation.rst b/docs/capabilities/text-document/implementation.rst new file mode 100644 index 0000000..2855024 --- /dev/null +++ b/docs/capabilities/text-document/implementation.rst @@ -0,0 +1,14 @@ +``textDocument/implementation`` +=============================== + +Capabilities relating to the :lsp:`textDocument/implementation` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.implementation.dynamic_registration + +Link Support +------------ + +.. capabilities:bool-table:: text_document.implementation.link_support diff --git a/docs/capabilities/text-document/inlay-hint.rst b/docs/capabilities/text-document/inlay-hint.rst new file mode 100644 index 0000000..1b9d9c2 --- /dev/null +++ b/docs/capabilities/text-document/inlay-hint.rst @@ -0,0 +1,9 @@ +``textDocument/inlayHint`` +========================== + +Capabilities relating to the :lsp:`textDocument/inlayHint` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.inlay_hint.dynamic_registration diff --git a/docs/capabilities/text-document/inline-value.rst b/docs/capabilities/text-document/inline-value.rst new file mode 100644 index 0000000..82e53e5 --- /dev/null +++ b/docs/capabilities/text-document/inline-value.rst @@ -0,0 +1,9 @@ +``textDocument/inlineValue`` +============================ + +Capabilities relating to the :lsp:`textDocument/inlineValue` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.inline_value.dynamic_registration diff --git a/docs/capabilities/text-document/linked-editing-range.rst b/docs/capabilities/text-document/linked-editing-range.rst new file mode 100644 index 0000000..6c14a21 --- /dev/null +++ b/docs/capabilities/text-document/linked-editing-range.rst @@ -0,0 +1,9 @@ +``textDocument/linkedEditingRange`` +=================================== + +Capabilities relating to the :lsp:`textDocument/linkedEditingRange` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.linked_editing_range.dynamic_registration diff --git a/docs/capabilities/text-document/moniker.rst b/docs/capabilities/text-document/moniker.rst new file mode 100644 index 0000000..8c961ef --- /dev/null +++ b/docs/capabilities/text-document/moniker.rst @@ -0,0 +1,9 @@ +``textDocument/moniker`` +======================== + +Capabilities relating to the :lsp:`textDocument/moniker` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.moniker.dynamic_registration diff --git a/docs/capabilities/text-document/on-type-formatting.rst b/docs/capabilities/text-document/on-type-formatting.rst new file mode 100644 index 0000000..ccee49f --- /dev/null +++ b/docs/capabilities/text-document/on-type-formatting.rst @@ -0,0 +1,9 @@ +``textDocument/onTypeFormatting`` +================================= + +Capabilities relating to the :lsp:`textDocument/onTypeFormatting` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.on_type_formatting.dynamic_registration diff --git a/docs/capabilities/text-document/preapare-call-hierachy.rst b/docs/capabilities/text-document/preapare-call-hierachy.rst new file mode 100644 index 0000000..89718e9 --- /dev/null +++ b/docs/capabilities/text-document/preapare-call-hierachy.rst @@ -0,0 +1,9 @@ +``textDocument/prepareCallHierarchy`` +===================================== + +Capabilities relating to the :lsp:`textDocument/prepareCallHierarchy` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.call_hierarchy.dynamic_registration diff --git a/docs/capabilities/text-document/preapare-type-hierachy.rst b/docs/capabilities/text-document/preapare-type-hierachy.rst new file mode 100644 index 0000000..cbe8607 --- /dev/null +++ b/docs/capabilities/text-document/preapare-type-hierachy.rst @@ -0,0 +1,9 @@ +``textDocument/prepareTypeHierarchy`` +===================================== + +Capabilities relating to the :lsp:`textDocument/prepareTypeHierarchy` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.type_hierarchy.dynamic_registration diff --git a/docs/capabilities/text-document/publish-diagnostics.rst b/docs/capabilities/text-document/publish-diagnostics.rst new file mode 100644 index 0000000..86a36b2 --- /dev/null +++ b/docs/capabilities/text-document/publish-diagnostics.rst @@ -0,0 +1,24 @@ +``textDocument/publishDiagnostics`` +=================================== + +Capabilities relating to the :lsp:`textDocument/publishDiagnostics` notification. + +Related Information +------------------- + +.. capabilities:bool-table:: text_document.publish_diagnostics.related_information + +Version Support +--------------- + +.. capabilities:bool-table:: text_document.publish_diagnostics.version_support + +Code Description +---------------- + +.. capabilities:bool-table:: text_document.publish_diagnostics.code_description + +Data Support +------------ + +.. capabilities:bool-table:: text_document.publish_diagnostics.data_support diff --git a/docs/capabilities/text-document/range-formatting.rst b/docs/capabilities/text-document/range-formatting.rst new file mode 100644 index 0000000..8530156 --- /dev/null +++ b/docs/capabilities/text-document/range-formatting.rst @@ -0,0 +1,9 @@ +``textDocument/rangeFormatting`` +================================ + +Capabilities relating to the :lsp:`textDocument/rangeFormatting` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.range_formatting.dynamic_registration diff --git a/docs/capabilities/text-document/references.rst b/docs/capabilities/text-document/references.rst new file mode 100644 index 0000000..934a69b --- /dev/null +++ b/docs/capabilities/text-document/references.rst @@ -0,0 +1,9 @@ +``textDocument/references`` +=============================== + +Capabilities relating to the :lsp:`textDocument/references` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.references.dynamic_registration diff --git a/docs/capabilities/text-document/rename.rst b/docs/capabilities/text-document/rename.rst new file mode 100644 index 0000000..18d2e84 --- /dev/null +++ b/docs/capabilities/text-document/rename.rst @@ -0,0 +1,19 @@ +``textDocument/rename`` +======================= + +Capabilities relating to the :lsp:`textDocument/rename` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.rename.dynamic_registration + +Prepare Support +--------------- + +.. capabilities:bool-table:: text_document.rename.prepare_support + +Honors Change Annotations +------------------------- + +.. capabilities:bool-table:: text_document.rename.honors_change_annotations diff --git a/docs/capabilities/text-document/selection-range.rst b/docs/capabilities/text-document/selection-range.rst new file mode 100644 index 0000000..d23007e --- /dev/null +++ b/docs/capabilities/text-document/selection-range.rst @@ -0,0 +1,9 @@ +``textDocument/selectionRange`` +=============================== + +Capabilities relating to the :lsp:`textDocument/selectionRange` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.selection_range.dynamic_registration diff --git a/docs/capabilities/text-document/semantic-tokens.rst b/docs/capabilities/text-document/semantic-tokens.rst new file mode 100644 index 0000000..b12778b --- /dev/null +++ b/docs/capabilities/text-document/semantic-tokens.rst @@ -0,0 +1,45 @@ +``textDocument/semanticTokens`` +=============================== + +Capabilities relating to :lsp:`textDocument/semanticTokens`. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.semantic_tokens.dynamic_registration + +``textDocument/semanticTokens/range`` +------------------------------------- + +.. capabilities:bool-table:: text_document.semantic_tokens.requests.range + +``textDocument/semanticTokens/full`` +------------------------------------- + +.. capabilities:bool-table:: text_document.semantic_tokens.requests.full + +``textDocument/semanticTokens/full/delta`` +------------------------------------------ + +.. capabilities:bool-table:: text_document.semantic_tokens.requests.full.delta + + +Overlapping Tokens +------------------ + +.. capabilities:bool-table:: text_document.semantic_tokens.overlapping_token_support + +Multiline Tokens +---------------- + +.. capabilities:bool-table:: text_document.semantic_tokens.multiline_token_support + +Server Cancel Support +--------------------- + +.. capabilities:bool-table:: text_document.semantic_tokens.server_cancel_support + +Augments Syntax Tokens +---------------------- + +.. capabilities:bool-table:: text_document.semantic_tokens.augments_syntax_tokens diff --git a/docs/capabilities/text-document/signature-help.rst b/docs/capabilities/text-document/signature-help.rst new file mode 100644 index 0000000..e268549 --- /dev/null +++ b/docs/capabilities/text-document/signature-help.rst @@ -0,0 +1,24 @@ +``textDocument/signatureHelp`` +============================== + +Capabilities relating to the :lsp:`textDocument/signatureHelp` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.signature_help.dynamic_registration + +Label Offset Support +-------------------- + +.. capabilities:bool-table:: text_document.signature_help.signature_information.parameter_information.label_offset_support + +Active Parameter Support +------------------------ + +.. capabilities:bool-table:: text_document.signature_help.signature_information.active_parameter_support + +Context Support +--------------- + +.. capabilities:bool-table:: text_document.signature_help.context_support diff --git a/docs/capabilities/text-document/type-definition.rst b/docs/capabilities/text-document/type-definition.rst new file mode 100644 index 0000000..3f0c9d7 --- /dev/null +++ b/docs/capabilities/text-document/type-definition.rst @@ -0,0 +1,14 @@ +``textDocument/typeDefinition`` +=============================== + +Capabilities relating to the :lsp:`textDocument/typeDefinition` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: text_document.type_definition.dynamic_registration + +Link Support +------------ + +.. capabilities:bool-table:: text_document.type_definition.link_support diff --git a/docs/capabilities/window.rst b/docs/capabilities/window.rst new file mode 100644 index 0000000..e5e6a0c --- /dev/null +++ b/docs/capabilities/window.rst @@ -0,0 +1,8 @@ +Window +====== + +.. toctree:: + :maxdepth: 1 + :glob: + + window/* diff --git a/docs/capabilities/window/progress.rst b/docs/capabilities/window/progress.rst new file mode 100644 index 0000000..f882024 --- /dev/null +++ b/docs/capabilities/window/progress.rst @@ -0,0 +1,4 @@ +``window/workDoneProgress/create`` +================================== + +.. capabilities:bool-table:: window.work_done_progress diff --git a/docs/capabilities/window/show-document.rst b/docs/capabilities/window/show-document.rst new file mode 100644 index 0000000..0749e7f --- /dev/null +++ b/docs/capabilities/window/show-document.rst @@ -0,0 +1,6 @@ +``window/showDocument`` +======================= + +Capabilities relating to the :lsp:`window/showDocument` request. + +.. capabilities:bool-table:: window.show_document.support diff --git a/docs/capabilities/window/show-message.rst b/docs/capabilities/window/show-message.rst new file mode 100644 index 0000000..41b01da --- /dev/null +++ b/docs/capabilities/window/show-message.rst @@ -0,0 +1,9 @@ +``window/showMessageRequest`` +============================= + +Capabilities relating to the :lsp:`window/showMessageRequest` request. + +Additional Properties Support +----------------------------- + +.. capabilities:bool-table:: window.show_message.message_action_item.additional_properties_support diff --git a/docs/capabilities/workspace.rst b/docs/capabilities/workspace.rst new file mode 100644 index 0000000..cd46a86 --- /dev/null +++ b/docs/capabilities/workspace.rst @@ -0,0 +1,8 @@ +Workspace +========= + +.. toctree:: + :maxdepth: 1 + :glob: + + workspace/* diff --git a/docs/capabilities/workspace/apply-edit.rst b/docs/capabilities/workspace/apply-edit.rst new file mode 100644 index 0000000..ffa5f13 --- /dev/null +++ b/docs/capabilities/workspace/apply-edit.rst @@ -0,0 +1,6 @@ +``workspace/applyEdit`` +======================= + +Capabilities relating to the :lsp:`workspace/applyEdit` request. + +.. capabilities:bool-table:: workspace.apply_edit diff --git a/docs/capabilities/workspace/code-lens-refresh.rst b/docs/capabilities/workspace/code-lens-refresh.rst new file mode 100644 index 0000000..b4924ea --- /dev/null +++ b/docs/capabilities/workspace/code-lens-refresh.rst @@ -0,0 +1,9 @@ +``workspace/codeLens/refresh`` +============================== + +Capabilities relating to the :lsp:`workspace/codeLens/refresh` request. + +Refresh Support +--------------- + +.. capabilities:bool-table:: workspace.code_lens.refresh_support diff --git a/docs/capabilities/workspace/configuration.rst b/docs/capabilities/workspace/configuration.rst new file mode 100644 index 0000000..f867146 --- /dev/null +++ b/docs/capabilities/workspace/configuration.rst @@ -0,0 +1,16 @@ +``workspace/configuration`` +=========================== + +Capabilities relating to the :lsp:`workspace/configuration` request. + +.. capabilities:bool-table:: workspace.configuration + +``workspace/didChangeConfiguration`` +==================================== + +Capabilities relating to the :lsp:`workspace/didChangeConfiguration` notification. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: workspace.did_change_configuration.dynamic_registration diff --git a/docs/capabilities/workspace/executeCommand.rst b/docs/capabilities/workspace/executeCommand.rst new file mode 100644 index 0000000..e11bf54 --- /dev/null +++ b/docs/capabilities/workspace/executeCommand.rst @@ -0,0 +1,6 @@ +``workspace/executeCommand`` +============================ + +Capabilities relating to the :lsp:`workspace/executeCommand` request. + +.. capabilities:bool-table:: workspace.execute_command.dynamic_registration diff --git a/docs/capabilities/workspace/file-operations.rst b/docs/capabilities/workspace/file-operations.rst new file mode 100644 index 0000000..0ee78f7 --- /dev/null +++ b/docs/capabilities/workspace/file-operations.rst @@ -0,0 +1,56 @@ +``workspace/willCreateFiles`` +============================= + +Capabilities relating to the :lsp:`workspace/willCreateFiles` request. + +.. capabilities:bool-table:: workspace.file_operations.will_create + +``workspace/didCreateFiles`` +============================= + +Capabilities relating to the :lsp:`workspace/didCreateFiles` notification. + +.. capabilities:bool-table:: workspace.file_operations.did_create + +``workspace/willRenameFiles`` +============================= + +Capabilities relating to the :lsp:`workspace/willRenameFiles` request. + +.. capabilities:bool-table:: workspace.file_operations.will_rename + +``workspace/didRenameFiles`` +============================= + +Capabilities relating to the :lsp:`workspace/didRenameFiles` notification. + +.. capabilities:bool-table:: workspace.file_operations.did_rename + +``workspace/willDeleteFiles`` +============================= + +Capabilities relating to the :lsp:`workspace/willDeleteFiles` request. + +.. capabilities:bool-table:: workspace.file_operations.will_delete + +``workspace/didDeleteFiles`` +============================= + +Capabilities relating to the :lsp:`workspace/didDeleteFiles` notification. + +.. capabilities:bool-table:: workspace.file_operations.did_delete + +``workspace/didChangeWatchedFiles`` +=================================== + +Capabilities relating to the :lsp:`workspace/didChangeWatchedFiles` notification. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: workspace.did_change_watched_files.dynamic_registration + +Relative Pattern Support +------------------------ + +.. capabilities:bool-table:: workspace.did_change_watched_files.relative_pattern_support diff --git a/docs/capabilities/workspace/inlay-hint-refresh.rst b/docs/capabilities/workspace/inlay-hint-refresh.rst new file mode 100644 index 0000000..6233876 --- /dev/null +++ b/docs/capabilities/workspace/inlay-hint-refresh.rst @@ -0,0 +1,9 @@ +``workspace/inlayHint/refresh`` +=============================== + +Capabilities relating to the :lsp:`workspace/inlayHint/refresh` request. + +Refresh Support +--------------- + +.. capabilities:bool-table:: workspace.inlay_hint.refresh_support diff --git a/docs/capabilities/workspace/inline-value-refresh.rst b/docs/capabilities/workspace/inline-value-refresh.rst new file mode 100644 index 0000000..6035a7b --- /dev/null +++ b/docs/capabilities/workspace/inline-value-refresh.rst @@ -0,0 +1,9 @@ +``workspace/inlineValue/refresh`` +================================= + +Capabilities relating to the :lsp:`workspace/inlineValue/refresh` request. + +Rehresh Support +--------------- + +.. capabilities:bool-table:: workspace.inline_value.refresh_support diff --git a/docs/capabilities/workspace/symbol.rst b/docs/capabilities/workspace/symbol.rst new file mode 100644 index 0000000..607cd0a --- /dev/null +++ b/docs/capabilities/workspace/symbol.rst @@ -0,0 +1,9 @@ +``workspace/symbol`` +==================== + +Capabilities relating to the :lsp:`workspace/symbol` request. + +Dynamic Registration +-------------------- + +.. capabilities:bool-table:: workspace.symbol.dynamic_registration diff --git a/docs/capabilities/workspace/workspace-folders.rst b/docs/capabilities/workspace/workspace-folders.rst new file mode 100644 index 0000000..82dffdc --- /dev/null +++ b/docs/capabilities/workspace/workspace-folders.rst @@ -0,0 +1,6 @@ +``workspace/workspaceFolders`` +============================== + +Capabilities relating to the :lsp:`workspace/workspaceFolders` request. + +.. capabilities:bool-table:: workspace.workspace_folders diff --git a/docs/index.rst b/docs/index.rst index b274137..200b07e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,57 @@ LSP Devtools ============ -The LSP Devtools project provides a number of tools that aim to make the -process of developing language servers and clients easier. +The LSP Devtools project provides a number of tools for making the the +process of developing language servers easier. + +Client Capability Index +----------------------- + +.. warning:: + + This is still under construction. + +.. important:: + + This accuracy of this section entirely depends on the captured capabilities data that is `bundled `__ with pytest-lsp. + + Pull requests for corrections and new data welcome! + +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: Capabilities + + capabilities/text-document + capabilities/workspace + capabilities/window + +Inspired by `caniuse.com `__ this provides information on which clients support which features of the `LSP Specification `__. + +.. grid:: 2 + :gutter: 2 + + .. grid-item-card:: Text Document + :columns: 12 + :link: /capabilities/text-document + :link-type: doc + :text-align: center + + Capabilities for text document methods like completion, code actions and more. + + .. grid-item-card:: Window + :link: /capabilities/window + :link-type: doc + :text-align: center + + Work done progress, show document and message requests + + .. grid-item-card:: Workspace + :link: /capabilities/workspace + :link-type: doc + :text-align: center + + File operations, workspace folders and configuration lsp-devtools ------------ @@ -15,6 +64,8 @@ lsp-devtools lsp-devtools/changelog +.. figure:: https://user-images.githubusercontent.com/2675694/273293510-e43fdc92-03dd-40c9-aaca-ddb5e526031a.png + The `lsp-devtools `_ package provides a collection of CLI utilities that help inspect and visualise the interactions between a language client and a server. See the :doc:`lsp-devtools/guide/getting-started` guide for details.