language_server-protocol 3.14.0.1 → 3.16.0.0

data/lib/language_server/protocol/interface/change_annotation.rb

@@ -0,0 +1,57 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Additional information that describes document changes.
+      #
+      class ChangeAnnotation
+        def initialize(label:, needs_confirmation: nil, description: nil)
+          @attributes = {}
+
+          @attributes[:label] = label
+          @attributes[:needsConfirmation] = needs_confirmation if needs_confirmation
+          @attributes[:description] = description if description
+
+          @attributes.freeze
+        end
+
+        #
+        # A human-readable string describing the actual change. The string
+        # is rendered prominent in the user interface.
+        #
+        # @return [string]
+        def label
+          attributes.fetch(:label)
+        end
+
+        #
+        # A flag which indicates that user confirmation is needed
+        # before applying the change.
+        #
+        # @return [boolean]
+        def needs_confirmation
+          attributes.fetch(:needsConfirmation)
+        end
+
+        #
+        # A human-readable string which is rendered less prominent in
+        # the user interface.
+        #
+        # @return [string]
+        def description
+          attributes.fetch(:description)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/client_capabilities.rb

@@ -2,11 +2,13 @@ module LanguageServer
   module Protocol
     module Interface
       class ClientCapabilities
-        def initialize(workspace: nil, text_document: nil, experimental: nil)
+        def initialize(workspace: nil, text_document: nil, window: nil, general: nil, experimental: nil)
           @attributes = {}
 
           @attributes[:workspace] = workspace if workspace
           @attributes[:textDocument] = text_document if text_document
+          @attributes[:window] = window if window
+          @attributes[:general] = general if general
           @attributes[:experimental] = experimental if experimental
 
           @attributes.freeze
@@ -15,7 +17,7 @@ module LanguageServer
         #
         # Workspace specific client capabilities.
         #
-        # @return [WorkspaceClientCapabilities]
+        # @return [{ applyEdit?: boolean; workspaceEdit?: WorkspaceEditClientCapabilities; didChangeConfiguration?: DidChangeConfigurationClientCapabilities; ... 7 more ...; fileOperations?: { ...; }; }]
         def workspace
           attributes.fetch(:workspace)
         end
@@ -28,6 +30,22 @@ module LanguageServer
           attributes.fetch(:textDocument)
         end
 
+        #
+        # Window specific client capabilities.
+        #
+        # @return [{ workDoneProgress?: boolean; showMessage?: ShowMessageRequestClientCapabilities; showDocument?: ShowDocumentClientCapabilities; }]
+        def window
+          attributes.fetch(:window)
+        end
+
+        #
+        # General client capabilities.
+        #
+        # @return [{ regularExpressions?: RegularExpressionsClientCapabilities; markdown?: MarkdownClientCapabilities; }]
+        def general
+          attributes.fetch(:general)
+        end
+
         #
         # Experimental client capabilities.
         #

data/lib/language_server/protocol/interface/code_action.rb

@@ -2,20 +2,24 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A code action represents a change that can be performed in code, e.g. to fix a problem or
-      # to refactor code.
+      # A code action represents a change that can be performed in code, e.g. to fix
+      # a problem or to refactor code.
       #
-      # A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
+      # A CodeAction must set either `edit` and/or a `command`. If both are supplied,
+      # the `edit` is applied first, then the `command` is executed.
       #
       class CodeAction
-        def initialize(title:, kind: nil, diagnostics: nil, edit: nil, command: nil)
+        def initialize(title:, kind: nil, diagnostics: nil, is_preferred: nil, disabled: nil, edit: nil, command: nil, data: nil)
           @attributes = {}
 
           @attributes[:title] = title
           @attributes[:kind] = kind if kind
           @attributes[:diagnostics] = diagnostics if diagnostics
+          @attributes[:isPreferred] = is_preferred if is_preferred
+          @attributes[:disabled] = disabled if disabled
           @attributes[:edit] = edit if edit
           @attributes[:command] = command if command
+          @attributes[:data] = data if data
 
           @attributes.freeze
         end
@@ -46,6 +50,41 @@ module LanguageServer
           attributes.fetch(:diagnostics)
         end
 
+        #
+        # Marks this as a preferred action. Preferred actions are used by the
+        # `auto fix` command and can be targeted by keybindings.
+        #
+        # A quick fix should be marked preferred if it properly addresses the
+        # underlying error. A refactoring should be marked preferred if it is the
+        # most reasonable choice of actions to take.
+        #
+        # @return [boolean]
+        def is_preferred
+          attributes.fetch(:isPreferred)
+        end
+
+        #
+        # Marks that the code action cannot currently be applied.
+        #
+        # Clients should follow the following guidelines regarding disabled code
+        # actions:
+        #
+        # - Disabled code actions are not shown in automatic lightbulbs code
+        # action menus.
+        #
+        # - Disabled actions are shown as faded out in the code action menu when
+        # the user request a more specific type of code action, such as
+        # refactorings.
+        #
+        # - If the user has a keybinding that auto applies a code action and only
+        # a disabled code actions are returned, the client should show the user
+        # an error message with `reason` in the editor.
+        #
+        # @return [{ reason: string; }]
+        def disabled
+          attributes.fetch(:disabled)
+        end
+
         #
         # The workspace edit this code action performs.
         #
@@ -64,6 +103,15 @@ module LanguageServer
           attributes.fetch(:command)
         end
 
+        #
+        # A data entry field that is preserved on a code action between
+        # a `textDocument/codeAction` and a `codeAction/resolve` request.
+        #
+        # @return [any]
+        def data
+          attributes.fetch(:data)
+        end
+
         attr_reader :attributes
 
         def to_hash

data/lib/language_server/protocol/interface/code_action_client_capabilities.rb

@@ -0,0 +1,95 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class CodeActionClientCapabilities
+        def initialize(dynamic_registration: nil, code_action_literal_support: nil, is_preferred_support: nil, disabled_support: nil, data_support: nil, resolve_support: nil, honors_change_annotations: nil)
+          @attributes = {}
+
+          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:codeActionLiteralSupport] = code_action_literal_support if code_action_literal_support
+          @attributes[:isPreferredSupport] = is_preferred_support if is_preferred_support
+          @attributes[:disabledSupport] = disabled_support if disabled_support
+          @attributes[:dataSupport] = data_support if data_support
+          @attributes[:resolveSupport] = resolve_support if resolve_support
+          @attributes[:honorsChangeAnnotations] = honors_change_annotations if honors_change_annotations
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether code action supports dynamic registration.
+        #
+        # @return [boolean]
+        def dynamic_registration
+          attributes.fetch(:dynamicRegistration)
+        end
+
+        #
+        # The client supports code action literals as a valid
+        # response of the `textDocument/codeAction` request.
+        #
+        # @return [{ codeActionKind: { valueSet: string[]; }; }]
+        def code_action_literal_support
+          attributes.fetch(:codeActionLiteralSupport)
+        end
+
+        #
+        # Whether code action supports the `isPreferred` property.
+        #
+        # @return [boolean]
+        def is_preferred_support
+          attributes.fetch(:isPreferredSupport)
+        end
+
+        #
+        # Whether code action supports the `disabled` property.
+        #
+        # @return [boolean]
+        def disabled_support
+          attributes.fetch(:disabledSupport)
+        end
+
+        #
+        # Whether code action supports the `data` property which is
+        # preserved between a `textDocument/codeAction` and a
+        # `codeAction/resolve` request.
+        #
+        # @return [boolean]
+        def data_support
+          attributes.fetch(:dataSupport)
+        end
+
+        #
+        # Whether the client supports resolving additional code action
+        # properties via a separate `codeAction/resolve` request.
+        #
+        # @return [{ properties: string[]; }]
+        def resolve_support
+          attributes.fetch(:resolveSupport)
+        end
+
+        #
+        # Whether the client honors the change annotations in
+        # text edits and resource operations returned via the
+        # `CodeAction#edit` property by for example presenting
+        # the workspace edit in the user interface and asking
+        # for confirmation.
+        #
+        # @return [boolean]
+        def honors_change_annotations
+          attributes.fetch(:honorsChangeAnnotations)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/code_action_context.rb

@@ -16,7 +16,12 @@ module LanguageServer
         end
 
         #
-        # An array of diagnostics.
+        # An array of diagnostics known on the client side overlapping the range
+        # provided to the `textDocument/codeAction` request. They are provided so
+        # that the server knows which errors are currently presented to the user
+        # for the given range. There is no guarantee that these accurately reflect
+        # the error state of the resource. The primary parameter
+        # to compute code actions is the provided range.
         #
         # @return [Diagnostic[]]
         def diagnostics
@@ -26,8 +31,8 @@ module LanguageServer
         #
         # Requested kind of actions to return.
         #
-        # Actions not of this kind are filtered out by the client before being shown. So servers
-        # can omit computing them.
+        # Actions not of this kind are filtered out by the client before being
+        # shown. So servers can omit computing them.
         #
         # @return [string[]]
         def only

data/lib/language_server/protocol/interface/code_action_options.rb

@@ -1,14 +1,13 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Code Action options.
-      #
-      class CodeActionOptions
-        def initialize(code_action_kinds: nil)
+      class CodeActionOptions < WorkDoneProgressOptions
+        def initialize(work_done_progress: nil, code_action_kinds: nil, resolve_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end
@@ -16,14 +15,23 @@ module LanguageServer
         #
         # CodeActionKinds that this server may return.
         #
-        # The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
-        # may list out every specific kind they provide.
+        # The list of kinds may be generic, such as `CodeActionKind.Refactor`,
+        # or the server may list out every specific kind they provide.
         #
         # @return [string[]]
         def code_action_kinds
           attributes.fetch(:codeActionKinds)
         end
 
+        #
+        # The server provides support to resolve additional
+        # information for a code action.
+        #
+        # @return [boolean]
+        def resolve_provider
+          attributes.fetch(:resolveProvider)
+        end
+
         attr_reader :attributes
 
         def to_hash

data/lib/language_server/protocol/interface/code_action_params.rb

@@ -4,10 +4,11 @@ module LanguageServer
       #
       # Params for the CodeActionRequest
       #
-      class CodeActionParams
-        def initialize(text_document:, range:, context:)
+      class CodeActionParams < PartialResultParams
+        def initialize(partial_result_token: nil, text_document:, range:, context:)
           @attributes = {}
 
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:context] = context

data/lib/language_server/protocol/interface/code_action_registration_options.rb

@@ -2,9 +2,12 @@ module LanguageServer
   module Protocol
     module Interface
       class CodeActionRegistrationOptions < CodeActionOptions
-        def initialize(code_action_kinds: nil)
+        def initialize(work_done_progress: nil, code_action_kinds: nil, resolve_provider: nil)
           @attributes = {}
 
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
+          @attributes[:resolveProvider] = resolve_provider if resolve_provider
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/code_description.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Structure to capture a description for an error code.
+      #
+      class CodeDescription
+        def initialize(href:)
+          @attributes = {}
+
+          @attributes[:href] = href
+
+          @attributes.freeze
+        end
+
+        #
+        # An URI to open with more information about the diagnostic error.
+        #
+        # @return [string]
+        def href
+          attributes.fetch(:href)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/code_lens.rb

@@ -5,8 +5,9 @@ module LanguageServer
       # A code lens represents a command that should be shown along with
       # source text, like the number of references, a way to run tests, etc.
       #
-      # A code lens is _unresolved_ when no command is associated to it. For performance
-      # reasons the creation of a code lens and resolving should be done in two stages.
+      # A code lens is _unresolved_ when no command is associated to it. For
+      # performance reasons the creation of a code lens and resolving should be done
+      # in two stages.
       #
       class CodeLens
         def initialize(range:, command: nil, data: nil)
@@ -20,7 +21,8 @@ module LanguageServer
         end
 
         #
-        # The range in which this code lens is valid. Should only span a single line.
+        # The range in which this code lens is valid. Should only span a single
+        # line.
         #
         # @return [Range]
         def range