Update LSP types (#2593)

Author: predragnikolic

plugin/core/protocol.py

@@ -408,6 +408,14 @@ class CodeActionKind(StrEnum):
     @since 3.18.0 """
 
 
+class CodeActionTag(IntEnum):
+    """ Code action tags are extra annotations that tweak the behavior of a code action.
+
+    @since 3.18.0 - proposed """
+    LLMGenerated = 1
+    """ Marks the code action as LLM-generated. """
+
+
 class TraceValue(StrEnum):
     Off = 'off'
     """ Turn tracing off. """
@@ -431,8 +439,7 @@ class MarkupKind(StrEnum):
 
 class LanguageKind(StrEnum):
     """ Predefined Language kinds
-    @since 3.18.0
-    @proposed """
+    @since 3.18.0 """
     ABAP = 'abap'
     WindowsBat = 'bat'
     BibTeX = 'bibtex'
@@ -590,6 +597,21 @@ class CompletionTriggerKind(IntEnum):
     """ Completion was re-triggered as current completion list is incomplete """
 
 
+class ApplyKind(IntFlag):
+    """ Defines how values from a set of defaults and an individual item will be
+    merged.
+
+    @since 3.18.0 """
+    Replace = 1
+    """ The value from the individual item (if provided and not `null`) will be
+    used instead of the default. """
+    Merge = 2
+    """ The value from the item will be merged with the default.
+
+    The specific rules for mergeing values are defined against each field
+    that supports merging. """
+
+
 class SignatureHelpTriggerKind(IntEnum):
     """ How a signature help was triggered.
 
@@ -768,7 +790,7 @@ class TokenFormat(StrEnum):
 """ A document filter describes a top level text document or
 a notebook cell document.
 
-@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter. """
+@since 3.17.0 - support for NotebookCellTextDocumentFilter. """
 
 LSPObject = Dict[str, 'LSPAny']
 """ LSP object definition.
@@ -2197,13 +2219,33 @@ class CompletionList(TypedDict):
     be used if a completion item itself doesn't specify the value.
 
     If a completion list specifies a default value and a completion item
-    also specifies a corresponding value the one from the item is used.
+    also specifies a corresponding value, the rules for combining these are
+    defined by `applyKinds` (if the client supports it), defaulting to
+    ApplyKind.Replace.
 
     Servers are only allowed to return default values if the client
     signals support for this via the `completionList.itemDefaults`
     capability.
 
     @since 3.17.0 """
+    applyKind: NotRequired['CompletionItemApplyKinds']
+    """ Specifies how fields from a completion item should be combined with those
+    from `completionList.itemDefaults`.
+
+    If unspecified, all fields will be treated as ApplyKind.Replace.
+
+    If a field's value is ApplyKind.Replace, the value from a completion item
+    (if provided and not `null`) will always be used instead of the value
+    from `completionItem.itemDefaults`.
+
+    If a field's value is ApplyKind.Merge, the values will be merged using
+    the rules defined against each field below.
+
+    Servers are only allowed to return `applyKind` if the client
+    signals support for this via the `completionList.applyKindSupport`
+    capability.
+
+    @since 3.18.0 """
     items: List['CompletionItem']
     """ The completion items. """
 
@@ -2572,6 +2614,10 @@ class CodeAction(TypedDict):
     a `textDocument/codeAction` and a `codeAction/resolve` request.
 
     @since 3.16.0 """
+    tags: NotRequired[List['CodeActionTag']]
+    """ Tags for this code action.
+
+    @since 3.18.0 - proposed """
 
 
 class CodeActionRegistrationOptions(TypedDict):
@@ -3913,7 +3959,9 @@ class CompletionItemDefaults(TypedDict):
     be used if a completion item itself doesn't specify the value.
 
     If a completion list specifies a default value and a completion item
-    also specifies a corresponding value the one from the item is used.
+    also specifies a corresponding value, the rules for combining these are
+    defined by `applyKinds` (if the client supports it), defaulting to
+    ApplyKind.Replace.
 
     Servers are only allowed to return default values if the client
     signals support for this via the `completionList.itemDefaults`
@@ -3942,6 +3990,65 @@ class CompletionItemDefaults(TypedDict):
     @since 3.17.0 """
 
 
+class CompletionItemApplyKinds(TypedDict):
+    """ Specifies how fields from a completion item should be combined with those
+    from `completionList.itemDefaults`.
+
+    If unspecified, all fields will be treated as ApplyKind.Replace.
+
+    If a field's value is ApplyKind.Replace, the value from a completion item (if
+    provided and not `null`) will always be used instead of the value from
+    `completionItem.itemDefaults`.
+
+    If a field's value is ApplyKind.Merge, the values will be merged using the rules
+    defined against each field below.
+
+    Servers are only allowed to return `applyKind` if the client
+    signals support for this via the `completionList.applyKindSupport`
+    capability.
+
+    @since 3.18.0 """
+    commitCharacters: NotRequired['ApplyKind']
+    """ Specifies whether commitCharacters on a completion will replace or be
+    merged with those in `completionList.itemDefaults.commitCharacters`.
+
+    If ApplyKind.Replace, the commit characters from the completion item will
+    always be used unless not provided, in which case those from
+    `completionList.itemDefaults.commitCharacters` will be used. An
+    empty list can be used if a completion item does not have any commit
+    characters and also should not use those from
+    `completionList.itemDefaults.commitCharacters`.
+
+    If ApplyKind.Merge the commitCharacters for the completion will be the
+    union of all values in both `completionList.itemDefaults.commitCharacters`
+    and the completion's own `commitCharacters`.
+
+    @since 3.18.0 """
+    data: NotRequired['ApplyKind']
+    """ Specifies whether the `data` field on a completion will replace or
+    be merged with data from `completionList.itemDefaults.data`.
+
+    If ApplyKind.Replace, the data from the completion item will be used if
+    provided (and not `null`), otherwise
+    `completionList.itemDefaults.data` will be used. An empty object can
+    be used if a completion item does not have any data but also should
+    not use the value from `completionList.itemDefaults.data`.
+
+    If ApplyKind.Merge, a shallow merge will be performed between
+    `completionList.itemDefaults.data` and the completion's own data
+    using the following rules:
+
+    - If a completion's `data` field is not provided (or `null`), the
+      entire `data` field from `completionList.itemDefaults.data` will be
+      used as-is.
+    - If a completion's `data` field is provided, each field will
+      overwrite the field of the same name in
+      `completionList.itemDefaults.data` but no merging of nested fields
+      within that value will occur.
+
+    @since 3.18.0 """
+
+
 class CompletionOptions(TypedDict):
     """ Completion options. """
     triggerCharacters: NotRequired[List[str]]
@@ -4771,6 +4878,10 @@ class TextDocumentClientCapabilities(TypedDict):
     """ Text document specific client capabilities. """
     synchronization: NotRequired['TextDocumentSyncClientCapabilities']
     """ Defines which synchronization capabilities the client supports. """
+    filters: NotRequired['TextDocumentFilterClientCapabilities']
+    """ Defines which filters the client supports.
+
+    @since 3.18.0 """
     completion: NotRequired['CompletionClientCapabilities']
     """ Capabilities specific to the `textDocument/completion` request. """
     hover: NotRequired['HoverClientCapabilities']
@@ -4991,7 +5102,9 @@ class TextDocumentFilterLanguage(TypedDict):
     pattern: NotRequired['GlobPattern']
     """ A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
 
-    @since 3.18.0 - support for relative patterns. """
+    @since 3.18.0 - support for relative patterns. Whether clients support
+    relative patterns depends on the client capability
+    `textDocuments.filters.relativePatternSupport`. """
 
 
 class TextDocumentFilterScheme(TypedDict):
@@ -5005,7 +5118,9 @@ class TextDocumentFilterScheme(TypedDict):
     pattern: NotRequired['GlobPattern']
     """ A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
 
-    @since 3.18.0 - support for relative patterns. """
+    @since 3.18.0 - support for relative patterns. Whether clients support
+    relative patterns depends on the client capability
+    `textDocuments.filters.relativePatternSupport`. """
 
 
 class TextDocumentFilterPattern(TypedDict):
@@ -5019,7 +5134,9 @@ class TextDocumentFilterPattern(TypedDict):
     pattern: 'GlobPattern'
     """ A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
 
-    @since 3.18.0 - support for relative patterns. """
+    @since 3.18.0 - support for relative patterns. Whether clients support
+    relative patterns depends on the client capability
+    `textDocuments.filters.relativePatternSupport`. """
 
 
 class NotebookDocumentFilterNotebookType(TypedDict):
@@ -5280,6 +5397,13 @@ class TextDocumentSyncClientCapabilities(TypedDict):
     """ The client supports did save notifications. """
 
 
+class TextDocumentFilterClientCapabilities(TypedDict):
+    relativePatternSupport: NotRequired[bool]
+    """ The client supports Relative Patterns.
+
+    @since 3.18.0 """
+
+
 class CompletionClientCapabilities(TypedDict):
     """ Completion client capabilities """
     dynamicRegistration: NotRequired[bool]
@@ -5449,6 +5573,11 @@ class CodeActionClientCapabilities(TypedDict):
 
     @since 3.18.0
     @proposed """
+    tagSupport: NotRequired['CodeActionTagOptions']
+    """ Client supports the tag property on a code action. Clients
+    supporting tags have to handle unknown tags gracefully.
+
+    @since 3.18.0 - proposed """
 
 
 class CodeLensClientCapabilities(TypedDict):
@@ -5895,6 +6024,18 @@ class CompletionListCapabilities(TypedDict):
     no properties are supported.
 
     @since 3.17.0 """
+    applyKindSupport: NotRequired[bool]
+    """ Specifies whether the client supports `CompletionList.applyKind` to
+    indicate how supported values from `completionList.itemDefaults`
+    and `completion` will be combined.
+
+    If a client supports `applyKind` it must support it for all fields
+    that it supports that are listed in `CompletionList.applyKind`. This
+    means when clients add support for new/future fields in completion
+    items the MUST also support merge for them if those fields are
+    defined in `CompletionList.applyKind`.
+
+    @since 3.18.0 """
 
 
 class ClientSignatureInformationOptions(TypedDict):
@@ -5931,6 +6072,12 @@ class ClientCodeActionResolveOptions(TypedDict):
     """ The properties that a client can resolve lazily. """
 
 
+class CodeActionTagOptions(TypedDict):
+    """ @since 3.18.0 - proposed """
+    valueSet: List['CodeActionTag']
+    """ The tags supported by the client. """
+
+
 class ClientCodeLensResolveOptions(TypedDict):
     """ @since 3.18.0 """
     properties: List[str]