language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # The params sent in a change notebook document notification.
       #
-      # @since 3.17.0
-      #
       class DidChangeNotebookDocumentParams
         def initialize(notebook_document:, change:)
           @attributes = {}
@@ -18,9 +16,7 @@ module LanguageServer
 
         #
         # The notebook document that did change. The version number points
-        # to the version after all provided changes have been applied. If
-        # only the text document content of a cell changes the notebook version
-        # doesn't necessarily have to change.
+        # to the version after all provided changes have been applied.
         #
         # @return [VersionedNotebookDocumentIdentifier]
         def notebook_document
@@ -30,17 +26,15 @@ module LanguageServer
         #
         # The actual changes to the notebook document.
         #
-        # The changes describe single state changes to the notebook document.
-        # So if there are two changes c1 (at array index 0) and c2 (at array
-        # index 1) for a notebook in state S then c1 moves the notebook from
-        # S to S' and c2 from S' to S''. So c1 is computed on the state S and
-        # c2 is computed on the state S'.
+        # The change describes single state change to the notebook document.
+        # So it moves a notebook document, its cells and its cell text document
+        # contents from state S to S'.
         #
-        # To mirror the content of a notebook using change events use the following approach:
+        # To mirror the content of a notebook using change events use the
+        # following approach:
         # - start with the same initial content
-        # - apply the 'notebookDocument/didChange' notifications in the order you receive them.
-        # - apply the `NotebookChangeEvent`s in a single notification in the order
-        #   you receive them.
+        # - apply the 'notebookDocument/didChange' notifications in the order
+        # you receive them.
         #
         # @return [NotebookDocumentChangeEvent]
         def change

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The change text document notification's parameters.
-      #
       class DidChangeTextDocumentParams
         def initialize(text_document:, content_changes:)
           @attributes = {}
@@ -25,17 +22,19 @@ module LanguageServer
         end
 
         #
-        # The actual content changes. The content changes describe single state changes
-        # to the document. So if there are two content changes c1 (at array index 0) and
-        # c2 (at array index 1) for a document in state S then c1 moves the document from
-        # S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed
-        # on the state S'.
+        # The actual content changes. The content changes describe single state
+        # changes to the document. So if there are two content changes c1 (at
+        # array index 0) and c2 (at array index 1) for a document in state S then
+        # c1 moves the document from S to S' and c2 from S' to S''. So c1 is
+        # computed on the state S and c2 is computed on the state S'.
         #
-        # To mirror the content of a document using change events use the following approach:
+        # To mirror the content of a document using change events use the following
+        # approach:
         # - start with the same initial content
-        # - apply the 'textDocument/didChange' notifications in the order you receive them.
-        # - apply the `TextDocumentContentChangeEvent`s in a single notification in the order
-        #   you receive them.
+        # - apply the 'textDocument/didChange' notifications in the order you
+        # receive them.
+        # - apply the `TextDocumentContentChangeEvent`s in a single notification
+        # in the order you receive them.
         #
         # @return [TextDocumentContentChangeEvent[]]
         def content_changes

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

@@ -12,22 +12,20 @@ module LanguageServer
         end
 
         #
-        # Did change watched files notification supports dynamic registration. Please note
-        # that the current protocol doesn't support static configuration for file changes
-        # from the server side.
+        # Did change watched files notification supports dynamic registration.
+        # Please note that the current protocol doesn't support static
+        # configuration for file changes from the server side.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
 
         #
-        # Whether the client has support for {@link  RelativePattern relative pattern}
+        # Whether the client has support for relative patterns
         # or not.
         #
-        # @since 3.17.0
-        #
-        # @return [boolean | nil]
+        # @return [boolean]
         def relative_pattern_support
           attributes.fetch(:relativePatternSupport)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The watched files change notification's parameters.
-      #
       class DidChangeWatchedFilesParams
         def initialize(changes:)
           @attributes = {}

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Describe options to be used when registered for text document change events.
+      # Describe options to be used when registering for file system change events.
       #
       class DidChangeWatchedFilesRegistrationOptions
         def initialize(watchers:)

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters of a `workspace/didChangeWorkspaceFolders` notification.
-      #
       class DidChangeWorkspaceFoldersParams
         def initialize(event:)
           @attributes = {}

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # The params sent in a close notebook document notification.
       #
-      # @since 3.17.0
-      #
       class DidCloseNotebookDocumentParams
         def initialize(notebook_document:, cell_text_documents:)
           @attributes = {}

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters sent in a close text document notification
-      #
       class DidCloseTextDocumentParams
         def initialize(text_document:)
           @attributes = {}

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # The params sent in an open notebook document notification.
       #
-      # @since 3.17.0
-      #
       class DidOpenNotebookDocumentParams
         def initialize(notebook_document:, cell_text_documents:)
           @attributes = {}

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters sent in an open text document notification
-      #
       class DidOpenTextDocumentParams
         def initialize(text_document:)
           @attributes = {}

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # The params sent in a save notebook document notification.
       #
-      # @since 3.17.0
-      #
       class DidSaveNotebookDocumentParams
         def initialize(notebook_document:)
           @attributes = {}

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters sent in a save text document notification
-      #
       class DidSaveTextDocumentParams
         def initialize(text_document:, text: nil)
           @attributes = {}
@@ -26,7 +23,7 @@ module LanguageServer
         # Optional the content when saved. Depends on the includeText value
         # when the save notification was requested.
         #
-        # @return [string | nil]
+        # @return [string]
         def text
           attributes.fetch(:text)
         end

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

@@ -11,11 +11,9 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration. If this is set to `true`
-        # the client supports the new `DocumentColorRegistrationOptions` return value
-        # for the corresponding server capability as well.
+        # Whether document color supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -1,45 +1,42 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Parameters for a [DocumentColorRequest](#DocumentColorRequest).
-      #
       class DocumentColorParams
-        def initialize(text_document:, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:)
           @attributes = {}
 
-          @attributes[:textDocument] = text_document
           @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:textDocument] = text_document
 
           @attributes.freeze
         end
 
-        #
-        # The text document.
-        #
-        # @return [TextDocumentIdentifier]
-        def text_document
-          attributes.fetch(:textDocument)
-        end
-
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken | nil]
+        # @return [ProgressToken]
         def work_done_token
           attributes.fetch(:workDoneToken)
         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 | nil]
+        # @return [ProgressToken]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end
 
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,39 +2,39 @@ module LanguageServer
   module Protocol
     module Interface
       class DocumentColorRegistrationOptions
-        def initialize(document_selector:, work_done_progress: nil, id: nil)
+        def initialize(document_selector:, id: nil, work_done_progress: nil)
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
           @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
 
           @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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean | nil]
-        def work_done_progress
-          attributes.fetch(:workDoneProgress)
-        end
-
         #
         # The id used to register the request. The id can be used to deregister
         # the request again. See also Registration#id.
         #
-        # @return [string | nil]
+        # @return [string]
         def id
           attributes.fetch(:id)
         end
 
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -4,21 +4,36 @@ module LanguageServer
       #
       # Parameters of the document diagnostic request.
       #
-      # @since 3.17.0
-      #
       class DocumentDiagnosticParams
-        def initialize(text_document:, identifier: nil, previous_result_id: nil, work_done_token: nil, partial_result_token: nil)
+        def initialize(work_done_token: nil, partial_result_token: nil, text_document:, identifier: nil, previous_result_id: nil)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:partialResultToken] = partial_result_token if partial_result_token
           @attributes[:textDocument] = text_document
           @attributes[:identifier] = identifier if identifier
           @attributes[:previousResultId] = previous_result_id if previous_result_id
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
 
           @attributes.freeze
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        #
+        # 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
+
         #
         # The text document.
         #
@@ -30,7 +45,7 @@ module LanguageServer
         #
         # The additional identifier  provided during registration.
         #
-        # @return [string | nil]
+        # @return [string]
         def identifier
           attributes.fetch(:identifier)
         end
@@ -38,28 +53,11 @@ module LanguageServer
         #
         # The result id of a previous response if provided.
         #
-        # @return [string | nil]
+        # @return [string]
         def previous_result_id
           attributes.fetch(:previousResultId)
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken | nil]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
-        end
-
-        #
-        # An optional token that a server can use to report partial results (e.g. streaming) to
-        # the client.
-        #
-        # @return [ProgressToken | nil]
-        def partial_result_token
-          attributes.fetch(:partialResultToken)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A partial result for a document diagnostic report.
       #
-      # @since 3.17.0
-      #
       class DocumentDiagnosticReportPartialResult
         def initialize(related_documents:)
           @attributes = {}
@@ -15,7 +13,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [DocumentUri => FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport]
+        # @return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]
         def related_documents
           attributes.fetch(:relatedDocuments)
         end

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

@@ -1,26 +1,19 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # A document filter describes a top level text document or
-      # a notebook cell document.
-      #
-      # @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
-      #
       class DocumentFilter
-        def initialize(language:, scheme: nil, pattern: nil, notebook:)
+        def initialize(language: nil, scheme: nil, pattern: nil)
           @attributes = {}
 
-          @attributes[:language] = language
+          @attributes[:language] = language if language
           @attributes[:scheme] = scheme if scheme
           @attributes[:pattern] = pattern if pattern
-          @attributes[:notebook] = notebook
 
           @attributes.freeze
         end
 
         #
-        # A language id, like `typescript`. */
+        # A language id, like `typescript`.
         #
         # @return [string]
         def language
@@ -28,32 +21,33 @@ module LanguageServer
         end
 
         #
-        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
         #
-        # @return [string | nil]
+        # @return [string]
         def scheme
           attributes.fetch(:scheme)
         end
 
         #
-        # A glob pattern, like `*.{ts,js}`. */
+        # A glob pattern, like `*.{ts,js}`.
+        #
+        # Glob patterns can have the following syntax:
+        # - `*` to match one 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`)
         #
-        # @return [string | nil]
+        # @return [string]
         def pattern
           attributes.fetch(:pattern)
         end
 
-        #
-        # A filter that matches against the notebook
-        # containing the notebook cell. If a string
-        # value is provided it matches against the
-        # notebook type. '*' matches every notebook.
-        #
-        # @return [string | NotebookDocumentFilter]
-        def notebook
-          attributes.fetch(:notebook)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Client capabilities of a [DocumentFormattingRequest](#DocumentFormattingRequest).
-      #
       class DocumentFormattingClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -16,7 +13,7 @@ module LanguageServer
         #
         # Whether formatting supports dynamic registration.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Provider options for a [DocumentFormattingRequest](#DocumentFormattingRequest).
-      #
       class DocumentFormattingOptions
         def initialize(work_done_progress: nil)
           @attributes = {}
@@ -13,7 +10,7 @@ module LanguageServer
           @attributes.freeze
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -1,20 +1,25 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The parameters of a [DocumentFormattingRequest](#DocumentFormattingRequest).
-      #
       class DocumentFormattingParams
-        def initialize(text_document:, options:, work_done_token: nil)
+        def initialize(work_done_token: nil, text_document:, options:)
           @attributes = {}
 
+          @attributes[:workDoneToken] = work_done_token if work_done_token
           @attributes[:textDocument] = text_document
           @attributes[:options] = options
-          @attributes[:workDoneToken] = work_done_token if work_done_token
 
           @attributes.freeze
         end
 
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
         #
         # The document to format.
         #
@@ -31,14 +36,6 @@ module LanguageServer
           attributes.fetch(:options)
         end
 
-        #
-        # An optional token that a server can use to report work done progress.
-        #
-        # @return [ProgressToken | nil]
-        def work_done_token
-          attributes.fetch(:workDoneToken)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Registration options for a [DocumentFormattingRequest](#DocumentFormattingRequest).
-      #
       class DocumentFormattingRegistrationOptions
         def initialize(document_selector:, work_done_progress: nil)
           @attributes = {}
@@ -15,15 +12,15 @@ 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 | null]
+        # @return [DocumentSelector]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean | nil]
+        # @return [boolean]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -25,9 +25,9 @@ module LanguageServer
         end
 
         #
-        # The highlight kind, default is [text](#DocumentHighlightKind.Text).
+        # The highlight kind, default is DocumentHighlightKind.Text.
         #
-        # @return [DocumentHighlightKind | nil]
+        # @return [DocumentHighlightKind]
         def kind
           attributes.fetch(:kind)
         end