language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

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

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Parameters for the `workspace/textDocumentContent/refresh` request.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentRefreshParams
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # The uri of the text document to refresh.
+        #
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
+        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/text_document_content_registration_options.rb

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Text document content provider registration options.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentRegistrationOptions
+        def initialize(schemes:, id: nil)
+          @attributes = {}
+
+          @attributes[:schemes] = schemes
+          @attributes[:id] = id unless id.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The schemes for which the server provides content.
+        #
+        # @return [string[]]
+        def schemes
+          attributes.fetch(:schemes)
+        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/text_document_content_result.rb

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Result of the `workspace/textDocumentContent` request.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentContentResult
+        def initialize(text:)
+          @attributes = {}
+
+          @attributes[:text] = text
+
+          @attributes.freeze
+        end
+
+        #
+        # The text content of the text document. Please note, that the content of
+        # any subsequent open notifications for the text document might differ
+        # from the returned content due to whitespace and line ending
+        # normalizations done on the client
+        #
+        # @return [string]
+        def text
+          attributes.fetch(:text)
+        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/text_document_edit.rb

@@ -1,6 +1,12 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Describes textual changes on a text document. A TextDocumentEdit describes all changes
+      # on a document version Si and after they are applied move the document to version Si+1.
+      # So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any
+      # kind of ordering. However the edits must be non overlapping.
+      #
       class TextDocumentEdit
         def initialize(text_document:, edits:)
           @attributes = {}
@@ -22,7 +28,13 @@ module LanguageServer
         #
         # The edits to be applied.
         #
-        # @return [(TextEdit | AnnotatedTextEdit)[]]
+        # @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
+        # client capability.
+        #
+        # @since 3.18.0 - support for SnippetTextEdit. This is guarded using a
+        # client capability.
+        #
+        # @return [TextEdit | AnnotatedTextEdit | SnippetTextEdit[]]
         def edits
           attributes.fetch(:edits)
         end

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

@@ -0,0 +1,73 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A document filter denotes a document by different properties like
+      # the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
+      # its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
+      #
+      # Glob patterns can have the following syntax:
+      # - `*` to match zero or more characters in a path segment
+      # - `?` to match on one character in a path segment
+      # - `**` to match any number of path segments, including none
+      # - `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+      # - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+      # - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+      #
+      # @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
+      # @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
+      #
+      # @since 3.17.0
+      #
+      class TextDocumentFilter
+        def initialize(language: nil, scheme: nil, pattern: nil)
+          @attributes = {}
+
+          @attributes[:language] = language unless language.nil?
+          @attributes[:scheme] = scheme unless scheme.nil?
+          @attributes[:pattern] = pattern unless pattern.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # A language id, like `typescript`.
+        #
+        # @return [string]
+        def language
+          attributes.fetch(:language)
+        end
+
+        #
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
+        #
+        # @since 3.18.0 - support for relative patterns. Whether clients support
+        # relative patterns depends on the client capability
+        # `textDocuments.filters.relativePatternSupport`.
+        #
+        # @return [GlobPattern]
+        def pattern
+          attributes.fetch(:pattern)
+        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/text_document_filter_client_capabilities.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class TextDocumentFilterClientCapabilities
+        def initialize(relative_pattern_support: nil)
+          @attributes = {}
+
+          @attributes[:relativePatternSupport] = relative_pattern_support unless relative_pattern_support.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The client supports Relative Patterns.
+        #
+        # @since 3.18.0
+        #
+        # @return [boolean]
+        def relative_pattern_support
+          attributes.fetch(:relativePatternSupport)
+        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/text_document_filter_language.rb

@@ -0,0 +1,60 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A document filter where `language` is required field.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentFilterLanguage
+        def initialize(language:, scheme: nil, pattern: nil)
+          @attributes = {}
+
+          @attributes[:language] = language
+          @attributes[:scheme] = scheme unless scheme.nil?
+          @attributes[:pattern] = pattern unless pattern.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # A language id, like `typescript`.
+        #
+        # @return [string]
+        def language
+          attributes.fetch(:language)
+        end
+
+        #
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
+        #
+        # @since 3.18.0 - support for relative patterns. Whether clients support
+        # relative patterns depends on the client capability
+        # `textDocuments.filters.relativePatternSupport`.
+        #
+        # @return [GlobPattern]
+        def pattern
+          attributes.fetch(:pattern)
+        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/text_document_filter_pattern.rb

@@ -0,0 +1,60 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A document filter where `pattern` is required field.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentFilterPattern
+        def initialize(language: nil, scheme: nil, pattern:)
+          @attributes = {}
+
+          @attributes[:language] = language unless language.nil?
+          @attributes[:scheme] = scheme unless scheme.nil?
+          @attributes[:pattern] = pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # A language id, like `typescript`.
+        #
+        # @return [string]
+        def language
+          attributes.fetch(:language)
+        end
+
+        #
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
+        #
+        # @since 3.18.0 - support for relative patterns. Whether clients support
+        # relative patterns depends on the client capability
+        # `textDocuments.filters.relativePatternSupport`.
+        #
+        # @return [GlobPattern]
+        def pattern
+          attributes.fetch(:pattern)
+        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/text_document_filter_scheme.rb

@@ -0,0 +1,60 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A document filter where `scheme` is required field.
+      #
+      # @since 3.18.0
+      #
+      class TextDocumentFilterScheme
+        def initialize(language: nil, scheme:, pattern: nil)
+          @attributes = {}
+
+          @attributes[:language] = language unless language.nil?
+          @attributes[:scheme] = scheme
+          @attributes[:pattern] = pattern unless pattern.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # A language id, like `typescript`.
+        #
+        # @return [string]
+        def language
+          attributes.fetch(:language)
+        end
+
+        #
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
+        #
+        # @since 3.18.0 - support for relative patterns. Whether clients support
+        # relative patterns depends on the client capability
+        # `textDocuments.filters.relativePatternSupport`.
+        #
+        # @return [GlobPattern]
+        def pattern
+          attributes.fetch(:pattern)
+        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/text_document_identifier.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A literal to identify a text document in the client.
+      #
       class TextDocumentIdentifier
         def initialize(uri:)
           @attributes = {}
@@ -11,9 +14,9 @@ module LanguageServer
         end
 
         #
-        # The text document's URI.
+        # The text document's uri.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # An item to transfer a text document from the client to the
+      # server.
+      #
       class TextDocumentItem
         def initialize(uri:, language_id:, version:, text:)
           @attributes = {}
@@ -14,9 +18,9 @@ module LanguageServer
         end
 
         #
-        # The text document's URI.
+        # The text document's uri.
         #
-        # @return [string]
+        # @return [DocumentUri]
         def uri
           attributes.fetch(:uri)
         end
@@ -24,7 +28,7 @@ module LanguageServer
         #
         # The text document's language identifier.
         #
-        # @return [string]
+        # @return [LanguageKind]
         def language_id
           attributes.fetch(:languageId)
         end
@@ -33,7 +37,7 @@ module LanguageServer
         # The version number of this document (it will increase after each
         # change, including undo/redo).
         #
-        # @return [number]
+        # @return [integer]
         def version
           attributes.fetch(:version)
         end

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

@@ -1,6 +1,10 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A parameter literal used in requests to pass a text document and a position inside that
+      # document.
+      #
       class TextDocumentPositionParams
         def initialize(text_document:, position:)
           @attributes = {}

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

@@ -14,10 +14,10 @@ module LanguageServer
         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/text_document_save_registration_options.rb

@@ -1,21 +1,24 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Save registration options.
+      #
       class TextDocumentSaveRegistrationOptions
         def initialize(document_selector:, include_text: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:includeText] = include_text if include_text
+          @attributes[:includeText] = include_text unless include_text.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/text_document_sync_client_capabilities.rb

@@ -5,10 +5,10 @@ module LanguageServer
         def initialize(dynamic_registration: nil, will_save: nil, will_save_wait_until: nil, did_save: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:willSave] = will_save if will_save
-          @attributes[:willSaveWaitUntil] = will_save_wait_until if will_save_wait_until
-          @attributes[:didSave] = did_save if did_save
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:willSave] = will_save unless will_save.nil?
+          @attributes[:willSaveWaitUntil] = will_save_wait_until unless will_save_wait_until.nil?
+          @attributes[:didSave] = did_save unless did_save.nil?
 
           @attributes.freeze
         end

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

@@ -5,20 +5,18 @@ module LanguageServer
         def initialize(open_close: nil, change: nil, will_save: nil, will_save_wait_until: nil, save: nil)
           @attributes = {}
 
-          @attributes[:openClose] = open_close if open_close
-          @attributes[:change] = change if change
-          @attributes[:willSave] = will_save if will_save
-          @attributes[:willSaveWaitUntil] = will_save_wait_until if will_save_wait_until
-          @attributes[:save] = save if save
+          @attributes[:openClose] = open_close unless open_close.nil?
+          @attributes[:change] = change unless change.nil?
+          @attributes[:willSave] = will_save unless will_save.nil?
+          @attributes[:willSaveWaitUntil] = will_save_wait_until unless will_save_wait_until.nil?
+          @attributes[:save] = save unless save.nil?
 
           @attributes.freeze
         end
 
         #
-        # Open and close notifications are sent to the server. If omitted open
-        # close notifications should not be sent.
-        # Open and close notifications are sent to the server. If omitted open
-        # close notification should not be sent.
+        # Open and close notifications are sent to the server. If omitted open close notification should not
+        # be sent.
         #
         # @return [boolean]
         def open_close
@@ -26,10 +24,8 @@ module LanguageServer
         end
 
         #
-        # Change notifications are sent to the server. See
-        # TextDocumentSyncKind.None, TextDocumentSyncKind.Full and
-        # TextDocumentSyncKind.Incremental. If omitted it defaults to
-        # TextDocumentSyncKind.None.
+        # Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
+        # and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
         #
         # @return [TextDocumentSyncKind]
         def change
@@ -37,8 +33,8 @@ module LanguageServer
         end
 
         #
-        # If present will save notifications are sent to the server. If omitted
-        # the notification should not be sent.
+        # If present will save notifications are sent to the server. If omitted the notification should not be
+        # sent.
         #
         # @return [boolean]
         def will_save
@@ -46,8 +42,8 @@ module LanguageServer
         end
 
         #
-        # If present will save wait until requests are sent to the server. If
-        # omitted the request should not be sent.
+        # If present will save wait until requests are sent to the server. If omitted the request should not be
+        # sent.
         #
         # @return [boolean]
         def will_save_wait_until
@@ -55,8 +51,8 @@ module LanguageServer
         end
 
         #
-        # If present save notifications are sent to the server. If omitted the
-        # notification should not be sent.
+        # If present save notifications are sent to the server. If omitted the notification should not be
+        # sent.
         #
         # @return [boolean | SaveOptions]
         def save

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

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # A text edit applicable to a text document.
+      #
       class TextEdit
         def initialize(range:, new_text:)
           @attributes = {}