language_server-protocol 3.14.0.2 → 3.16.0.1

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

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressCancelParams
+        def initialize(token:)
+          @attributes = {}
+
+          @attributes[:token] = token
+
+          @attributes.freeze
+        end
+
+        #
+        # The token to be used to report progress.
+        #
+        # @return [ProgressToken]
+        def token
+          attributes.fetch(:token)
+        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/work_done_progress_create_params.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressCreateParams
+        def initialize(token:)
+          @attributes = {}
+
+          @attributes[:token] = token
+
+          @attributes.freeze
+        end
+
+        #
+        # The token to be used to report progress.
+        #
+        # @return [ProgressToken]
+        def token
+          attributes.fetch(:token)
+        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/work_done_progress_end.rb

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressEnd
+        def initialize(kind:, message: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:message] = message if message
+
+          @attributes.freeze
+        end
+
+        # @return ["end"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Optional, a final message indicating to for example indicate the outcome
+        # of the operation.
+        #
+        # @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/work_done_progress_options.rb

@@ -0,0 +1,30 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        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/work_done_progress_params.rb

@@ -0,0 +1,33 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressParams
+        def initialize(work_done_token: nil)
+          @attributes = {}
+
+          @attributes[:workDoneToken] = work_done_token if work_done_token
+
+          @attributes.freeze
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        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/work_done_progress_report.rb

@@ -0,0 +1,70 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkDoneProgressReport
+        def initialize(kind:, cancellable: nil, message: nil, percentage: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:cancellable] = cancellable if cancellable
+          @attributes[:message] = message if message
+          @attributes[:percentage] = percentage if percentage
+
+          @attributes.freeze
+        end
+
+        # @return ["report"]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # Controls enablement state of a cancel button. This property is only valid
+        # if a cancel button got requested in the `WorkDoneProgressStart` payload.
+        #
+        # Clients that don't support cancellation or don't support control the
+        # button's enablement state are allowed to ignore the setting.
+        #
+        # @return [boolean]
+        def cancellable
+          attributes.fetch(:cancellable)
+        end
+
+        #
+        # Optional, more detailed associated progress message. Contains
+        # complementary information to the `title`.
+        #
+        # Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+        # If unset, the previous progress message (if any) is still valid.
+        #
+        # @return [string]
+        def message
+          attributes.fetch(:message)
+        end
+
+        #
+        # Optional progress percentage to display (value 100 is considered 100%).
+        # If not provided infinite progress is assumed and clients are allowed
+        # to ignore the `percentage` value in subsequent in report notifications.
+        #
+        # The value should be steadily rising. Clients are free to ignore values
+        # that are not following this rule. The value range is [0, 100]
+        #
+        # @return [number]
+        def percentage
+          attributes.fetch(:percentage)
+        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/workspace_edit.rb

@@ -2,11 +2,12 @@ module LanguageServer
   module Protocol
     module Interface
       class WorkspaceEdit
-        def initialize(changes: nil, document_changes: nil)
+        def initialize(changes: nil, document_changes: nil, change_annotations: nil)
           @attributes = {}
 
           @attributes[:changes] = changes if changes
           @attributes[:documentChanges] = document_changes if document_changes
+          @attributes[:changeAnnotations] = change_annotations if change_annotations
 
           @attributes.freeze
         end
@@ -14,28 +15,44 @@ module LanguageServer
         #
         # Holds changes to existing resources.
         #
-        # @return [{ [uri: string]: TextEdit[]; }]
+        # @return [{}]
         def changes
           attributes.fetch(:changes)
         end
 
         #
-        # Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
-        # are either an array of `TextDocumentEdit`s to express changes to n different text documents
-        # where each text document edit addresses a specific version of a text document. Or it can contain
-        # above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
+        # Depending on the client capability
+        # `workspace.workspaceEdit.resourceOperations` document changes are either
+        # an array of `TextDocumentEdit`s to express changes to n different text
+        # documents where each text document edit addresses a specific version of
+        # a text document. Or it can contain above `TextDocumentEdit`s mixed with
+        # create, rename and delete file / folder operations.
         #
         # Whether a client supports versioned document edits is expressed via
         # `workspace.workspaceEdit.documentChanges` client capability.
         #
-        # If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
-        # only plain `TextEdit`s using the `changes` property are supported.
+        # If a client neither supports `documentChanges` nor
+        # `workspace.workspaceEdit.resourceOperations` then only plain `TextEdit`s
+        # using the `changes` property are supported.
         #
         # @return [TextDocumentEdit[] | (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[]]
         def document_changes
           attributes.fetch(:documentChanges)
         end
 
+        #
+        # A map of change annotations that can be referenced in
+        # `AnnotatedTextEdit`s or create, rename and delete file / folder
+        # operations.
+        #
+        # Whether clients honor this property depends on the client capability
+        # `workspace.changeAnnotationSupport`.
+        #
+        # @return [{ [id: string]: ChangeAnnotation; }]
+        def change_annotations
+          attributes.fetch(:changeAnnotations)
+        end
+
         attr_reader :attributes
 
         def to_hash

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

@@ -0,0 +1,75 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkspaceEditClientCapabilities
+        def initialize(document_changes: nil, resource_operations: nil, failure_handling: nil, normalizes_line_endings: nil, change_annotation_support: nil)
+          @attributes = {}
+
+          @attributes[:documentChanges] = document_changes if document_changes
+          @attributes[:resourceOperations] = resource_operations if resource_operations
+          @attributes[:failureHandling] = failure_handling if failure_handling
+          @attributes[:normalizesLineEndings] = normalizes_line_endings if normalizes_line_endings
+          @attributes[:changeAnnotationSupport] = change_annotation_support if change_annotation_support
+
+          @attributes.freeze
+        end
+
+        #
+        # The client supports versioned document changes in `WorkspaceEdit`s
+        #
+        # @return [boolean]
+        def document_changes
+          attributes.fetch(:documentChanges)
+        end
+
+        #
+        # The resource operations the client supports. Clients should at least
+        # support 'create', 'rename' and 'delete' files and folders.
+        #
+        # @return [ResourceOperationKind[]]
+        def resource_operations
+          attributes.fetch(:resourceOperations)
+        end
+
+        #
+        # The failure handling strategy of a client if applying the workspace edit
+        # fails.
+        #
+        # @return [FailureHandlingKind]
+        def failure_handling
+          attributes.fetch(:failureHandling)
+        end
+
+        #
+        # Whether the client normalizes line endings to the client specific
+        # setting.
+        # If set to `true` the client will normalize line ending characters
+        # in a workspace edit to the client specific new line character(s).
+        #
+        # @return [boolean]
+        def normalizes_line_endings
+          attributes.fetch(:normalizesLineEndings)
+        end
+
+        #
+        # Whether the client in general supports change annotations on text edits,
+        # create file, rename file and delete file changes.
+        #
+        # @return [{ groupsOnLabel?: boolean; }]
+        def change_annotation_support
+          attributes.fetch(:changeAnnotationSupport)
+        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/workspace_folder.rb

@@ -20,8 +20,8 @@ module LanguageServer
         end
 
         #
-        # The name of the workspace folder. Defaults to the
-        # uri's basename.
+        # The name of the workspace folder. Used to refer to this
+        # workspace folder in the user interface.
         #
         # @return [string]
         def name

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

@@ -0,0 +1,48 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      class WorkspaceFoldersServerCapabilities
+        def initialize(supported: nil, change_notifications: nil)
+          @attributes = {}
+
+          @attributes[:supported] = supported if supported
+          @attributes[:changeNotifications] = change_notifications if change_notifications
+
+          @attributes.freeze
+        end
+
+        #
+        # The server has support for workspace folders
+        #
+        # @return [boolean]
+        def supported
+          attributes.fetch(:supported)
+        end
+
+        #
+        # Whether the server wants to receive workspace folder
+        # change notifications.
+        #
+        # If a string is provided, the string is treated as an ID
+        # under which the notification is registered on the client
+        # side. The ID can be used to unregister for these events
+        # using the `client/unregisterCapability` request.
+        #
+        # @return [string | boolean]
+        def change_notifications
+          attributes.fetch(:changeNotifications)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end