Class: LanguageServer::Protocol::Interface::WorkspaceEdit
- Inherits:
-
Object
- Object
- LanguageServer::Protocol::Interface::WorkspaceEdit
- Defined in:
- lib/language_server/protocol/interface/workspace_edit.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
Instance Method Summary collapse
-
#changes ⇒ { [uri: string]: TextEdit[]; }
Holds changes to existing resources.
-
#document_changes ⇒ TextDocumentEdit[] | (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[]
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.
-
#initialize(changes: nil, document_changes: nil) ⇒ WorkspaceEdit
constructor
A new instance of WorkspaceEdit.
- #to_hash ⇒ Object
- #to_json(*args) ⇒ Object
Constructor Details
#initialize(changes: nil, document_changes: nil) ⇒ WorkspaceEdit
Returns a new instance of WorkspaceEdit.
5 6 7 8 9 10 11 12 |
# File 'lib/language_server/protocol/interface/workspace_edit.rb', line 5 def initialize(changes: nil, document_changes: nil) @attributes = {} @attributes[:changes] = changes if changes @attributes[:documentChanges] = document_changes if document_changes @attributes.freeze end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
39 40 41 |
# File 'lib/language_server/protocol/interface/workspace_edit.rb', line 39 def attributes @attributes end |
Instance Method Details
#changes ⇒ { [uri: string]: TextEdit[]; }
Holds changes to existing resources.
18 19 20 |
# File 'lib/language_server/protocol/interface/workspace_edit.rb', line 18 def changes attributes.fetch(:changes) end |
#document_changes ⇒ TextDocumentEdit[] | (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[]
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.
35 36 37 |
# File 'lib/language_server/protocol/interface/workspace_edit.rb', line 35 def document_changes attributes.fetch(:documentChanges) end |
#to_hash ⇒ Object
41 42 43 |
# File 'lib/language_server/protocol/interface/workspace_edit.rb', line 41 def to_hash attributes end |
#to_json(*args) ⇒ Object
45 46 47 |
# File 'lib/language_server/protocol/interface/workspace_edit.rb', line 45 def to_json(*args) to_hash.to_json(*args) end |