Add WorkspaceEditMetadata support (#1881)

Add types from matching vscode-langaugeserver-node PR Co-authored-by: Dirk Bäumer <dirkb@microsoft.com>
microsoft · Jan 31, 2024 · b9c4429 · b9c4429
1 parent 62a1fbc
commit b9c4429
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/_data/linkableTypes.yml b/_data/linkableTypes.yml
@@ -256,6 +256,8 @@
     link: '#workspace_applyEdit'
   - type: 'ApplyWorkspaceEditParams'
     link: '#applyWorkspaceEditParams'
+  - type: 'WorkspaceEditMetadata'
+    link: '#workspaceEditMetadata'
   - type: 'ApplyWorkspaceEditResult'
     link: '#applyWorkspaceEditResult'
   - type: 'ApplyWorkspaceEditResponse'

diff --git a/_specifications/lsp/3.18/types/workspaceEdit.md b/_specifications/lsp/3.18/types/workspaceEdit.md
@@ -105,6 +105,14 @@ export interface WorkspaceEditClientCapabilities {
 		 */
 		groupsOnLabel?: boolean;
 	};
+
+	/**
+	 * Whether the client supports `WorkspaceEditMetadata` in `WorkspaceEdit`s.
+	 *
+	 * @since 3.18.0
+	 * @proposed
+	 */
+	metadataSupport?: boolean;
 }
 ```
 

diff --git a/_specifications/lsp/3.18/workspace/applyEdit.md b/_specifications/lsp/3.18/workspace/applyEdit.md
@@ -27,6 +27,31 @@ export interface ApplyWorkspaceEditParams {
 	 * The edits to apply.
 	 */
 	edit: WorkspaceEdit;
+
+	/**
+	 * Additional data about the edit.
+	 *
+	 * @since 3.18.0
+	 * @proposed
+	 */
+	metadata?: WorkspaceEditMetadata;
+}
+```
+
+<div class="anchorHolder"><a href="#workspaceEditMetadata" name="workspaceEditMetadata" class="linkableAnchor"></a></div>
+
+```typescript
+/**
+ * Additional data about a workspace edit.
+ *
+ * @since 3.18.0
+ * @proposed
+ */
+export interface WorkspaceEditMetadata {
+	/**
+	 * Signal to the editor that this edit is a refactoring.
+	 */
+	isRefactoring?: boolean;
 }
 ```