language_server-protocol 0.5.0 → 3.7.0.0

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

@@ -12,7 +12,14 @@ module LanguageServer
         end
 
         #
-        # The characters that trigger completion automatically.
+        # Most tools trigger completion request automatically without explicitly requesting
+        # it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
+        # starts to type an identifier. For example if the user types `c` in a JavaScript file
+        # code complete will automatically pop up present `console` besides others as a
+        # completion item. Characters that make up identifiers don't need to be listed here.
+        #
+        # If code complete should automatically be trigger on characters not being valid inside
+        # an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
         #
         # @return [string[]]
         def trigger_characters

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

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ConfigurationItem
+        def initialize(scope_uri: nil, section: nil)
+          @attributes = {}
+
+          @attributes[:scopeUri] = scope_uri if scope_uri
+          @attributes[:section] = section if section
+
+          @attributes.freeze
+        end
+
+        #
+        # The scope to get the configuration section for.
+        #
+        # @return [string]
+        def scope_uri
+          attributes.fetch(:scopeUri)
+        end
+
+        #
+        # The configuration section asked for.
+        #
+        # @return [string]
+        def section
+          attributes.fetch(:section)
+        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/configuration_params.rb

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class ConfigurationParams
+        def initialize(items:)
+          @attributes = {}
+
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        # @return [ConfigurationItem[]]
+        def items
+          attributes.fetch(:items)
+        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/diagnostic.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       class Diagnostic
-        def initialize(range:, severity: nil, code: nil, source: nil, message:)
+        def initialize(range:, severity: nil, code: nil, source: nil, message:, related_information: nil)
           @attributes = {}
 
           @attributes[:range] = range
@@ -10,6 +10,7 @@ module LanguageServer
           @attributes[:code] = code if code
           @attributes[:source] = source if source
           @attributes[:message] = message
+          @attributes[:relatedInformation] = related_information if related_information
 
           @attributes.freeze
         end
@@ -32,7 +33,7 @@ module LanguageServer
         end
 
         #
-        # The diagnostic's code. Can be omitted.
+        # The diagnostic's code, which might appear in the user interface.
         #
         # @return [string | number]
         def code
@@ -56,6 +57,15 @@ module LanguageServer
           attributes.fetch(:message)
         end
 
+        #
+        # An array of related diagnostic information, e.g. when symbol-names within
+        # a scope collide all definitions can be marked via this property.
+        #
+        # @return [DiagnosticRelatedInformation[]]
+        def related_information
+          attributes.fetch(:relatedInformation)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,47 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents a related message and source code location for a diagnostic. This should be
+      # used to point to code locations that cause or related to a diagnostics, e.g when duplicating
+      # a symbol in a scope.
+      #
+      class DiagnosticRelatedInformation
+        def initialize(location:, message:)
+          @attributes = {}
+
+          @attributes[:location] = location
+          @attributes[:message] = message
+
+          @attributes.freeze
+        end
+
+        #
+        # The location of this related diagnostic information.
+        #
+        # @return [Location]
+        def location
+          attributes.fetch(:location)
+        end
+
+        #
+        # The message of this related diagnostic information.
+        #
+        # @return [string]
+        def message
+          attributes.fetch(:message)
+        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/did_change_text_document_params.rb

@@ -22,7 +22,9 @@ module LanguageServer
         end
 
         #
-        # The actual content changes.
+        # The actual content changes. The content changes describe single state changes
+        # to the document. So if there are two content changes c1 and c2 for a document
+        # in state S10 then c1 move the document to S11 and c2 to S12.
         #
         # @return [TextDocumentContentChangeEvent[]]
         def content_changes

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

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Describe options to be used when registering for text document change events.
+      #
+      class DidChangeWatchedFilesRegistrationOptions
+        def initialize(watchers:)
+          @attributes = {}
+
+          @attributes[:watchers] = watchers
+
+          @attributes.freeze
+        end
+
+        #
+        # The watchers to register.
+        #
+        # @return [FileSystemWatcher[]]
+        def watchers
+          attributes.fetch(:watchers)
+        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/did_change_workspace_folders_params.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class DidChangeWorkspaceFoldersParams
+        def initialize(event:)
+          @attributes = {}
+
+          @attributes[:event] = event
+
+          @attributes.freeze
+        end
+
+        #
+        # The actual workspace folder change event.
+        #
+        # @return [WorkspaceFoldersChangeEvent]
+        def event
+          attributes.fetch(:event)
+        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/did_save_text_document_params.rb

@@ -21,7 +21,7 @@ module LanguageServer
 
         #
         # Optional the content when saved. Depends on the includeText value
-        # when the save notifcation was requested.
+        # when the save notification was requested.
         #
         # @return [string]
         def text

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

@@ -6,11 +6,12 @@ module LanguageServer
       # text document or a web site.
       #
       class DocumentLink
-        def initialize(range:, target: nil)
+        def initialize(range:, target: nil, data: nil)
           @attributes = {}
 
           @attributes[:range] = range
           @attributes[:target] = target if target
+          @attributes[:data] = data if data
 
           @attributes.freeze
         end
@@ -31,6 +32,15 @@ module LanguageServer
           attributes.fetch(:target)
         end
 
+        #
+        # A data entry field that is preserved on a document link between a
+        # DocumentLinkRequest and a DocumentLinkResolveRequest.
+        #
+        # @return [any]
+        def data
+          attributes.fetch(:data)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class FileSystemWatcher
+        def initialize(glob_pattern:, kind: nil)
+          @attributes = {}
+
+          @attributes[:globPattern] = glob_pattern
+          @attributes[:kind] = kind if kind
+
+          @attributes.freeze
+        end
+
+        #
+        # The  glob pattern to watch
+        #
+        # @return [string]
+        def glob_pattern
+          attributes.fetch(:globPattern)
+        end
+
+        #
+        # The kind of events of interest. If omitted it defaults
+        # to WatchKind.Create | WatchKind.Change | WatchKind.Delete
+        # which is 7.
+        #
+        # @return [number]
+        def kind
+          attributes.fetch(:kind)
+        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/hover.rb

@@ -17,7 +17,7 @@ module LanguageServer
         #
         # The hover's content
         #
-        # @return [string | { language: string; value: string; } | MarkedString[]]
+        # @return [string | MarkupContent | { language: string; value: string; } | MarkedString[]]
         def contents
           attributes.fetch(:contents)
         end

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

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       class InitializeParams
-        def initialize(process_id:, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil)
+        def initialize(process_id:, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil)
           @attributes = {}
 
           @attributes[:processId] = process_id
@@ -11,6 +11,7 @@ module LanguageServer
           @attributes[:initializationOptions] = initialization_options if initialization_options
           @attributes[:capabilities] = capabilities
           @attributes[:trace] = trace if trace
+          @attributes[:workspaceFolders] = workspace_folders if workspace_folders
 
           @attributes.freeze
         end
@@ -68,6 +69,19 @@ module LanguageServer
           attributes.fetch(:trace)
         end
 
+        #
+        # The workspace folders configured in the client when the server starts.
+        # This property is only available if the client supports workspace folders.
+        # It can be `null` if the client supports workspace folders but none are
+        # configured.
+        #
+        # Since 3.6.0
+        #
+        # @return [WorkspaceFolder[]]
+        def workspace_folders
+          attributes.fetch(:workspaceFolders)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,24 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class InitializedParams
+        def initialize()
+          @attributes = {}
+
+
+          @attributes.freeze
+        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/markup_content.rb

@@ -0,0 +1,66 @@
+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.
+      #
+      # 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:
+      # ```ts
+      # let markdown: MarkdownContent = {
+      # 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.
+      #
+      class MarkupContent
+        def initialize(kind:, value:)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:value] = value
+
+          @attributes.freeze
+        end
+
+        #
+        # The type of the Markup
+        #
+        # @return [MarkupKind]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # The content itself
+        #
+        # @return [string]
+        def value
+          attributes.fetch(:value)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end