language_server-protocol 3.17.0.6 → 3.18.0.0.pre.1

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

@@ -12,7 +12,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:notebook] = notebook
-          @attributes[:language] = language if language
+          @attributes[:language] = language unless language.nil?
 
           @attributes.freeze
         end

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

@@ -13,7 +13,7 @@ module LanguageServer
           @attributes[:uri] = uri
           @attributes[:notebookType] = notebook_type
           @attributes[:version] = version
-          @attributes[:metadata] = metadata if metadata
+          @attributes[:metadata] = metadata unless metadata.nil?
           @attributes[:cells] = cells
 
           @attributes.freeze

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

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Structural changes to cells in a notebook document.
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentCellChangeStructure
+        def initialize(array:, did_open: nil, did_close: nil)
+          @attributes = {}
+
+          @attributes[:array] = array
+          @attributes[:didOpen] = did_open unless did_open.nil?
+          @attributes[:didClose] = did_close unless did_close.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The change to the cell array.
+        #
+        # @return [NotebookCellArrayChange]
+        def array
+          attributes.fetch(:array)
+        end
+
+        #
+        # Additional opened cell text documents.
+        #
+        # @return [TextDocumentItem[]]
+        def did_open
+          attributes.fetch(:didOpen)
+        end
+
+        #
+        # Additional closed cell text documents.
+        #
+        # @return [TextDocumentIdentifier[]]
+        def did_close
+          attributes.fetch(:didClose)
+        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/notebook_document_cell_changes.rb

@@ -0,0 +1,58 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Cell changes to a notebook document.
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentCellChanges
+        def initialize(structure: nil, data: nil, text_content: nil)
+          @attributes = {}
+
+          @attributes[:structure] = structure unless structure.nil?
+          @attributes[:data] = data unless data.nil?
+          @attributes[:textContent] = text_content unless text_content.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Changes to the cell structure to add or
+        # remove cells.
+        #
+        # @return [NotebookDocumentCellChangeStructure]
+        def structure
+          attributes.fetch(:structure)
+        end
+
+        #
+        # Changes to notebook cells properties like its
+        # kind, execution summary or metadata.
+        #
+        # @return [NotebookCell[]]
+        def data
+          attributes.fetch(:data)
+        end
+
+        #
+        # Changes to the text content of notebook cells.
+        #
+        # @return [NotebookDocumentCellContentChanges[]]
+        def text_content
+          attributes.fetch(:textContent)
+        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/notebook_document_cell_content_changes.rb

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Content changes to a cell in a notebook document.
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentCellContentChanges
+        def initialize(document:, changes:)
+          @attributes = {}
+
+          @attributes[:document] = document
+          @attributes[:changes] = changes
+
+          @attributes.freeze
+        end
+
+        # @return [VersionedTextDocumentIdentifier]
+        def document
+          attributes.fetch(:document)
+        end
+
+        # @return [TextDocumentContentChangeEvent[]]
+        def changes
+          attributes.fetch(:changes)
+        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/notebook_document_change_event.rb

@@ -10,8 +10,8 @@ module LanguageServer
         def initialize(metadata: nil, cells: nil)
           @attributes = {}
 
-          @attributes[:metadata] = metadata if metadata
-          @attributes[:cells] = cells if cells
+          @attributes[:metadata] = metadata unless metadata.nil?
+          @attributes[:cells] = cells unless cells.nil?
 
           @attributes.freeze
         end
@@ -29,7 +29,7 @@ module LanguageServer
         #
         # Changes to cells
         #
-        # @return [{ structure?: { array: NotebookCellArrayChange; didOpen?: TextDocumentItem[]; didClose?: TextDocumentIdentifier[]; }; data?: NotebookCell[]; textContent?: { document: VersionedTextDocumentIdentifier; changes: TextDocumentContentChangeEvent[]; }[]; }]
+        # @return [NotebookDocumentCellChanges]
         def cells
           attributes.fetch(:cells)
         end

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

@@ -12,9 +12,9 @@ module LanguageServer
         def initialize(notebook_type: nil, scheme: nil, pattern: nil)
           @attributes = {}
 
-          @attributes[:notebookType] = notebook_type if notebook_type
-          @attributes[:scheme] = scheme if scheme
-          @attributes[:pattern] = pattern if pattern
+          @attributes[:notebookType] = notebook_type unless notebook_type.nil?
+          @attributes[:scheme] = scheme unless scheme.nil?
+          @attributes[:pattern] = pattern unless pattern.nil?
 
           @attributes.freeze
         end
@@ -38,7 +38,7 @@ module LanguageServer
         #
         # A glob pattern.
         #
-        # @return [string]
+        # @return [GlobPattern]
         def pattern
           attributes.fetch(:pattern)
         end

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

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document filter where `notebookType` is required field.
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentFilterNotebookType
+        def initialize(notebook_type:, scheme: nil, pattern: nil)
+          @attributes = {}
+
+          @attributes[:notebookType] = notebook_type
+          @attributes[:scheme] = scheme unless scheme.nil?
+          @attributes[:pattern] = pattern unless pattern.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The type of the enclosing notebook.
+        #
+        # @return [string]
+        def notebook_type
+          attributes.fetch(:notebookType)
+        end
+
+        #
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern.
+        #
+        # @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/notebook_document_filter_pattern.rb

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document filter where `pattern` is required field.
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentFilterPattern
+        def initialize(notebook_type: nil, scheme: nil, pattern:)
+          @attributes = {}
+
+          @attributes[:notebookType] = notebook_type unless notebook_type.nil?
+          @attributes[:scheme] = scheme unless scheme.nil?
+          @attributes[:pattern] = pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # The type of the enclosing notebook.
+        #
+        # @return [string]
+        def notebook_type
+          attributes.fetch(:notebookType)
+        end
+
+        #
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern.
+        #
+        # @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/notebook_document_filter_scheme.rb

@@ -0,0 +1,56 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document filter where `scheme` is required field.
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentFilterScheme
+        def initialize(notebook_type: nil, scheme:, pattern: nil)
+          @attributes = {}
+
+          @attributes[:notebookType] = notebook_type unless notebook_type.nil?
+          @attributes[:scheme] = scheme
+          @attributes[:pattern] = pattern unless pattern.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The type of the enclosing notebook.
+        #
+        # @return [string]
+        def notebook_type
+          attributes.fetch(:notebookType)
+        end
+
+        #
+        # A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern.
+        #
+        # @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/notebook_document_filter_with_cells.rb

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentFilterWithCells
+        def initialize(notebook: nil, cells:)
+          @attributes = {}
+
+          @attributes[:notebook] = notebook unless notebook.nil?
+          @attributes[:cells] = cells
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook to be synced If a string
+        # value is provided it matches against the
+        # notebook type. '*' matches every notebook.
+        #
+        # @return [string | NotebookDocumentFilter]
+        def notebook
+          attributes.fetch(:notebook)
+        end
+
+        #
+        # The cells of the matching notebook to be synced.
+        #
+        # @return [NotebookCellLanguage[]]
+        def cells
+          attributes.fetch(:cells)
+        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/notebook_document_filter_with_notebook.rb

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class NotebookDocumentFilterWithNotebook
+        def initialize(notebook:, cells: nil)
+          @attributes = {}
+
+          @attributes[:notebook] = notebook
+          @attributes[:cells] = cells unless cells.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook to be synced If a string
+        # value is provided it matches against the
+        # notebook type. '*' matches every notebook.
+        #
+        # @return [string | NotebookDocumentFilter]
+        def notebook
+          attributes.fetch(:notebook)
+        end
+
+        #
+        # The cells of the matching notebook to be synced.
+        #
+        # @return [NotebookCellLanguage[]]
+        def cells
+          attributes.fetch(:cells)
+        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/notebook_document_sync_client_capabilities.rb

@@ -10,8 +10,8 @@ module LanguageServer
         def initialize(dynamic_registration: nil, execution_summary_support: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
-          @attributes[:executionSummarySupport] = execution_summary_support if execution_summary_support
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
+          @attributes[:executionSummarySupport] = execution_summary_support unless execution_summary_support.nil?
 
           @attributes.freeze
         end

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

@@ -21,7 +21,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:notebookSelector] = notebook_selector
-          @attributes[:save] = save if save
+          @attributes[:save] = save unless save.nil?
 
           @attributes.freeze
         end
@@ -29,7 +29,7 @@ module LanguageServer
         #
         # The notebooks to be synced
         #
-        # @return [{ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { language: string; }[]; }[]]
+        # @return [NotebookDocumentFilterWithNotebook | NotebookDocumentFilterWithCells[]]
         def notebook_selector
           attributes.fetch(:notebookSelector)
         end

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

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:notebookSelector] = notebook_selector
-          @attributes[:save] = save if save
-          @attributes[:id] = id if id
+          @attributes[:save] = save unless save.nil?
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end
@@ -20,7 +20,7 @@ module LanguageServer
         #
         # The notebooks to be synced
         #
-        # @return [{ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { language: string; }[]; }[]]
+        # @return [NotebookDocumentFilterWithNotebook | NotebookDocumentFilterWithCells[]]
         def notebook_selector
           attributes.fetch(:notebookSelector)
         end

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

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

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

@@ -10,7 +10,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:label] = label
-          @attributes[:documentation] = documentation if documentation
+          @attributes[:documentation] = documentation unless documentation.nil?
 
           @attributes.freeze
         end
@@ -22,6 +22,10 @@ module LanguageServer
         # signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
         # string representation as `Position` and `Range` does.
         #
+        # To avoid ambiguities a server should use the [start, end] offset value instead of using
+        # a substring. Whether a client support this is controlled via `labelOffsetSupport` client
+        # capability.
+        #
         # *Note*: a label of type string should be a substring of its containing signature label.
         # Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
         #

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

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(partial_result_token: nil)
           @attributes = {}
 
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

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

@@ -9,14 +9,14 @@ module LanguageServer
       # offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
       # Since 3.17 clients and servers can agree on a different string encoding
       # representation (e.g. UTF-8). The client announces it's supported encoding
-      # via the client capability [`general.positionEncodings`](#clientCapabilities).
+      # via the client capability [`general.positionEncodings`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#clientCapabilities).
       # The value is an array of position encodings the client supports, with
       # decreasing preference (e.g. the encoding at index `0` is the most preferred
       # one). To stay backwards compatible the only mandatory encoding is UTF-16
       # represented via the string `utf-16`. The server can pick one of the
       # encodings offered by the client and signals that encoding back to the
       # client via the initialize result's property
-      # [`capabilities.positionEncoding`](#serverCapabilities). If the string value
+      # [`capabilities.positionEncoding`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#serverCapabilities). If the string value
       # `utf-16` is missing from the client's capability `general.positionEncodings`
       # servers can safely assume that the client supports UTF-16. If the server
       # omits the position encoding in its initialize result the encoding defaults
@@ -43,9 +43,6 @@ module LanguageServer
         #
         # Line position in a document (zero-based).
         #
-        # If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.
-        # If a line number is negative, it defaults to 0.
-        #
         # @return [uinteger]
         def line
           attributes.fetch(:line)
@@ -57,9 +54,6 @@ module LanguageServer
         # The meaning of this offset is determined by the negotiated
         # `PositionEncodingKind`.
         #
-        # If the character value is greater than the line length it defaults back to the
-        # line length.
-        #
         # @return [uinteger]
         def character
           attributes.fetch(:character)

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      #
+      class PrepareRenameDefaultBehavior
+        def initialize(default_behavior:)
+          @attributes = {}
+
+          @attributes[:defaultBehavior] = default_behavior
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def default_behavior
+          attributes.fetch(:defaultBehavior)
+        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/prepare_rename_params.rb

@@ -7,7 +7,7 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end