language_server-protocol 0.5.0 → 3.7.0.0

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

@@ -2,14 +2,25 @@ module LanguageServer
   module Protocol
     module Interface
       class ApplyWorkspaceEditParams
-        def initialize(edit:)
+        def initialize(label: nil, edit:)
           @attributes = {}
 
+          @attributes[:label] = label if label
           @attributes[:edit] = edit
 
           @attributes.freeze
         end
 
+        #
+        # An optional label of the workspace edit. This label is
+        # presented in the user interface for example on an undo
+        # stack to undo the workspace edit.
+        #
+        # @return [string]
+        def label
+          attributes.fetch(:label)
+        end
+
         #
         # The edits to apply.
         #

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

@@ -15,7 +15,7 @@ module LanguageServer
         #
         # Workspace specific client capabilities.
         #
-        # @return [WorkspaceClientCapabilites]
+        # @return [WorkspaceClientCapabilities]
         def workspace
           attributes.fetch(:workspace)
         end

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

@@ -0,0 +1,63 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents a color in RGBA space.
+      #
+      class Color
+        def initialize(red:, green:, blue:, alpha:)
+          @attributes = {}
+
+          @attributes[:red] = red
+          @attributes[:green] = green
+          @attributes[:blue] = blue
+          @attributes[:alpha] = alpha
+
+          @attributes.freeze
+        end
+
+        #
+        # The red component of this color in the range [0-1].
+        #
+        # @return [number]
+        def red
+          attributes.fetch(:red)
+        end
+
+        #
+        # The green component of this color in the range [0-1].
+        #
+        # @return [number]
+        def green
+          attributes.fetch(:green)
+        end
+
+        #
+        # The blue component of this color in the range [0-1].
+        #
+        # @return [number]
+        def blue
+          attributes.fetch(:blue)
+        end
+
+        #
+        # The alpha component of this color in the range [0-1].
+        #
+        # @return [number]
+        def alpha
+          attributes.fetch(:alpha)
+        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/color_information.rb

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ColorInformation
+        def initialize(range:, color:)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:color] = color
+
+          @attributes.freeze
+        end
+
+        #
+        # The range in the document where this color appears.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The actual color value for this color range.
+        #
+        # @return [Color]
+        def color
+          attributes.fetch(:color)
+        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/color_presentation.rb

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ColorPresentation
+        def initialize(label:, text_edit: nil, additional_text_edits: nil)
+          @attributes = {}
+
+          @attributes[:label] = label
+          @attributes[:textEdit] = text_edit if text_edit
+          @attributes[:additionalTextEdits] = additional_text_edits if additional_text_edits
+
+          @attributes.freeze
+        end
+
+        #
+        # The label of this color presentation. It will be shown on the color
+        # picker header. By default this is also the text that is inserted when selecting
+        # this color presentation.
+        #
+        # @return [string]
+        def label
+          attributes.fetch(:label)
+        end
+
+        #
+        # An [edit](#TextEdit) which is applied to a document when selecting
+        # this presentation for the color.  When `falsy` the [label](#ColorPresentation.label)
+        # is used.
+        #
+        # @return [TextEdit]
+        def text_edit
+          attributes.fetch(:textEdit)
+        end
+
+        #
+        # An optional array of additional [text edits](#TextEdit) that are applied when
+        # selecting this color presentation. Edits must not overlap with the main [edit](#ColorPresentation.textEdit) nor with themselves.
+        #
+        # @return [TextEdit[]]
+        def additional_text_edits
+          attributes.fetch(:additionalTextEdits)
+        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/color_presentation_params.rb

@@ -0,0 +1,51 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ColorPresentationParams
+        def initialize(text_document:, color:, range:)
+          @attributes = {}
+
+          @attributes[:textDocument] = text_document
+          @attributes[:color] = color
+          @attributes[:range] = range
+
+          @attributes.freeze
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The color information to request presentations for.
+        #
+        # @return [Color]
+        def color
+          attributes.fetch(:color)
+        end
+
+        #
+        # The range where the color would be inserted. Serves as a context.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        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/color_provider_options.rb

@@ -0,0 +1,27 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Color provider Options
+      #
+      class ColorProviderOptions
+        def initialize()
+          @attributes = {}
+
+
+          @attributes.freeze
+        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/completion_context.rb

@@ -0,0 +1,46 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Contains additional information about the context in which a completion request is triggered.
+      #
+      class CompletionContext
+        def initialize(trigger_kind:, trigger_character: nil)
+          @attributes = {}
+
+          @attributes[:triggerKind] = trigger_kind
+          @attributes[:triggerCharacter] = trigger_character if trigger_character
+
+          @attributes.freeze
+        end
+
+        #
+        # How the completion was triggered.
+        #
+        # @return [CompletionTriggerKind]
+        def trigger_kind
+          attributes.fetch(:triggerKind)
+        end
+
+        #
+        # The trigger character (a single character) that has trigger code complete.
+        # Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
+        #
+        # @return [string]
+        def trigger_character
+          attributes.fetch(:triggerCharacter)
+        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/completion_item.rb

@@ -2,19 +2,21 @@ module LanguageServer
   module Protocol
     module Interface
       class CompletionItem
-        def initialize(label:, kind: nil, detail: nil, documentation: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, text_edit: nil, additional_text_edits: nil, command: nil, data: nil)
+        def initialize(label:, kind: nil, detail: nil, documentation: nil, deprecated: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, text_edit: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
           @attributes = {}
 
           @attributes[:label] = label
           @attributes[:kind] = kind if kind
           @attributes[:detail] = detail if detail
           @attributes[:documentation] = documentation if documentation
+          @attributes[:deprecated] = deprecated if deprecated
           @attributes[:sortText] = sort_text if sort_text
           @attributes[:filterText] = filter_text if filter_text
           @attributes[:insertText] = insert_text if insert_text
           @attributes[:insertTextFormat] = insert_text_format if insert_text_format
           @attributes[:textEdit] = text_edit if text_edit
           @attributes[:additionalTextEdits] = additional_text_edits if additional_text_edits
+          @attributes[:commitCharacters] = commit_characters if commit_characters
           @attributes[:command] = command if command
           @attributes[:data] = data if data
 
@@ -52,13 +54,21 @@ module LanguageServer
         #
         # A human-readable string that represents a doc-comment.
         #
-        # @return [string]
+        # @return [string | MarkupContent]
         def documentation
           attributes.fetch(:documentation)
         end
 
         #
-        # A string that shoud be used when comparing this item
+        # Indicates if this item is deprecated.
+        #
+        # @return [boolean]
+        def deprecated
+          attributes.fetch(:deprecated)
+        end
+
+        #
+        # A string that should be used when comparing this item
         # with other items. When `falsy` the label is used.
         #
         # @return [string]
@@ -76,9 +86,16 @@ module LanguageServer
         end
 
         #
-        # A string that should be inserted a document when selecting
+        # A string that should be inserted into a document when selecting
         # this completion. When `falsy` the label is used.
         #
+        # The `insertText` is subject to interpretation by the client side.
+        # Some tools might not take the string literally. For example
+        # VS Code when code complete is requested in this example `con<cursor position>`
+        # and a completion item with an `insertText` of `console` is provided it
+        # will only insert `sole`. Therefore it is recommended to use `textEdit` instead
+        # since it avoids additional client side interpretation.
+        #
         # @return [string]
         def insert_text
           attributes.fetch(:insertText)
@@ -107,14 +124,28 @@ module LanguageServer
 
         #
         # An optional array of additional text edits that are applied when
-        # selecting this completion. Edits must not overlap with the main edit
-        # nor with themselves.
+        # selecting this completion. Edits must not overlap (including the same insert position)
+        # with the main edit nor with themselves.
+        #
+        # Additional text edits should be used to change text unrelated to the current cursor position
+        # (for example adding an import statement at the top of the file if the completion item will
+        # insert an unqualified type).
         #
         # @return [TextEdit[]]
         def additional_text_edits
           attributes.fetch(:additionalTextEdits)
         end
 
+        #
+        # An optional set of characters that when pressed while this completion is active will accept it first and
+        # then type that character. *Note* that all commit characters should have `length=1` and that superfluous
+        # characters will be ignored.
+        #
+        # @return [string[]]
+        def commit_characters
+          attributes.fetch(:commitCharacters)
+        end
+
         #
         # An optional command that is executed *after* inserting this completion. *Note* that
         # additional modifications to the current document should be described with the

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

@@ -0,0 +1,34 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class CompletionParams < TextDocumentPositionParams
+        def initialize(text_document:, position:, context: nil)
+          @attributes = {}
+
+          @attributes[:context] = context if context
+
+          @attributes.freeze
+        end
+
+        #
+        # The completion context. This is only available it the client specifies
+        # to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
+        #
+        # @return [CompletionContext]
+        def context
+          attributes.fetch(:context)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end