language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -4,23 +4,42 @@ module LanguageServer
       #
       # A full document diagnostic report for a workspace diagnostic result.
       #
+      # @since 3.17.0
+      #
       class WorkspaceFullDocumentDiagnosticReport
-        def initialize(kind:, result_id: nil, items:, uri:, version:)
+        def initialize(uri:, version:, kind:, result_id: nil, items:)
           @attributes = {}
 
-          @attributes[:kind] = kind
-          @attributes[:resultId] = result_id if result_id
-          @attributes[:items] = items
           @attributes[:uri] = uri
           @attributes[:version] = version
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id unless result_id.nil?
+          @attributes[:items] = items
 
           @attributes.freeze
         end
 
+        #
+        # The URI for which diagnostic information is reported.
+        #
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The version number for which the diagnostics are reported.
+        # If the document is not marked as open `null` can be provided.
+        #
+        # @return [integer | nil]
+        def version
+          attributes.fetch(:version)
+        end
+
         #
         # A full document diagnostic report.
         #
-        # @return [any]
+        # @return ["full"]
         def kind
           attributes.fetch(:kind)
         end
@@ -43,23 +62,6 @@ module LanguageServer
           attributes.fetch(:items)
         end
 
-        #
-        # The URI for which diagnostic information is reported.
-        #
-        # @return [string]
-        def uri
-          attributes.fetch(:uri)
-        end
-
-        #
-        # The version number for which the diagnostics are reported.
-        # If the document is not marked as open `null` can be provided.
-        #
-        # @return [number]
-        def version
-          attributes.fetch(:version)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,62 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Defines workspace specific capabilities of the server.
+      #
+      # @since 3.18.0
+      #
+      class WorkspaceOptions
+        def initialize(workspace_folders: nil, file_operations: nil, text_document_content: nil)
+          @attributes = {}
+
+          @attributes[:workspaceFolders] = workspace_folders unless workspace_folders.nil?
+          @attributes[:fileOperations] = file_operations unless file_operations.nil?
+          @attributes[:textDocumentContent] = text_document_content unless text_document_content.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The server supports workspace folder.
+        #
+        # @since 3.6.0
+        #
+        # @return [WorkspaceFoldersServerCapabilities]
+        def workspace_folders
+          attributes.fetch(:workspaceFolders)
+        end
+
+        #
+        # The server is interested in notifications/requests for operations on files.
+        #
+        # @since 3.16.0
+        #
+        # @return [FileOperationOptions]
+        def file_operations
+          attributes.fetch(:fileOperations)
+        end
+
+        #
+        # The server supports the `workspace/textDocumentContent` request.
+        #
+        # @since 3.18.0
+        #
+        # @return [TextDocumentContentOptions | TextDocumentContentRegistrationOptions]
+        def text_document_content
+          attributes.fetch(:textDocumentContent)
+        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/workspace_symbol.rb

@@ -2,22 +2,47 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A special workspace symbol that supports locations without a range
+      # A special workspace symbol that supports locations without a range.
+      #
+      # See also SymbolInformation.
+      #
+      # @since 3.17.0
       #
       class WorkspaceSymbol
-        def initialize(name:, kind:, tags: nil, container_name: nil, location:, data: nil)
+        def initialize(location:, data: nil, name:, kind:, tags: nil, container_name: nil)
           @attributes = {}
 
+          @attributes[:location] = location
+          @attributes[:data] = data unless data.nil?
           @attributes[:name] = name
           @attributes[:kind] = kind
-          @attributes[:tags] = tags if tags
-          @attributes[:containerName] = container_name if container_name
-          @attributes[:location] = location
-          @attributes[:data] = data if data
+          @attributes[:tags] = tags unless tags.nil?
+          @attributes[:containerName] = container_name unless container_name.nil?
 
           @attributes.freeze
         end
 
+        #
+        # The location of the symbol. Whether a server is allowed to
+        # return a location without a range depends on the client
+        # capability `workspace.symbol.resolveSupport`.
+        #
+        # See SymbolInformation#location for more details.
+        #
+        # @return [Location | LocationUriOnly]
+        def location
+          attributes.fetch(:location)
+        end
+
+        #
+        # A data entry field that is preserved on a workspace symbol between a
+        # workspace symbol request and a workspace symbol resolve request.
+        #
+        # @return [LSPAny]
+        def data
+          attributes.fetch(:data)
+        end
+
         #
         # The name of this symbol.
         #
@@ -35,9 +60,11 @@ module LanguageServer
         end
 
         #
-        # Tags for this completion item.
+        # Tags for this symbol.
+        #
+        # @since 3.16.0
         #
-        # @return [1[]]
+        # @return [SymbolTag[]]
         def tags
           attributes.fetch(:tags)
         end
@@ -53,27 +80,6 @@ module LanguageServer
           attributes.fetch(:containerName)
         end
 
-        #
-        # The location of this symbol. Whether a server is allowed to
-        # return a location without a range depends on the client
-        # capability `workspace.symbol.resolveSupport`.
-        #
-        # See also `SymbolInformation.location`.
-        #
-        # @return [Location | { uri: string; }]
-        def location
-          attributes.fetch(:location)
-        end
-
-        #
-        # A data entry field that is preserved on a workspace symbol between a
-        # workspace symbol request and a workspace symbol resolve request.
-        #
-        # @return [LSPAny]
-        def data
-          attributes.fetch(:data)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,14 +1,17 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities for a {@link WorkspaceSymbolRequest}.
+      #
       class WorkspaceSymbolClientCapabilities
         def initialize(dynamic_registration: nil, symbol_kind: nil, tag_support: nil, resolve_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:symbolKind] = symbol_kind if symbol_kind
-          @attributes[:tagSupport] = tag_support if tag_support
-          @attributes[:resolveSupport] = resolve_support if resolve_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:symbolKind] = symbol_kind unless symbol_kind.nil?
+          @attributes[:tagSupport] = tag_support unless tag_support.nil?
+          @attributes[:resolveSupport] = resolve_support unless resolve_support.nil?
 
           @attributes.freeze
         end
@@ -22,19 +25,20 @@ module LanguageServer
         end
 
         #
-        # Specific capabilities for the `SymbolKind` in the `workspace/symbol`
-        # request.
+        # Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
         #
-        # @return [{ valueSet?: SymbolKind[]; }]
+        # @return [ClientSymbolKindOptions]
         def symbol_kind
           attributes.fetch(:symbolKind)
         end
 
         #
-        # The client supports tags on `SymbolInformation` and `WorkspaceSymbol`.
+        # The client supports tags on `SymbolInformation`.
         # Clients supporting tags have to handle unknown tags gracefully.
         #
-        # @return [{ valueSet: 1[]; }]
+        # @since 3.16.0
+        #
+        # @return [ClientSymbolTagOptions]
         def tag_support
           attributes.fetch(:tagSupport)
         end
@@ -44,7 +48,9 @@ module LanguageServer
         # request `workspaceSymbol/resolve` to the server to resolve additional
         # properties.
         #
-        # @return [{ properties: string[]; }]
+        # @since 3.17.0
+        #
+        # @return [ClientSymbolResolveOptions]
         def resolve_support
           attributes.fetch(:resolveSupport)
         end

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

@@ -1,30 +1,35 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Server capabilities for a {@link WorkspaceSymbolRequest}.
+      #
       class WorkspaceSymbolOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The server provides support to resolve additional
         # information for a workspace symbol.
         #
+        # @since 3.17.0
+        #
         # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,19 +2,34 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters of a Workspace Symbol Request.
+      # The parameters of a {@link WorkspaceSymbolRequest}.
       #
       class WorkspaceSymbolParams
-        def initialize(work_done_token: nil, partial_result_token: nil, query:)
+        def initialize(query:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:query] = query
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
 
+        #
+        # A query string to filter symbols by. Clients may send an empty
+        # string here to request all symbols.
+        #
+        # The `query`-parameter should be interpreted in a *relaxed way* as editors
+        # will apply their own highlighting and scoring on the results. A good rule
+        # of thumb is to match case-insensitive and to simply check that the
+        # characters of *query* appear in their order in a candidate symbol.
+        # Servers shouldn't use prefix, substring, or similar strict matching.
+        #
+        # @return [string]
+        def query
+          attributes.fetch(:query)
+        end
+
         #
         # An optional token that a server can use to report work done progress.
         #
@@ -24,23 +39,14 @@ module LanguageServer
         end
 
         #
-        # An optional token that a server can use to report partial results (e.g.
-        # streaming) to the client.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
         # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
-        #
-        # A query string to filter symbols by. Clients may send an empty
-        # string here to request all symbols.
-        #
-        # @return [string]
-        def query
-          attributes.fetch(:query)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,30 +1,35 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link WorkspaceSymbolRequest}.
+      #
       class WorkspaceSymbolRegistrationOptions
-        def initialize(work_done_progress: nil, resolve_provider: nil)
+        def initialize(resolve_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:resolveProvider] = resolve_provider if resolve_provider
+          @attributes[:resolveProvider] = resolve_provider unless resolve_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The server provides support to resolve additional
         # information for a workspace symbol.
         #
+        # @since 3.17.0
+        #
         # @return [boolean]
         def resolve_provider
           attributes.fetch(:resolveProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,25 +4,44 @@ module LanguageServer
       #
       # An unchanged document diagnostic report for a workspace diagnostic result.
       #
+      # @since 3.17.0
+      #
       class WorkspaceUnchangedDocumentDiagnosticReport
-        def initialize(kind:, result_id:, uri:, version:)
+        def initialize(uri:, version:, kind:, result_id:)
           @attributes = {}
 
-          @attributes[:kind] = kind
-          @attributes[:resultId] = result_id
           @attributes[:uri] = uri
           @attributes[:version] = version
+          @attributes[:kind] = kind
+          @attributes[:resultId] = result_id
 
           @attributes.freeze
         end
 
+        #
+        # The URI for which diagnostic information is reported.
+        #
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The version number for which the diagnostics are reported.
+        # If the document is not marked as open `null` can be provided.
+        #
+        # @return [integer | nil]
+        def version
+          attributes.fetch(:version)
+        end
+
         #
         # A document diagnostic report indicating
         # no changes to the last result. A server can
         # only return `unchanged` if result ids are
         # provided.
         #
-        # @return [any]
+        # @return ["unchanged"]
         def kind
           attributes.fetch(:kind)
         end
@@ -36,23 +55,6 @@ module LanguageServer
           attributes.fetch(:resultId)
         end
 
-        #
-        # The URI for which diagnostic information is reported.
-        #
-        # @return [string]
-        def uri
-          attributes.fetch(:uri)
-        end
-
-        #
-        # The version number for which the diagnostics are reported.
-        # If the document is not marked as open `null` can be provided.
-        #
-        # @return [number]
-        def version
-          attributes.fetch(:version)
-        end
-
         attr_reader :attributes
 
         def to_hash