language_server-protocol 0.5.0 → 3.7.0.0

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

@@ -22,7 +22,7 @@ module LanguageServer
         #
         # The notification's params.
         #
-        # @return [any]
+        # @return [object | any[]]
         def params
           attributes.fetch(:params)
         end

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

@@ -28,7 +28,7 @@ module LanguageServer
         # The human-readable doc-comment of this parameter. Will be shown
         # in the UI but can be omitted.
         #
-        # @return [string]
+        # @return [string | MarkupContent]
         def documentation
           attributes.fetch(:documentation)
         end

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

@@ -20,7 +20,12 @@ module LanguageServer
         end
 
         #
-        # Character offset on a line in a document (zero-based).
+        # Character offset on a line in a document (zero-based). Assuming that the line is
+        # represented as a string, the `character` value represents the gap between the
+        # `character` and `character + 1`.
+        #
+        # If the character value is greater than the line length it defaults back to the
+        # line length.
         #
         # @return [number]
         def character

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General paramters to to regsiter for a capability.
+      # General parameters to register for a capability.
       #
       class Registration
         def initialize(id:, method:, register_options: nil)

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

@@ -13,7 +13,7 @@ module LanguageServer
         end
 
         #
-        # The document to format.
+        # The document to rename.
         #
         # @return [TextDocumentIdentifier]
         def text_document

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

@@ -31,7 +31,7 @@ module LanguageServer
         #
         # The method's params.
         #
-        # @return [any]
+        # @return [object | any[]]
         def params
           attributes.fetch(:params)
         end

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       class ServerCapabilities
-        def initialize(text_document_sync: nil, hover_provider: nil, completion_provider: nil, signature_help_provider: nil, definition_provider: nil, references_provider: nil, document_highlight_provider: nil, document_symbol_provider: nil, workspace_symbol_provider: nil, code_action_provider: nil, code_lens_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, document_link_provider: nil, execute_command_provider: nil, experimental: nil)
+        def initialize(text_document_sync: nil, hover_provider: nil, completion_provider: nil, signature_help_provider: nil, definition_provider: nil, type_definition_provider: nil, implementation_provider: nil, references_provider: nil, document_highlight_provider: nil, document_symbol_provider: nil, workspace_symbol_provider: nil, code_action_provider: nil, code_lens_provider: nil, document_formatting_provider: nil, document_range_formatting_provider: nil, document_on_type_formatting_provider: nil, rename_provider: nil, document_link_provider: nil, color_provider: nil, execute_command_provider: nil, workspace: nil, experimental: nil)
           @attributes = {}
 
           @attributes[:textDocumentSync] = text_document_sync if text_document_sync
@@ -10,6 +10,8 @@ module LanguageServer
           @attributes[:completionProvider] = completion_provider if completion_provider
           @attributes[:signatureHelpProvider] = signature_help_provider if signature_help_provider
           @attributes[:definitionProvider] = definition_provider if definition_provider
+          @attributes[:typeDefinitionProvider] = type_definition_provider if type_definition_provider
+          @attributes[:implementationProvider] = implementation_provider if implementation_provider
           @attributes[:referencesProvider] = references_provider if references_provider
           @attributes[:documentHighlightProvider] = document_highlight_provider if document_highlight_provider
           @attributes[:documentSymbolProvider] = document_symbol_provider if document_symbol_provider
@@ -21,7 +23,9 @@ module LanguageServer
           @attributes[:documentOnTypeFormattingProvider] = document_on_type_formatting_provider if document_on_type_formatting_provider
           @attributes[:renameProvider] = rename_provider if rename_provider
           @attributes[:documentLinkProvider] = document_link_provider if document_link_provider
+          @attributes[:colorProvider] = color_provider if color_provider
           @attributes[:executeCommandProvider] = execute_command_provider if execute_command_provider
+          @attributes[:workspace] = workspace if workspace
           @attributes[:experimental] = experimental if experimental
 
           @attributes.freeze
@@ -29,7 +33,7 @@ module LanguageServer
 
         #
         # Defines how text documents are synced. Is either a detailed structure defining each notification or
-        # for backwards compatibility the TextDocumentSyncKind number.
+        # for backwards compatibility the TextDocumentSyncKind number. If omitted it defaults to `TextDocumentSyncKind.None`.
         #
         # @return [number | TextDocumentSyncOptions]
         def text_document_sync
@@ -68,6 +72,26 @@ module LanguageServer
           attributes.fetch(:definitionProvider)
         end
 
+        #
+        # The server provides Goto Type Definition support.
+        #
+        # Since 3.6.0
+        #
+        # @return [boolean | (TextDocumentRegistrationOptions & StaticRegistrationOptions)]
+        def type_definition_provider
+          attributes.fetch(:typeDefinitionProvider)
+        end
+
+        #
+        # The server provides Goto Implementation support.
+        #
+        # Since 3.6.0
+        #
+        # @return [boolean | (TextDocumentRegistrationOptions & StaticRegistrationOptions)]
+        def implementation_provider
+          attributes.fetch(:implementationProvider)
+        end
+
         #
         # The server provides find references support.
         #
@@ -156,6 +180,16 @@ module LanguageServer
           attributes.fetch(:documentLinkProvider)
         end
 
+        #
+        # The server provides color provider support.
+        #
+        # Since 3.6.0
+        #
+        # @return [boolean | ColorProviderOptions | (ColorProviderOptions & TextDocumentRegistrationOptions & Static...]
+        def color_provider
+          attributes.fetch(:colorProvider)
+        end
+
         #
         # The server provides execute command support.
         #
@@ -164,6 +198,14 @@ module LanguageServer
           attributes.fetch(:executeCommandProvider)
         end
 
+        #
+        # Workspace specific server capabilities
+        #
+        # @return [{ workspaceFolders?: { supported?: boolean; changeNotifications?: string | boolean; }; }]
+        def workspace
+          attributes.fetch(:workspace)
+        end
+
         #
         # Experimental server capabilities.
         #

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

@@ -32,7 +32,7 @@ module LanguageServer
         # make an active decision about the active signature and shouldn't
         # rely on a default value.
         # In future version of the protocol this property might become
-        # mandantory to better express this.
+        # mandatory to better express this.
         #
         # @return [number]
         def active_signature
@@ -45,7 +45,7 @@ module LanguageServer
         # defaults to 0 if the active signature has parameters. If
         # the active signature has no parameters it is ignored.
         # In future version of the protocol this property might become
-        # mandantory to better express the active parameter if the
+        # mandatory to better express the active parameter if the
         # active signature does have any.
         #
         # @return [number]

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

@@ -30,7 +30,7 @@ module LanguageServer
         # The human-readable doc-comment of this signature. Will be shown
         # in the UI but can be omitted.
         #
-        # @return [string]
+        # @return [string | MarkupContent]
         def documentation
           attributes.fetch(:documentation)
         end

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

@@ -0,0 +1,37 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Static registration options to be returned in the initialize request.
+      #
+      class StaticRegistrationOptions
+        def initialize(id: nil)
+          @attributes = {}
+
+          @attributes[:id] = id if id
+
+          @attributes.freeze
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string]
+        def id
+          attributes.fetch(:id)
+        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/symbol_information.rb

@@ -6,11 +6,12 @@ module LanguageServer
       # interfaces etc.
       #
       class SymbolInformation
-        def initialize(name:, kind:, location:, container_name: nil)
+        def initialize(name:, kind:, deprecated: nil, location:, container_name: nil)
           @attributes = {}
 
           @attributes[:name] = name
           @attributes[:kind] = kind
+          @attributes[:deprecated] = deprecated if deprecated
           @attributes[:location] = location
           @attributes[:containerName] = container_name if container_name
 
@@ -34,7 +35,23 @@ module LanguageServer
         end
 
         #
-        # The location of this symbol.
+        # Indicates if this symbol is deprecated.
+        #
+        # @return [boolean]
+        def deprecated
+          attributes.fetch(:deprecated)
+        end
+
+        #
+        # The location of this symbol. The location's range is used by a tool
+        # to reveal the location in the editor. If the symbol is selected in the
+        # tool the range's start information is used to position the cursor. So
+        # the range usually spans more then the actual symbol's name and does
+        # normally include things like visibility modifiers.
+        #
+        # The range doesn't have to denote a node range in the sense of a abstract
+        # syntax tree. It can therefore not be used to re-construct a hierarchy of
+        # the symbols.
         #
         # @return [Location]
         def location
@@ -42,7 +59,10 @@ module LanguageServer
         end
 
         #
-        # The name of the symbol containing this symbol.
+        # The name of the symbol containing this symbol. This information is for
+        # user interface purposes (e.g. to render a qualifier in the user interface
+        # if necessary). It can't be used to re-infer a hierarchy for the document
+        # symbols.
         #
         # @return [string]
         def container_name

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Descibe options to be used when registered for text document change events.
+      # Describe options to be used when registering for text document change events.
       #
       class TextDocumentChangeRegistrationOptions < TextDocumentRegistrationOptions
         def initialize(document_selector:, sync_kind:)
@@ -15,7 +15,7 @@ module LanguageServer
 
         #
         # How documents are synced to the server. See TextDocumentSyncKind.Full
-        # and TextDocumentSyncKindIncremental.
+        # and TextDocumentSyncKind.Incremental.
         #
         # @return [number]
         def sync_kind

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

@@ -5,7 +5,7 @@ module LanguageServer
       # Text document specific client capabilities.
       #
       class TextDocumentClientCapabilities
-        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, references: nil, document_highlight: nil, document_symbol: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, definition: nil, code_action: nil, code_lens: nil, document_link: nil, rename: nil)
+        def initialize(synchronization: nil, completion: nil, hover: nil, signature_help: nil, references: nil, document_highlight: nil, document_symbol: nil, formatting: nil, range_formatting: nil, on_type_formatting: nil, definition: nil, type_definition: nil, implementation: nil, code_action: nil, code_lens: nil, document_link: nil, color_provider: nil, rename: nil, publish_diagnostics: nil)
           @attributes = {}
 
           @attributes[:synchronization] = synchronization if synchronization
@@ -19,10 +19,14 @@ module LanguageServer
           @attributes[:rangeFormatting] = range_formatting if range_formatting
           @attributes[:onTypeFormatting] = on_type_formatting if on_type_formatting
           @attributes[:definition] = definition if definition
+          @attributes[:typeDefinition] = type_definition if type_definition
+          @attributes[:implementation] = implementation if implementation
           @attributes[:codeAction] = code_action if code_action
           @attributes[:codeLens] = code_lens if code_lens
           @attributes[:documentLink] = document_link if document_link
+          @attributes[:colorProvider] = color_provider if color_provider
           @attributes[:rename] = rename if rename
+          @attributes[:publishDiagnostics] = publish_diagnostics if publish_diagnostics
 
           @attributes.freeze
         end
@@ -35,7 +39,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/completion`
         #
-        # @return [{ dynamicRegistration?: boolean; completionItem?: { snippetSupport?: boolean; }; }]
+        # @return [{ dynamicRegistration?: boolean; completionItem?: { snippetSupport?: boolean; commitCharactersSup...]
         def completion
           attributes.fetch(:completion)
         end
@@ -43,7 +47,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/hover`
         #
-        # @return [{ dynamicRegistration?: boolean; }]
+        # @return [{ dynamicRegistration?: boolean; contentFormat?: MarkupKind[]; }]
         def hover
           attributes.fetch(:hover)
         end
@@ -51,7 +55,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/signatureHelp`
         #
-        # @return [{ dynamicRegistration?: boolean; }]
+        # @return [{ dynamicRegistration?: boolean; signatureInformation?: { documentationFormat?: MarkupKind[]; }; }]
         def signature_help
           attributes.fetch(:signatureHelp)
         end
@@ -75,7 +79,7 @@ module LanguageServer
         #
         # Capabilities specific to the `textDocument/documentSymbol`
         #
-        # @return [{ dynamicRegistration?: boolean; }]
+        # @return [{ dynamicRegistration?: boolean; symbolKind?: { valueSet?: any[]; }; }]
         def document_symbol
           attributes.fetch(:documentSymbol)
         end
@@ -112,6 +116,26 @@ module LanguageServer
           attributes.fetch(:definition)
         end
 
+        #
+        # Capabilities specific to the `textDocument/typeDefinition`
+        #
+        # Since 3.6.0
+        #
+        # @return [{ dynamicRegistration?: boolean; }]
+        def type_definition
+          attributes.fetch(:typeDefinition)
+        end
+
+        #
+        # Capabilities specific to the `textDocument/implementation`.
+        #
+        # Since 3.6.0
+        #
+        # @return [{ dynamicRegistration?: boolean; }]
+        def implementation
+          attributes.fetch(:implementation)
+        end
+
         #
         # Capabilities specific to the `textDocument/codeAction`
         #
@@ -136,6 +160,17 @@ module LanguageServer
           attributes.fetch(:documentLink)
         end
 
+        #
+        # Capabilities specific to the `textDocument/documentColor` and the
+        # `textDocument/colorPresentation` request.
+        #
+        # Since 3.6.0
+        #
+        # @return [{ dynamicRegistration?: boolean; }]
+        def color_provider
+          attributes.fetch(:colorProvider)
+        end
+
         #
         # Capabilities specific to the `textDocument/rename`
         #
@@ -144,6 +179,14 @@ module LanguageServer
           attributes.fetch(:rename)
         end
 
+        #
+        # Capabilities specific to `textDocument/publishDiagnostics`.
+        #
+        # @return [{ relatedInformation?: boolean; }]
+        def publish_diagnostics
+          attributes.fetch(:publishDiagnostics)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -30,7 +30,7 @@ module LanguageServer
         end
 
         #
-        # The version number of this document (it will strictly increase after each
+        # The version number of this document (it will increase after each
         # change, including undo/redo).
         #
         # @return [number]

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

@@ -23,8 +23,8 @@ module LanguageServer
         end
 
         #
-        # Change notificatins are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
-        # and TextDocumentSyncKindIncremental.
+        # Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
+        # and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
         #
         # @return [number]
         def change

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

@@ -11,7 +11,11 @@ module LanguageServer
         end
 
         #
-        # The version number of this document.
+        # The version number of this document. If a versioned text document identifier
+        # is sent from the server to the client and the file is not open in the editor
+        # (the server has not received an open notification before) the server can send
+        # `null` to indicate that the version is known and the content on disk is the
+        # truth (as speced with document content ownership)
         #
         # @return [number]
         def version

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

@@ -0,0 +1,104 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Workspace specific client capabilities.
+      #
+      class WorkspaceClientCapabilities
+        def initialize(apply_edit: nil, workspace_edit: nil, did_change_configuration: nil, did_change_watched_files: nil, symbol: nil, execute_command: nil, workspace_folders: nil, configuration: nil)
+          @attributes = {}
+
+          @attributes[:applyEdit] = apply_edit if apply_edit
+          @attributes[:workspaceEdit] = workspace_edit if workspace_edit
+          @attributes[:didChangeConfiguration] = did_change_configuration if did_change_configuration
+          @attributes[:didChangeWatchedFiles] = did_change_watched_files if did_change_watched_files
+          @attributes[:symbol] = symbol if symbol
+          @attributes[:executeCommand] = execute_command if execute_command
+          @attributes[:workspaceFolders] = workspace_folders if workspace_folders
+          @attributes[:configuration] = configuration if configuration
+
+          @attributes.freeze
+        end
+
+        #
+        # The client supports applying batch edits to the workspace by supporting
+        # the request 'workspace/applyEdit'
+        #
+        # @return [boolean]
+        def apply_edit
+          attributes.fetch(:applyEdit)
+        end
+
+        #
+        # Capabilities specific to `WorkspaceEdit`s
+        #
+        # @return [{ documentChanges?: boolean; }]
+        def workspace_edit
+          attributes.fetch(:workspaceEdit)
+        end
+
+        #
+        # Capabilities specific to the `workspace/didChangeConfiguration` notification.
+        #
+        # @return [{ dynamicRegistration?: boolean; }]
+        def did_change_configuration
+          attributes.fetch(:didChangeConfiguration)
+        end
+
+        #
+        # Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
+        #
+        # @return [{ dynamicRegistration?: boolean; }]
+        def did_change_watched_files
+          attributes.fetch(:didChangeWatchedFiles)
+        end
+
+        #
+        # Capabilities specific to the `workspace/symbol` request.
+        #
+        # @return [{ dynamicRegistration?: boolean; symbolKind?: { valueSet?: any[]; }; }]
+        def symbol
+          attributes.fetch(:symbol)
+        end
+
+        #
+        # Capabilities specific to the `workspace/executeCommand` request.
+        #
+        # @return [{ dynamicRegistration?: boolean; }]
+        def execute_command
+          attributes.fetch(:executeCommand)
+        end
+
+        #
+        # The client has support for workspace folders.
+        #
+        # Since 3.6.0
+        #
+        # @return [boolean]
+        def workspace_folders
+          attributes.fetch(:workspaceFolders)
+        end
+
+        #
+        # The client supports `workspace/configuration` requests.
+        #
+        # Since 3.6.0
+        #
+        # @return [boolean]
+        def configuration
+          attributes.fetch(:configuration)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end