language_server-protocol 3.17.0.0 → 3.17.0.2

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

@@ -1,10 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # Represents the connection of two locations. Provides additional metadata over normal [locations](#Location),
-      # including an origin range.
-      #
       class LocationLink
         def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range:)
           @attributes = {}
@@ -20,10 +16,10 @@ module LanguageServer
         #
         # Span of the origin of this link.
         #
-        # Used as the underlined span for mouse interaction. Defaults to the word range at
-        # the definition position.
+        # Used as the underlined span for mouse interaction. Defaults to the word
+        # range at the mouse position.
         #
-        # @return [Range | nil]
+        # @return [Range]
         def origin_selection_range
           attributes.fetch(:originSelectionRange)
         end
@@ -31,15 +27,16 @@ module LanguageServer
         #
         # The target resource identifier of this link.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def target_uri
           attributes.fetch(:targetUri)
         end
 
         #
-        # The full target range of this link. If the target for example is a symbol then target range is the
-        # range enclosing this symbol not including leading/trailing whitespace but everything else
-        # like comments. This information is typically used to highlight the range in the editor.
+        # The full target range of this link. If the target for example is a symbol
+        # then target range is the range enclosing this symbol not including
+        # leading/trailing whitespace but everything else like comments. This
+        # information is typically used to highlight the range in the editor.
         #
         # @return [Range]
         def target_range
@@ -47,8 +44,9 @@ module LanguageServer
         end
 
         #
-        # The range that should be selected and revealed when this link is being followed, e.g the name of a function.
-        # Must be contained by the `targetRange`. See also `DocumentSymbol#range`
+        # The range that should be selected and revealed when this link is being
+        # followed, e.g the name of a function. Must be contained by the
+        # `targetRange`. See also `DocumentSymbol#range`
         #
         # @return [Range]
         def target_selection_range

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

@@ -1,9 +1,6 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # The log message parameters.
-      #
       class LogMessageParams
         def initialize(type:, message:)
           @attributes = {}
@@ -23,7 +20,7 @@ module LanguageServer
         end
 
         #
-        # The actual message.
+        # The actual message
         #
         # @return [string]
         def message

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

@@ -11,12 +11,19 @@ module LanguageServer
           @attributes.freeze
         end
 
+        #
+        # The message to be logged.
+        #
         # @return [string]
         def message
           attributes.fetch(:message)
         end
 
-        # @return [string | nil]
+        #
+        # Additional information that can be computed if the `trace` configuration
+        # is set to `'verbose'`
+        #
+        # @return [string]
         def verbose
           attributes.fetch(:verbose)
         end

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

@@ -2,28 +2,30 @@ 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.
-      # See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+      # If the kind is `markdown` then the value can contain fenced code blocks like
+      # in GitHub issues.
       #
-      # Here is an example how such a string can be constructed using JavaScript / TypeScript:
-      # ```ts
+      # Here is an example how such a string can be constructed using
+      # JavaScript / TypeScript:
+      # ```typescript
       # 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/{lsp_object.rb → message.rb}

@@ -1,18 +1,20 @@
 module LanguageServer
   module Protocol
     module Interface
-      #
-      # LSP object definition.
-      # @since 3.17.0
-      #
-      class LSPObject
-        def initialize()
+      class Message
+        def initialize(jsonrpc:)
           @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/moniker.rb

@@ -4,8 +4,6 @@ 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 = {}
@@ -46,7 +44,7 @@ module LanguageServer
         #
         # The moniker kind if known.
         #
-        # @return [MonikerKind | nil]
+        # @return [MonikerKind]
         def kind
           attributes.fetch(:kind)
         end

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

@@ -1,11 +1,6 @@
 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 = {}
@@ -16,11 +11,12 @@ module LanguageServer
         end
 
         #
-        # 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.
+        # 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.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         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 | nil]
+        # @return [boolean]
         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 | 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

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 | 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/notebook_cell.rb

@@ -8,8 +8,6 @@ module LanguageServer
       # 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 = {}
@@ -25,7 +23,7 @@ module LanguageServer
         #
         # The cell's kind
         #
-        # @return [NotebookCellKind]
+        # @return [any]
         def kind
           attributes.fetch(:kind)
         end
@@ -34,7 +32,7 @@ module LanguageServer
         # The URI of the cell's text document
         # content.
         #
-        # @return [DocumentUri]
+        # @return [string]
         def document
           attributes.fetch(:document)
         end
@@ -42,9 +40,7 @@ module LanguageServer
         #
         # Additional metadata stored with the cell.
         #
-        # Note: should always be an object literal (e.g. LSPObject)
-        #
-        # @return [LSPObject | nil]
+        # @return [LSPObject]
         def metadata
           attributes.fetch(:metadata)
         end
@@ -53,7 +49,7 @@ module LanguageServer
         # Additional execution summary information
         # if supported by the client.
         #
-        # @return [ExecutionSummary | nil]
+        # @return [ExecutionSummary]
         def execution_summary
           attributes.fetch(:executionSummary)
         end

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

@@ -5,8 +5,6 @@ module LanguageServer
       # 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 = {}
@@ -19,9 +17,9 @@ module LanguageServer
         end
 
         #
-        # The start oftest of the cell that changed.
+        # The start offset of the cell that changed.
         #
-        # @return [uinteger]
+        # @return [number]
         def start
           attributes.fetch(:start)
         end
@@ -29,7 +27,7 @@ module LanguageServer
         #
         # The deleted cells
         #
-        # @return [uinteger]
+        # @return [number]
         def delete_count
           attributes.fetch(:deleteCount)
         end
@@ -37,7 +35,7 @@ module LanguageServer
         #
         # The new cells, if any
         #
-        # @return [NotebookCell[] | nil]
+        # @return [NotebookCell[]]
         def cells
           attributes.fetch(:cells)
         end

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

@@ -5,8 +5,6 @@ module LanguageServer
       # 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 = {}
@@ -34,7 +32,7 @@ module LanguageServer
         # Will be matched against the language id of the
         # notebook cell document. '*' matches every language.
         #
-        # @return [string | nil]
+        # @return [string]
         def language
           attributes.fetch(:language)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A notebook document.
       #
-      # @since 3.17.0
-      #
       class NotebookDocument
         def initialize(uri:, notebook_type:, version:, metadata: nil, cells:)
           @attributes = {}
@@ -20,9 +18,9 @@ module LanguageServer
         end
 
         #
-        # The notebook document's uri.
+        # The notebook document's URI.
         #
-        # @return [URI]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end
@@ -39,7 +37,7 @@ module LanguageServer
         # The version number of this document (it will increase after each
         # change, including undo/redo).
         #
-        # @return [integer]
+        # @return [number]
         def version
           attributes.fetch(:version)
         end
@@ -48,9 +46,7 @@ module LanguageServer
         # Additional metadata stored with the notebook
         # document.
         #
-        # Note: should always be an object literal (e.g. LSPObject)
-        #
-        # @return [LSPObject | nil]
+        # @return [LSPObject]
         def metadata
           attributes.fetch(:metadata)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A change event for a notebook document.
       #
-      # @since 3.17.0
-      #
       class NotebookDocumentChangeEvent
         def initialize(metadata: nil, cells: nil)
           @attributes = {}
@@ -19,9 +17,7 @@ module LanguageServer
         #
         # The changed meta data if any.
         #
-        # Note: should always be an object literal (e.g. LSPObject)
-        #
-        # @return [LSPObject | nil]
+        # @return [LSPObject]
         def metadata
           attributes.fetch(:metadata)
         end
@@ -29,7 +25,7 @@ module LanguageServer
         #
         # Changes to cells
         #
-        # @return [{ structure:{ array:NotebookCellArrayChange, didOpen:TextDocumentItem[], didClose:TextDocumentIdentifier[] }, data:NotebookCell[], textContent:{ document:VersionedTextDocumentIdentifier, changes:TextDocumentContentChangeEvent[] }[] } | nil]
+        # @return [{ structure?: { array: NotebookCellArrayChange; didOpen?: TextDocumentItem[]; didClose?: TextDocumentIdentifier[]; }; data?: NotebookCell[]; textContent?: { ...; }[]; }]
         def cells
           attributes.fetch(:cells)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Capabilities specific to the notebook document support.
       #
-      # @since 3.17.0
-      #
       class NotebookDocumentClientCapabilities
         def initialize(synchronization:)
           @attributes = {}
@@ -18,8 +16,6 @@ module LanguageServer
         #
         # Capabilities specific to notebook document synchronization
         #
-        # @since 3.17.0
-        #
         # @return [NotebookDocumentSyncClientCapabilities]
         def synchronization
           attributes.fetch(:synchronization)

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

@@ -3,16 +3,13 @@ module LanguageServer
     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
+      # different properties.
       #
       class NotebookDocumentFilter
-        def initialize(notebook_type:, scheme: nil, pattern: nil)
+        def initialize(notebook_type: nil, scheme: nil, pattern: nil)
           @attributes = {}
 
-          @attributes[:notebookType] = notebook_type
+          @attributes[:notebookType] = notebook_type if notebook_type
           @attributes[:scheme] = scheme if scheme
           @attributes[:pattern] = pattern if pattern
 
@@ -20,7 +17,15 @@ module LanguageServer
         end
 
         #
-        # The type of the enclosing notebook. */
+        # The type of the enclosing notebook.
+        #
+        # --- OR ---
+        #
+        # The type of the enclosing notebook.
+        #
+        # --- OR ---
+        #
+        # The type of the enclosing notebook.
         #
         # @return [string]
         def notebook_type
@@ -28,17 +33,33 @@ module LanguageServer
         end
 
         #
-        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        #
+        # --- OR ---
+        #
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        #
+        # --- OR ---
         #
-        # @return [string | nil]
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        #
+        # @return [string]
         def scheme
           attributes.fetch(:scheme)
         end
 
         #
-        # A glob pattern. */
+        # A glob pattern.
+        #
+        # --- OR ---
+        #
+        # A glob pattern.
         #
-        # @return [string | nil]
+        # --- OR ---
+        #
+        # A glob pattern.
+        #
+        # @return [string]
         def pattern
           attributes.fetch(:pattern)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # A literal to identify a notebook document in the client.
       #
-      # @since 3.17.0
-      #
       class NotebookDocumentIdentifier
         def initialize(uri:)
           @attributes = {}
@@ -16,9 +14,9 @@ module LanguageServer
         end
 
         #
-        # The notebook document's uri.
+        # The notebook document's URI.
         #
-        # @return [URI]
+        # @return [string]
         def uri
           attributes.fetch(:uri)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Notebook specific client capabilities.
       #
-      # @since 3.17.0
-      #
       class NotebookDocumentSyncClientCapabilities
         def initialize(dynamic_registration: nil, execution_summary_support: nil)
           @attributes = {}
@@ -22,7 +20,7 @@ module LanguageServer
         # `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
         # return value for the corresponding server capability as well.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def dynamic_registration
           attributes.fetch(:dynamicRegistration)
         end
@@ -30,7 +28,7 @@ module LanguageServer
         #
         # The client supports sending execution summary data per cell.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def execution_summary_support
           attributes.fetch(:executionSummarySupport)
         end

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

@@ -11,11 +11,9 @@ module LanguageServer
       #
       # If a selector provides no notebook document
       # filter but only a cell selector all notebook
-      # document that contain at least one matching
+      # documents that contain at least one matching
       # cell will be synced.
       #
-      # @since 3.17.0
-      #
       class NotebookDocumentSyncOptions
         def initialize(notebook_selector:, save: nil)
           @attributes = {}
@@ -29,7 +27,7 @@ module LanguageServer
         #
         # The notebooks to be synced
         #
-        # @return [{ notebook:string | NotebookDocumentFilter, cells:{ language:string }[] } | { notebook:string | NotebookDocumentFilter, cells:{ language:string }[] }[]]
+        # @return [({ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { ...; }[]; })[]]
         def notebook_selector
           attributes.fetch(:notebookSelector)
         end
@@ -38,7 +36,7 @@ module LanguageServer
         # Whether save notification should be forwarded to
         # the server. Will only be honored if mode === `notebook`.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def save
           attributes.fetch(:save)
         end

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

@@ -4,8 +4,6 @@ module LanguageServer
       #
       # Registration options specific to a notebook.
       #
-      # @since 3.17.0
-      #
       class NotebookDocumentSyncRegistrationOptions
         def initialize(notebook_selector:, save: nil, id: nil)
           @attributes = {}
@@ -20,7 +18,7 @@ module LanguageServer
         #
         # The notebooks to be synced
         #
-        # @return [{ notebook:string | NotebookDocumentFilter, cells:{ language:string }[] } | { notebook:string | NotebookDocumentFilter, cells:{ language:string }[] }[]]
+        # @return [({ notebook: string | NotebookDocumentFilter; cells?: { language: string; }[]; } | { notebook?: string | NotebookDocumentFilter; cells: { ...; }[]; })[]]
         def notebook_selector
           attributes.fetch(:notebookSelector)
         end
@@ -29,7 +27,7 @@ module LanguageServer
         # Whether save notification should be forwarded to
         # the server. Will only be honored if mode === `notebook`.
         #
-        # @return [boolean | nil]
+        # @return [boolean]
         def save
           attributes.fetch(:save)
         end
@@ -38,7 +36,7 @@ module LanguageServer
         # 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