language_server-protocol 3.17.0.5 → 3.18.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b320d5f9cf8f0feb38122b5226bb9b30ac55250eefaa09fa1bcdec5daa234cb2
-  data.tar.gz: 45278348448e07bc4771b4e5319bebf764b89c1fc117f0b6c990657c559e941c
+  metadata.gz: 72cb3d3440dc778bb944e23ce4ffcf4b367eaedb9b33f390eb340d5753b8eccb
+  data.tar.gz: 915536e7806a91ef061fe2182356817a3d3d5e0244ee56e545e4b96b750a651c
 SHA512:
-  metadata.gz: 17291732e8ae0cf36609a6335e214395c7f510fe0e4763ec203a80f0ac8bbbe7a0c01cc1f8ce9900726aa07d2bf7be25304f9ed49d04bfa6cb15f45123553e8a
-  data.tar.gz: 93247dc83eff9cf2c55e76b75e1ac15178ba5d3f062034be0ffc6cbcb5ad6efa28cc8196ae8e7be9a07d816daefd9d77489bc3883c2bc8307fb79a53a21fc4c0
+  metadata.gz: 5c396998080282ff277851f17db49697caa79b1fe41f2240a085f8e10e61a544450331eb54ff10808b0905b59d38b9c80c0083e95525a932f5de9b503d01ebae
+  data.tar.gz: dd957f632527b5bcb3a268717a5e51b642e6fbac5948884b764250bb985df84432d46fe51cf06f3897055bd3e99793b799d90f5d902e7084d2c49ef56606587f

data/lib/language_server/protocol/constant/apply_kind.rb

@@ -0,0 +1,26 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Defines how values from a set of defaults and an individual item will be
+      # merged.
+      #
+      # @since 3.18.0
+      #
+      module ApplyKind
+        #
+        # The value from the individual item (if provided and not `null`) will be
+        # used instead of the default.
+        #
+        REPLACE = 1
+        #
+        # The value from the item will be merged with the default.
+        #
+        # The specific rules for mergeing values are defined against each field
+        # that supports merging.
+        #
+        MERGE = 2
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/code_action_kind.rb

@@ -2,30 +2,23 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # The kind of a code action.
-      #
-      # Kinds are a hierarchical list of identifiers separated by `.`,
-      # e.g. `"refactor.extract.function"`.
-      #
-      # The set of kinds is open and client needs to announce the kinds it supports
-      # to the server during initialization.
-      # A set of predefined code action kinds.
+      # A set of predefined code action kinds
       #
       module CodeActionKind
         #
         # Empty kind.
         #
-        EMPTY = ''
+        EMPTY = ""
         #
-        # Base kind for quickfix actions: 'quickfix'.
+        # Base kind for quickfix actions: 'quickfix'
         #
-        QUICK_FIX = 'quickfix'
+        QUICK_FIX = "quickfix"
         #
-        # Base kind for refactoring actions: 'refactor'.
+        # Base kind for refactoring actions: 'refactor'
         #
-        REFACTOR = 'refactor'
+        REFACTOR = "refactor"
         #
-        # Base kind for refactoring extraction actions: 'refactor.extract'.
+        # Base kind for refactoring extraction actions: 'refactor.extract'
         #
         # Example extract actions:
         #
@@ -35,9 +28,9 @@ module LanguageServer
         # - Extract interface from class
         # - ...
         #
-        REFACTOR_EXTRACT = 'refactor.extract'
+        REFACTOR_EXTRACT = "refactor.extract"
         #
-        # Base kind for refactoring inline actions: 'refactor.inline'.
+        # Base kind for refactoring inline actions: 'refactor.inline'
         #
         # Example inline actions:
         #
@@ -46,9 +39,22 @@ module LanguageServer
         # - Inline constant
         # - ...
         #
-        REFACTOR_INLINE = 'refactor.inline'
+        REFACTOR_INLINE = "refactor.inline"
+        #
+        # Base kind for refactoring move actions: `refactor.move`
+        #
+        # Example move actions:
+        #
+        # - Move a function to a new file
+        # - Move a property between classes
+        # - Move method to base class
+        # - ...
         #
-        # Base kind for refactoring rewrite actions: 'refactor.rewrite'.
+        # @since 3.18.0
+        #
+        REFACTOR_MOVE = "refactor.move"
+        #
+        # Base kind for refactoring rewrite actions: 'refactor.rewrite'
         #
         # Example rewrite actions:
         #
@@ -59,26 +65,33 @@ module LanguageServer
         # - Move method to base class
         # - ...
         #
-        REFACTOR_REWRITE = 'refactor.rewrite'
+        REFACTOR_REWRITE = "refactor.rewrite"
         #
-        # Base kind for source actions: `source`.
+        # Base kind for source actions: `source`
         #
         # Source code actions apply to the entire file.
         #
-        SOURCE = 'source'
+        SOURCE = "source"
+        #
+        # Base kind for an organize imports source action: `source.organizeImports`
+        #
+        SOURCE_ORGANIZE_IMPORTS = "source.organizeImports"
+        #
+        # Base kind for auto-fix source actions: `source.fixAll`.
+        #
+        # Fix all actions automatically fix errors that have a clear fix that do not require user input.
+        # They should not suppress errors or perform unsafe fixes such as generating new types or classes.
         #
-        # Base kind for an organize imports source action:
-        # `source.organizeImports`.
+        # @since 3.15.0
         #
-        SOURCE_ORGANIZE_IMPORTS = 'source.organizeImports'
+        SOURCE_FIX_ALL = "source.fixAll"
         #
-        # Base kind for a 'fix all' source action: `source.fixAll`.
+        # Base kind for all code actions applying to the entire notebook's scope. CodeActionKinds using
+        # this should always begin with `notebook.`
         #
-        # 'Fix all' actions automatically fix errors that have a clear fix that
-        # do not require user input. They should not suppress errors or perform
-        # unsafe fixes such as generating new types or classes.
+        # @since 3.18.0
         #
-        SOURCE_FIX_ALL = 'source.fixAll'
+        NOTEBOOK = "notebook"
       end
     end
   end

data/lib/language_server/protocol/constant/code_action_tag.rb

@@ -0,0 +1,17 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Code action tags are extra annotations that tweak the behavior of a code action.
+      #
+      # @since 3.18.0
+      #
+      module CodeActionTag
+        #
+        # Marks the code action as LLM-generated.
+        #
+        LLM_GENERATED = 1
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/code_action_trigger_kind.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # The reason why code actions were requested.
       #
+      # @since 3.17.0
+      #
       module CodeActionTriggerKind
         #
         # Code actions were explicitly requested by the user or by an extension.

data/lib/language_server/protocol/constant/completion_item_tag.rb

@@ -2,8 +2,10 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # Completion item tags are extra annotations that tweak the rendering of a
-      # completion item.
+      # Completion item tags are extra annotations that tweak the rendering of a completion
+      # item.
+      #
+      # @since 3.15.0
       #
       module CompletionItemTag
         #

data/lib/language_server/protocol/constant/completion_trigger_kind.rb

@@ -12,12 +12,11 @@ module LanguageServer
         INVOKED = 1
         #
         # Completion was triggered by a trigger character specified by
-        # the `triggerCharacters` properties of the
-        # `CompletionRegistrationOptions`.
+        # the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
         #
         TRIGGER_CHARACTER = 2
         #
-        # Completion was re-triggered as the current completion list is incomplete.
+        # Completion was re-triggered as current completion list is incomplete
         #
         TRIGGER_FOR_INCOMPLETE_COMPLETIONS = 3
       end

data/lib/language_server/protocol/constant/diagnostic_severity.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Constant
+      #
+      # The diagnostic's severity.
+      #
       module DiagnosticSeverity
         #
         # Reports an error.

data/lib/language_server/protocol/constant/diagnostic_tag.rb

@@ -4,12 +4,14 @@ module LanguageServer
       #
       # The diagnostic tags.
       #
+      # @since 3.15.0
+      #
       module DiagnosticTag
         #
         # Unused or unnecessary code.
         #
-        # Clients are allowed to render diagnostics with this tag faded out
-        # instead of having an error squiggle.
+        # Clients are allowed to render diagnostics with this tag faded out instead of having
+        # an error squiggle.
         #
         UNNECESSARY = 1
         #

data/lib/language_server/protocol/constant/document_diagnostic_report_kind.rb

@@ -4,17 +4,19 @@ module LanguageServer
       #
       # The document diagnostic report kinds.
       #
+      # @since 3.17.0
+      #
       module DocumentDiagnosticReportKind
         #
         # A diagnostic report with a full
         # set of problems.
         #
-        FULL = 'full'
+        FULL = "full"
         #
         # A report indicating that the last
         # returned report is still accurate.
         #
-        UNCHANGED = 'unchanged'
+        UNCHANGED = "unchanged"
       end
     end
   end

data/lib/language_server/protocol/constant/error_codes.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Constant
+      #
+      # Predefined error codes.
+      #
       module ErrorCodes
         PARSE_ERROR = -32700
         INVALID_REQUEST = -32600
@@ -8,43 +11,27 @@ module LanguageServer
         INVALID_PARAMS = -32602
         INTERNAL_ERROR = -32603
         #
-        # This is the start range of JSON-RPC reserved error codes.
-        # It doesn't denote a real error code. No LSP error codes should
-        # be defined between the start and end range. For backwards
-        # compatibility the `ServerNotInitialized` and the `UnknownErrorCode`
-        # are left in the range.
-        #
-        JSONRPC_RESERVED_ERROR_RANGE_START = -32099
-        SERVER_ERROR_START = JSONRPC_RESERVED_ERROR_RANGE_START
-        #
         # Error code indicating that a server received a notification or
         # request before the server has received the `initialize` request.
         #
         SERVER_NOT_INITIALIZED = -32002
         UNKNOWN_ERROR_CODE = -32001
         #
-        # This is the end range of JSON-RPC reserved error codes.
-        # It doesn't denote a real error code.
-        #
-        JSONRPC_RESERVED_ERROR_RANGE_END = -32000
-        SERVER_ERROR_END = JSONRPC_RESERVED_ERROR_RANGE_END
-        #
-        # This is the start range of LSP reserved error codes.
-        # It doesn't denote a real error code.
-        #
-        LSP_RESERVED_ERROR_RANGE_START = -32899
-        #
         # A request failed but it was syntactically correct, e.g the
         # method name was known and the parameters were valid. The error
         # message should contain human readable information about why
         # the request failed.
         #
+        # @since 3.17.0
+        #
         REQUEST_FAILED = -32803
         #
         # The server cancelled the request. This error code should
         # only be used for requests that explicitly support being
         # server cancellable.
         #
+        # @since 3.17.0
+        #
         SERVER_CANCELLED = -32802
         #
         # The server detected that the content of a document got
@@ -58,15 +45,10 @@ module LanguageServer
         #
         CONTENT_MODIFIED = -32801
         #
-        # The client has canceled a request and a server as detected
+        # The client has canceled a request and a server has detected
         # the cancel.
         #
         REQUEST_CANCELLED = -32800
-        #
-        # This is the end range of LSP reserved error codes.
-        # It doesn't denote a real error code.
-        #
-        LSP_RESERVED_ERROR_RANGE_END = -32800
       end
     end
   end

data/lib/language_server/protocol/constant/failure_handling_kind.rb

@@ -3,27 +3,26 @@ module LanguageServer
     module Constant
       module FailureHandlingKind
         #
-        # Applying the workspace change is simply aborted if one of the changes
-        # provided fails. All operations executed before the failing operation
-        # stay executed.
+        # Applying the workspace change is simply aborted if one of the changes provided
+        # fails. All operations executed before the failing operation stay executed.
         #
-        ABORT = 'abort'
+        ABORT = "abort"
         #
         # All operations are executed transactional. That means they either all
         # succeed or no changes at all are applied to the workspace.
         #
-        TRANSACTIONAL = 'transactional'
+        TRANSACTIONAL = "transactional"
         #
-        # If the workspace edit contains only textual file changes they are
-        # executed transactional. If resource changes (create, rename or delete
-        # file) are part of the change the failure handling strategy is abort.
+        # If the workspace edit contains only textual file changes they are executed transactional.
+        # If resource changes (create, rename or delete file) are part of the change the failure
+        # handling strategy is abort.
         #
-        TEXT_ONLY_TRANSACTIONAL = 'textOnlyTransactional'
+        TEXT_ONLY_TRANSACTIONAL = "textOnlyTransactional"
         #
         # The client tries to undo the operations already executed. But there is no
         # guarantee that this is succeeding.
         #
-        UNDO = 'undo'
+        UNDO = "undo"
       end
     end
   end

data/lib/language_server/protocol/constant/file_change_type.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Constant
       #
-      # The file event type.
+      # The file event type
       #
       module FileChangeType
         #

data/lib/language_server/protocol/constant/file_operation_pattern_kind.rb

@@ -5,15 +5,17 @@ module LanguageServer
       # A pattern kind describing if a glob pattern matches a file a folder or
       # both.
       #
+      # @since 3.16.0
+      #
       module FileOperationPatternKind
         #
         # The pattern matches a file only.
         #
-        FILE = 'file'
+        FILE = "file"
         #
         # The pattern matches a folder only.
         #
-        FOLDER = 'folder'
+        FOLDER = "folder"
       end
     end
   end

data/lib/language_server/protocol/constant/folding_range_kind.rb

@@ -3,21 +3,20 @@ module LanguageServer
     module Constant
       #
       # A set of predefined range kinds.
-      # The type is a string since the value set is extensible
       #
       module FoldingRangeKind
         #
         # Folding range for a comment
         #
-        COMMENT = 'comment'
+        COMMENT = "comment"
         #
-        # Folding range for imports or includes
+        # Folding range for an import or include
         #
-        IMPORTS = 'imports'
+        IMPORTS = "imports"
         #
         # Folding range for a region (e.g. `#region`)
         #
-        REGION = 'region'
+        REGION = "region"
       end
     end
   end

data/lib/language_server/protocol/constant/inlay_hint_kind.rb

@@ -4,6 +4,8 @@ module LanguageServer
       #
       # Inlay hint kinds.
       #
+      # @since 3.17.0
+      #
       module InlayHintKind
         #
         # An inlay hint that for a type annotation.

data/lib/language_server/protocol/constant/inline_completion_trigger_kind.rb

@@ -0,0 +1,21 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
+      #
+      # @since 3.18.0
+      #
+      module InlineCompletionTriggerKind
+        #
+        # Completion was triggered explicitly by a user gesture.
+        #
+        INVOKED = 1
+        #
+        # Completion was triggered automatically while editing.
+        #
+        AUTOMATIC = 2
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/insert_text_format.rb

@@ -18,6 +18,8 @@ module LanguageServer
         # the end of the snippet. Placeholders with equal identifiers are linked,
         # that is typing in one will update others too.
         #
+        # See also: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#snippet_syntax
+        #
         SNIPPET = 2
       end
     end

data/lib/language_server/protocol/constant/insert_text_mode.rb

@@ -5,6 +5,8 @@ module LanguageServer
       # How whitespace and indentation is handled during completion
       # item insertion.
       #
+      # @since 3.16.0
+      #
       module InsertTextMode
         #
         # The insertion or replace strings is taken as it is. If the

data/lib/language_server/protocol/constant/language_kind.rb

@@ -0,0 +1,83 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      #
+      # Predefined Language kinds
+      # @since 3.18.0
+      #
+      module LanguageKind
+        ABAP = "abap"
+        WINDOWS_BAT = "bat"
+        BIB_TE_X = "bibtex"
+        CLOJURE = "clojure"
+        COFFEESCRIPT = "coffeescript"
+        C = "c"
+        CPP = "cpp"
+        C_SHARP = "csharp"
+        CSS = "css"
+        #
+        # @since 3.18.0
+        #
+        D = "d"
+        #
+        # @since 3.18.0
+        #
+        DELPHI = "pascal"
+        DIFF = "diff"
+        DART = "dart"
+        DOCKERFILE = "dockerfile"
+        ELIXIR = "elixir"
+        ERLANG = "erlang"
+        F_SHARP = "fsharp"
+        GIT_COMMIT = "git-commit"
+        GIT_REBASE = "git-rebase"
+        GO = "go"
+        GROOVY = "groovy"
+        HANDLEBARS = "handlebars"
+        HASKELL = "haskell"
+        HTML = "html"
+        INI = "ini"
+        JAVA = "java"
+        JAVA_SCRIPT = "javascript"
+        JAVA_SCRIPT_REACT = "javascriptreact"
+        JSON = "json"
+        LA_TE_X = "latex"
+        LESS = "less"
+        LUA = "lua"
+        MAKEFILE = "makefile"
+        MARKDOWN = "markdown"
+        OBJECTIVE_C = "objective-c"
+        OBJECTIVE_CPP = "objective-cpp"
+        #
+        # @since 3.18.0
+        #
+        PASCAL = "pascal"
+        PERL = "perl"
+        PERL6 = "perl6"
+        PHP = "php"
+        PLAINTEXT = "plaintext"
+        POWERSHELL = "powershell"
+        PUG = "jade"
+        PYTHON = "python"
+        R = "r"
+        RAZOR = "razor"
+        RUBY = "ruby"
+        RUST = "rust"
+        SCSS = "scss"
+        SASS = "sass"
+        SCALA = "scala"
+        SHADER_LAB = "shaderlab"
+        SHELL_SCRIPT = "shellscript"
+        SQL = "sql"
+        SWIFT = "swift"
+        TYPE_SCRIPT = "typescript"
+        TYPE_SCRIPT_REACT = "typescriptreact"
+        TE_X = "tex"
+        VISUAL_BASIC = "vb"
+        XML = "xml"
+        XSL = "xsl"
+        YAML = "yaml"
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/lsp_error_codes.rb

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Constant
+      module LSPErrorCodes
+        #
+        # A request failed but it was syntactically correct, e.g the
+        # method name was known and the parameters were valid. The error
+        # message should contain human readable information about why
+        # the request failed.
+        #
+        # @since 3.17.0
+        #
+        REQUEST_FAILED = -32803
+        #
+        # The server cancelled the request. This error code should
+        # only be used for requests that explicitly support being
+        # server cancellable.
+        #
+        # @since 3.17.0
+        #
+        SERVER_CANCELLED = -32802
+        #
+        # The server detected that the content of a document got
+        # modified outside normal conditions. A server should
+        # NOT send this error code if it detects a content change
+        # in it unprocessed messages. The result even computed
+        # on an older state might still be useful for the client.
+        #
+        # If a client decides that a result is not of any use anymore
+        # the client should cancel the request.
+        #
+        CONTENT_MODIFIED = -32801
+        #
+        # The client has canceled a request and a server has detected
+        # the cancel.
+        #
+        REQUEST_CANCELLED = -32800
+      end
+    end
+  end
+end

data/lib/language_server/protocol/constant/markup_kind.rb

@@ -12,11 +12,11 @@ module LanguageServer
         #
         # Plain text is supported as a content format
         #
-        PLAIN_TEXT = 'plaintext'
+        PLAIN_TEXT = "plaintext"
         #
         # Markdown is supported as a content format
         #
-        MARKDOWN = 'markdown'
+        MARKDOWN = "markdown"
       end
     end
   end

data/lib/language_server/protocol/constant/message_type.rb

@@ -1,6 +1,9 @@
 module LanguageServer
   module Protocol
     module Constant
+      #
+      # The message type
+      #
       module MessageType
         #
         # An error message.
@@ -18,6 +21,12 @@ module LanguageServer
         # A log message.
         #
         LOG = 4
+        #
+        # A debug message.
+        #
+        # @since 3.18.0
+        #
+        DEBUG = 5
       end
     end
   end