language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -1,6 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A range in a text document expressed as (zero-based) start and end positions.
+      #
+      # If you want to specify a range that contains a line including the line ending
+      # character(s) then use an end position denoting the start of the next line.
+      # For example:
+      # ```ts
+      # {
+      #     start: { line: 5, character: 23 }
+      #     end : { line 6, character : 0 }
+      # }
+      # ```
+      #
       class Range
         def initialize(start:, end:)
           @attributes = {}

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client Capabilities for a {@link ReferencesRequest}.
+      #
       class ReferenceClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Value-object that contains additional information when
+      # requesting references.
+      #
       class ReferenceContext
         def initialize(include_declaration:)
           @attributes = {}

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

@@ -1,11 +1,14 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Reference options.
+      #
       class ReferenceOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

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

@@ -1,19 +1,27 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Parameters for a {@link ReferencesRequest}.
+      #
       class ReferenceParams
-        def initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil, context:)
+        def initialize(context:, text_document:, position:, work_done_token: nil, partial_result_token: nil)
           @attributes = {}
 
+          @attributes[:context] = context
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
-          @attributes[:context] = context
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end
 
+        # @return [ReferenceContext]
+        def context
+          attributes.fetch(:context)
+        end
+
         #
         # The text document.
         #
@@ -39,19 +47,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
 
-        # @return [ReferenceContext]
-        def context
-          attributes.fetch(:context)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,21 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link ReferencesRequest}.
+      #
       class ReferenceRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
         #
-        # A document selector to identify the scope of the registration. If set to
-        # null the document selector provided on the client side will be used.
+        # A document selector to identify the scope of the registration. If set to null
+        # the document selector provided on the client side will be used.
         #
-        # @return [DocumentSelector]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # General parameters to register for a capability.
+      # General parameters to register for a notification or to register a provider.
       #
       class Registration
         def initialize(id:, method:, register_options: nil)
@@ -10,7 +10,7 @@ module LanguageServer
 
           @attributes[:id] = id
           @attributes[:method] = method
-          @attributes[:registerOptions] = register_options if register_options
+          @attributes[:registerOptions] = register_options unless register_options.nil?
 
           @attributes.freeze
         end

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

@@ -4,12 +4,14 @@ module LanguageServer
       #
       # Client capabilities specific to regular expressions.
       #
+      # @since 3.16.0
+      #
       class RegularExpressionsClientCapabilities
         def initialize(engine:, version: nil)
           @attributes = {}
 
           @attributes[:engine] = engine
-          @attributes[:version] = version if version
+          @attributes[:version] = version unless version.nil?
 
           @attributes.freeze
         end
@@ -17,7 +19,7 @@ module LanguageServer
         #
         # The engine's name.
         #
-        # @return [string]
+        # @return [RegularExpressionEngineKind]
         def engine
           attributes.fetch(:engine)
         end

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

@@ -4,22 +4,38 @@ module LanguageServer
       #
       # A full diagnostic report with a set of related documents.
       #
+      # @since 3.17.0
+      #
       class RelatedFullDocumentDiagnosticReport
-        def initialize(kind:, result_id: nil, items:, related_documents: nil)
+        def initialize(related_documents: nil, kind:, result_id: nil, items:)
           @attributes = {}
 
+          @attributes[:relatedDocuments] = related_documents unless related_documents.nil?
           @attributes[:kind] = kind
-          @attributes[:resultId] = result_id if result_id
+          @attributes[:resultId] = result_id unless result_id.nil?
           @attributes[:items] = items
-          @attributes[:relatedDocuments] = related_documents if related_documents
 
           @attributes.freeze
         end
 
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @since 3.17.0
+        #
+        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        end
+
         #
         # A full document diagnostic report.
         #
-        # @return [any]
+        # @return ["full"]
         def kind
           attributes.fetch(:kind)
         end
@@ -42,18 +58,6 @@ module LanguageServer
           attributes.fetch(:items)
         end
 
-        #
-        # Diagnostics of related documents. This information is useful
-        # in programming languages where code in a file A can generate
-        # diagnostics in a file B which A depends on. An example of
-        # such a language is C/C++ where marco definitions in a file
-        # a.cpp and result in errors in a header file b.hpp.
-        #
-        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
-        def related_documents
-          attributes.fetch(:relatedDocuments)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,24 +4,40 @@ module LanguageServer
       #
       # An unchanged diagnostic report with a set of related documents.
       #
+      # @since 3.17.0
+      #
       class RelatedUnchangedDocumentDiagnosticReport
-        def initialize(kind:, result_id:, related_documents: nil)
+        def initialize(related_documents: nil, kind:, result_id:)
           @attributes = {}
 
+          @attributes[:relatedDocuments] = related_documents unless related_documents.nil?
           @attributes[:kind] = kind
           @attributes[:resultId] = result_id
-          @attributes[:relatedDocuments] = related_documents if related_documents
 
           @attributes.freeze
         end
 
+        #
+        # Diagnostics of related documents. This information is useful
+        # in programming languages where code in a file A can generate
+        # diagnostics in a file B which A depends on. An example of
+        # such a language is C/C++ where marco definitions in a file
+        # a.cpp and result in errors in a header file b.hpp.
+        #
+        # @since 3.17.0
+        #
+        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport]
+        def related_documents
+          attributes.fetch(:relatedDocuments)
+        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
@@ -35,18 +51,6 @@ module LanguageServer
           attributes.fetch(:resultId)
         end
 
-        #
-        # Diagnostics of related documents. This information is useful
-        # in programming languages where code in a file A can generate
-        # diagnostics in a file B which A depends on. An example of
-        # such a language is C/C++ where marco definitions in a file
-        # a.cpp and result in errors in a header file b.hpp.
-        #
-        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
-        def related_documents
-          attributes.fetch(:relatedDocuments)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -6,6 +6,8 @@ module LanguageServer
       # relatively to a base URI. The common value for a `baseUri` is a workspace
       # folder root, but it can be another absolute URI as well.
       #
+      # @since 3.17.0
+      #
       class RelativePattern
         def initialize(base_uri:, pattern:)
           @attributes = {}
@@ -20,7 +22,7 @@ module LanguageServer
         # A workspace folder or a base URI to which this pattern will be matched
         # against relatively.
         #
-        # @return [string | WorkspaceFolder]
+        # @return [WorkspaceFolder | URI]
         def base_uri
           attributes.fetch(:baseUri)
         end
@@ -28,7 +30,7 @@ module LanguageServer
         #
         # The actual glob pattern;
         #
-        # @return [string]
+        # @return [Pattern]
         def pattern
           attributes.fetch(:pattern)
         end

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

@@ -5,10 +5,10 @@ module LanguageServer
         def initialize(dynamic_registration: nil, prepare_support: nil, prepare_support_default_behavior: nil, honors_change_annotations: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:prepareSupport] = prepare_support if prepare_support
-          @attributes[:prepareSupportDefaultBehavior] = prepare_support_default_behavior if prepare_support_default_behavior
-          @attributes[:honorsChangeAnnotations] = honors_change_annotations if honors_change_annotations
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:prepareSupport] = prepare_support unless prepare_support.nil?
+          @attributes[:prepareSupportDefaultBehavior] = prepare_support_default_behavior unless prepare_support_default_behavior.nil?
+          @attributes[:honorsChangeAnnotations] = honors_change_annotations unless honors_change_annotations.nil?
 
           @attributes.freeze
         end
@@ -25,19 +25,22 @@ module LanguageServer
         # Client supports testing for validity of rename operations
         # before execution.
         #
+        # @since 3.12.0
+        #
         # @return [boolean]
         def prepare_support
           attributes.fetch(:prepareSupport)
         end
 
         #
-        # Client supports the default behavior result
-        # (`{ defaultBehavior: boolean }`).
+        # Client supports the default behavior result.
         #
         # The value indicates the default behavior used by the
         # client.
         #
-        # @return [1]
+        # @since 3.16.0
+        #
+        # @return [PrepareSupportDefaultBehavior]
         def prepare_support_default_behavior
           attributes.fetch(:prepareSupportDefaultBehavior)
         end
@@ -49,6 +52,8 @@ module LanguageServer
         # the workspace edit in the user interface and asking
         # for confirmation.
         #
+        # @since 3.16.0
+        #
         # @return [boolean]
         def honors_change_annotations
           attributes.fetch(:honorsChangeAnnotations)

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes[:kind] = kind
           @attributes[:oldUri] = old_uri
           @attributes[:newUri] = new_uri
-          @attributes[:options] = options if options
-          @attributes[:annotationId] = annotation_id if annotation_id
+          @attributes[:options] = options unless options.nil?
+          @attributes[:annotationId] = annotation_id unless annotation_id.nil?
 
           @attributes.freeze
         end
@@ -28,7 +28,7 @@ module LanguageServer
         #
         # The old (existing) location.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def old_uri
           attributes.fetch(:oldUri)
         end
@@ -36,7 +36,7 @@ module LanguageServer
         #
         # The new location.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def new_uri
           attributes.fetch(:newUri)
         end
@@ -52,7 +52,9 @@ module LanguageServer
         #
         # An optional annotation identifier describing the operation.
         #
-        # @return [string]
+        # @since 3.16.0
+        #
+        # @return [ChangeAnnotationIdentifier]
         def annotation_id
           attributes.fetch(:annotationId)
         end

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

@@ -8,8 +8,8 @@ module LanguageServer
         def initialize(overwrite: nil, ignore_if_exists: nil)
           @attributes = {}
 
-          @attributes[:overwrite] = overwrite if overwrite
-          @attributes[:ignoreIfExists] = ignore_if_exists if ignore_if_exists
+          @attributes[:overwrite] = overwrite unless overwrite.nil?
+          @attributes[:ignoreIfExists] = ignore_if_exists unless ignore_if_exists.nil?
 
           @attributes.freeze
         end

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

@@ -2,8 +2,10 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # The parameters sent in notifications/requests for user-initiated renames
-      # of files.
+      # The parameters sent in notifications/requests for user-initiated renames of
+      # files.
+      #
+      # @since 3.16.0
       #
       class RenameFilesParams
         def initialize(files:)
@@ -15,8 +17,8 @@ module LanguageServer
         end
 
         #
-        # An array of all files/folders renamed in this operation. When a folder
-        # is renamed, only the folder will be included, and not its children.
+        # An array of all files/folders renamed in this operation. When a folder is renamed, only
+        # the folder will be included, and not its children.
         #
         # @return [FileRename[]]
         def files

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

@@ -1,29 +1,34 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Provider options for a {@link RenameRequest}.
+      #
       class RenameOptions
-        def initialize(work_done_progress: nil, prepare_provider: nil)
+        def initialize(prepare_provider: nil, work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:prepareProvider] = prepare_provider if prepare_provider
+          @attributes[:prepareProvider] = prepare_provider unless prepare_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
-
         #
         # Renames should be checked and tested before being executed.
         #
+        # @since version 3.12.0
+        #
         # @return [boolean]
         def prepare_provider
           attributes.fetch(:prepareProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -1,18 +1,31 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # The parameters of a {@link RenameRequest}.
+      #
       class RenameParams
-        def initialize(text_document:, position:, work_done_token: nil, new_name:)
+        def initialize(new_name:, text_document:, position:, work_done_token: nil)
           @attributes = {}
 
+          @attributes[:newName] = new_name
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:newName] = new_name
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end
 
+        #
+        # The new name of the symbol. If the given name is not valid the
+        # request must return a {@link ResponseError} with an
+        # appropriate message set.
+        #
+        # @return [string]
+        def new_name
+          attributes.fetch(:newName)
+        end
+
         #
         # The text document.
         #
@@ -37,16 +50,6 @@ module LanguageServer
           attributes.fetch(:workDoneToken)
         end
 
-        #
-        # The new name of the symbol. If the given name is not valid the
-        # request must return a [ResponseError](#ResponseError) with an
-        # appropriate message set.
-        #
-        # @return [string]
-        def new_name
-          attributes.fetch(:newName)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,39 +1,44 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Registration options for a {@link RenameRequest}.
+      #
       class RenameRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, prepare_provider: nil)
+        def initialize(document_selector:, prepare_provider: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:prepareProvider] = prepare_provider if prepare_provider
+          @attributes[:prepareProvider] = prepare_provider unless prepare_provider.nil?
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end
 
         #
-        # A document selector to identify the scope of the registration. If set to
-        # null the document selector provided on the client side will be used.
+        # A document selector to identify the scope of the registration. If set to null
+        # the document selector provided on the client side will be used.
         #
-        # @return [DocumentSelector]
+        # @return [DocumentSelector | nil]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # Renames should be checked and tested before being executed.
         #
+        # @since version 3.12.0
+        #
         # @return [boolean]
         def prepare_provider
           attributes.fetch(:prepareProvider)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -8,7 +8,7 @@ module LanguageServer
           @attributes[:jsonrpc] = jsonrpc
           @attributes[:id] = id
           @attributes[:method] = method
-          @attributes[:params] = params if params
+          @attributes[:params] = params unless params.nil?
 
           @attributes.freeze
         end