language-servers/language-server-protocol
1
0
Fork 0
mirror of https://github.com/microsoft/language-server-protocol.git synced 2025-12-23 08:48:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make WorkspaceEdit backwards compatible

Browse source
This commit is contained in:
Dirk Baeumer 2017-02-28 22:15:56 +01:00
parent a060f44ace
commit f4d7732e9c
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
protocol.md
View file

@ -18,7 +18,8 @@ The 1.x version of this document can be found [here](https://github.com/Microsof
### 02/28/2017
Updated the specification to correctly describe the breaking changes from 2.x to 3.x around `WorkspaceEdit`and `TextDocumentEdit`.
* Make the `WorkspaceEdit` changes backwards compatible.
* Updated the specification to correctly describe the breaking changes from 2.x to 3.x around `WorkspaceEdit`and `TextDocumentEdit`.
## Messages overview
@ -449,14 +450,21 @@ export interface TextDocumentEdit {
#### WorkspaceEdit
> **Breaking** A workspace edit represents changes to many resources managed in the workspace. A workspace edit now consists of an array of `TextDocumentEdit`s each describing a change to a single text document.
> **Changed** A workspace edit represents changes to many resources managed in the workspace. The edit should either provide `changes` or `documentChanges`. If documentChanges are present they are preferred over `changes` if the client can handle versioned document edits.
```typescript
interface WorkspaceEdit {
export interface WorkspaceEdit {
/**
* Holds changes to existing resources.
*/
changes: TextDocumentEdit[];
changes?: { [uri: string]: TextEdit[]; };
/**
* An array of `TextDocumentEdit`s to express changes to specific a specific
* version of a text document. Whether a client supports versioned document
* edits is expressed via `WorkspaceClientCapabilites.versionedWorkspaceEdit`.
*/
documentChanges?: TextDocumentEdit[];
}
```