language_server-protocol 3.16.0.1 → 3.17.0.0

data/lib/language_server/protocol/interface/{message.rb → lsp_object.rb}

@@ -1,20 +1,18 @@
 module LanguageServer
   module Protocol
     module Interface
-      class Message
-        def initialize(jsonrpc:)
+      #
+      # LSP object definition.
+      # @since 3.17.0
+      #
+      class LSPObject
+        def initialize()
           @attributes = {}
 
-          @attributes[:jsonrpc] = jsonrpc
 
           @attributes.freeze
         end
 
-        # @return [string]
-        def jsonrpc
-          attributes.fetch(:jsonrpc)
-        end
-
         attr_reader :attributes
 
         def to_hash

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

@@ -4,12 +4,15 @@ module LanguageServer
       #
       # Client capabilities specific to the used markdown parser.
       #
+      # @since 3.16.0
+      #
       class MarkdownClientCapabilities
-        def initialize(parser:, version: nil)
+        def initialize(parser:, version: nil, allowed_tags: nil)
           @attributes = {}
 
           @attributes[:parser] = parser
           @attributes[:version] = version if version
+          @attributes[:allowedTags] = allowed_tags if allowed_tags
 
           @attributes.freeze
         end
@@ -25,11 +28,22 @@ module LanguageServer
         #
         # The version of the parser.
         #
-        # @return [string]
+        # @return [string | nil]
         def version
           attributes.fetch(:version)
         end
 
+        #
+        # A list of HTML tags that the client allows / supports in
+        # Markdown.
+        #
+        # @since 3.17.0
+        #
+        # @return [string[] | nil]
+        def allowed_tags
+          attributes.fetch(:allowedTags)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -2,30 +2,28 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # A `MarkupContent` literal represents a string value which content is
-      # interpreted base on its kind flag. Currently the protocol supports
-      # `plaintext` and `markdown` as markup kinds.
+      # A `MarkupContent` literal represents a string value which content is interpreted base on its
+      # kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
       #
-      # If the kind is `markdown` then the value can contain fenced code blocks like
-      # in GitHub issues.
+      # If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
+      # See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
       #
-      # Here is an example how such a string can be constructed using
-      # JavaScript / TypeScript:
-      # ```typescript
+      # Here is an example how such a string can be constructed using JavaScript / TypeScript:
+      # ```ts
       # let markdown: MarkdownContent = {
-      # kind: MarkupKind.Markdown,
-      # value: [
-      # '# Header',
-      # 'Some text',
-      # '```typescript',
-      # 'someCode();',
-      # '```'
-      # ].join('\n')
+      #  kind: MarkupKind.Markdown,
+      #  value: [
+      #    '# Header',
+      #    'Some text',
+      #    '```typescript',
+      #    'someCode();',
+      #    '```'
+      #  ].join('\n')
       # };
       # ```
       #
-      # *Please Note* that clients might sanitize the return markdown. A client could
-      # decide to remove HTML from the markdown to avoid script execution.
+      # *Please Note* that clients might sanitize the return markdown. A client could decide to
+      # remove HTML from the markdown to avoid script execution.
       #
       class MarkupContent
         def initialize(kind:, value:)

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

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Moniker definition to match LSIF 0.5 moniker definition.
       #
+      # @since 3.16.0
+      #
       class Moniker
         def initialize(scheme:, identifier:, unique:, kind: nil)
           @attributes = {}
@@ -44,7 +46,7 @@ module LanguageServer
         #
         # The moniker kind if known.
         #
-        # @return [MonikerKind]
+        # @return [MonikerKind | nil]
         def kind
           attributes.fetch(:kind)
         end

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

@@ -1,6 +1,11 @@
 module LanguageServer
   module Protocol
     module Interface
+      #
+      # Client capabilities specific to the moniker request.
+      #
+      # @since 3.16.0
+      #
       class MonikerClientCapabilities
         def initialize(dynamic_registration: nil)
           @attributes = {}
@@ -11,12 +16,11 @@ module LanguageServer
         end
 
         #
-        # Whether implementation supports dynamic registration. If this is set to
-        # `true` the client supports the new `(TextDocumentRegistrationOptions &
-        # StaticRegistrationOptions)` return value for the corresponding server
-        # capability as well.
+        # Whether moniker supports dynamic registration. If this is set to `true`
+        # the client supports the new `MonikerRegistrationOptions` return value
+        # for the corresponding server capability as well.
         #
-        # @return [boolean]
+        # @return [boolean | nil]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end

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

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

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

@@ -32,16 +32,16 @@ module LanguageServer
         #
         # An optional token that a server can use to report work done progress.
         #
-        # @return [ProgressToken]
+        # @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.
+        # An optional token that a server can use to report partial results (e.g. streaming) to
+        # the client.
         #
-        # @return [ProgressToken]
+        # @return [ProgressToken | nil]
         def partial_result_token
           attributes.fetch(:partialResultToken)
         end

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

@@ -12,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]
+        # @return [DocumentSelector | null]
         def document_selector
           attributes.fetch(:documentSelector)
         end
 
-        # @return [boolean]
+        # @return [boolean | nil]
         def work_done_progress
           attributes.fetch(:workDoneProgress)
         end

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

@@ -0,0 +1,73 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook cell.
+      #
+      # A cell's document URI must be unique across ALL notebook
+      # cells and can therefore be used to uniquely identify a
+      # notebook cell or the cell's text document.
+      #
+      # @since 3.17.0
+      #
+      class NotebookCell
+        def initialize(kind:, document:, metadata: nil, execution_summary: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:document] = document
+          @attributes[:metadata] = metadata if metadata
+          @attributes[:executionSummary] = execution_summary if execution_summary
+
+          @attributes.freeze
+        end
+
+        #
+        # The cell's kind
+        #
+        # @return [NotebookCellKind]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # The URI of the cell's text document
+        # content.
+        #
+        # @return [DocumentUri]
+        def document
+          attributes.fetch(:document)
+        end
+
+        #
+        # Additional metadata stored with the cell.
+        #
+        # Note: should always be an object literal (e.g. LSPObject)
+        #
+        # @return [LSPObject | nil]
+        def metadata
+          attributes.fetch(:metadata)
+        end
+
+        #
+        # Additional execution summary information
+        # if supported by the client.
+        #
+        # @return [ExecutionSummary | nil]
+        def execution_summary
+          attributes.fetch(:executionSummary)
+        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_cell_array_change.rb

@@ -0,0 +1,57 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A change describing how to move a `NotebookCell`
+      # array from state S to S'.
+      #
+      # @since 3.17.0
+      #
+      class NotebookCellArrayChange
+        def initialize(start:, delete_count:, cells: nil)
+          @attributes = {}
+
+          @attributes[:start] = start
+          @attributes[:deleteCount] = delete_count
+          @attributes[:cells] = cells if cells
+
+          @attributes.freeze
+        end
+
+        #
+        # The start oftest of the cell that changed.
+        #
+        # @return [uinteger]
+        def start
+          attributes.fetch(:start)
+        end
+
+        #
+        # The deleted cells
+        #
+        # @return [uinteger]
+        def delete_count
+          attributes.fetch(:deleteCount)
+        end
+
+        #
+        # The new cells, if any
+        #
+        # @return [NotebookCell[] | nil]
+        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_cell_text_document_filter.rb

@@ -0,0 +1,54 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook cell text document filter denotes a cell text
+      # document by different properties.
+      #
+      # @since 3.17.0
+      #
+      class NotebookCellTextDocumentFilter
+        def initialize(notebook:, language: nil)
+          @attributes = {}
+
+          @attributes[:notebook] = notebook
+          @attributes[:language] = language if language
+
+          @attributes.freeze
+        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
+
+        #
+        # A language id like `python`.
+        #
+        # Will be matched against the language id of the
+        # notebook cell document. '*' matches every language.
+        #
+        # @return [string | nil]
+        def language
+          attributes.fetch(:language)
+        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.rb

@@ -0,0 +1,78 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocument
+        def initialize(uri:, notebook_type:, version:, metadata: nil, cells:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:notebookType] = notebook_type
+          @attributes[:version] = version
+          @attributes[:metadata] = metadata if metadata
+          @attributes[:cells] = cells
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document's uri.
+        #
+        # @return [URI]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The type of the notebook.
+        #
+        # @return [string]
+        def notebook_type
+          attributes.fetch(:notebookType)
+        end
+
+        #
+        # The version number of this document (it will increase after each
+        # change, including undo/redo).
+        #
+        # @return [integer]
+        def version
+          attributes.fetch(:version)
+        end
+
+        #
+        # Additional metadata stored with the notebook
+        # document.
+        #
+        # Note: should always be an object literal (e.g. LSPObject)
+        #
+        # @return [LSPObject | nil]
+        def metadata
+          attributes.fetch(:metadata)
+        end
+
+        #
+        # The cells of a notebook.
+        #
+        # @return [NotebookCell[]]
+        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_change_event.rb

@@ -0,0 +1,49 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A change event for a notebook document.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentChangeEvent
+        def initialize(metadata: nil, cells: nil)
+          @attributes = {}
+
+          @attributes[:metadata] = metadata if metadata
+          @attributes[:cells] = cells if cells
+
+          @attributes.freeze
+        end
+
+        #
+        # The changed meta data if any.
+        #
+        # Note: should always be an object literal (e.g. LSPObject)
+        #
+        # @return [LSPObject | nil]
+        def metadata
+          attributes.fetch(:metadata)
+        end
+
+        #
+        # Changes to cells
+        #
+        # @return [{ structure:{ array:NotebookCellArrayChange, didOpen:TextDocumentItem[], didClose:TextDocumentIdentifier[] }, data:NotebookCell[], textContent:{ document:VersionedTextDocumentIdentifier, changes:TextDocumentContentChangeEvent[] }[] } | nil]
+        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_client_capabilities.rb

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Capabilities specific to the notebook document support.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentClientCapabilities
+        def initialize(synchronization:)
+          @attributes = {}
+
+          @attributes[:synchronization] = synchronization
+
+          @attributes.freeze
+        end
+
+        #
+        # Capabilities specific to notebook document synchronization
+        #
+        # @since 3.17.0
+        #
+        # @return [NotebookDocumentSyncClientCapabilities]
+        def synchronization
+          attributes.fetch(:synchronization)
+        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.rb

@@ -0,0 +1,58 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document filter denotes a notebook document by
+      # different properties. The properties will be match
+      # against the notebook's URI (same as with documents)
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentFilter
+        def initialize(notebook_type:, scheme: nil, pattern: nil)
+          @attributes = {}
+
+          @attributes[:notebookType] = notebook_type
+          @attributes[:scheme] = scheme if scheme
+          @attributes[:pattern] = pattern if pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # The type of the enclosing notebook. */
+        #
+        # @return [string]
+        def notebook_type
+          attributes.fetch(:notebookType)
+        end
+
+        #
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
+        #
+        # @return [string | nil]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern. */
+        #
+        # @return [string | nil]
+        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_identifier.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A literal to identify a notebook document in the client.
+      #
+      # @since 3.17.0
+      #
+      class NotebookDocumentIdentifier
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document's uri.
+        #
+        # @return [URI]
+        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