microsoft · mjbvz · Jan 31, 2025 · Nov 20, 2024 · Dec 12, 2024 · Dec 13, 2024
diff --git a/extensions/vscode-api-tests/src/singlefolder-tests/editor.test.ts b/extensions/vscode-api-tests/src/singlefolder-tests/editor.test.ts
@@ -94,6 +94,37 @@ suite('vscode API - editors', () => {
 		});
 	});
 
+	/**
+	 * Given :
+	 * This is line 1
+	 *   |
+	 *
+	 * Expect :
+	 * This is line 1
+	 *   This is line 2
+	 *   This is line 3
+	 *
+	 * The 3rd line should not be auto-indented, as the edit already
+	 * contains the necessary adjustment.
+	 */
+	test('insert snippet with replacement, avoid adjusting indentation', () => {
+		const snippetString = new SnippetString()
+			.appendText('This is line 2\n  This is line 3');
+
+		return withRandomFileEditor('This is line 1\n  ', (editor, doc) => {
+			editor.selection = new Selection(
+				new Position(1, 3),
+				new Position(1, 3)
+			);
+
+			return editor.insertSnippet(snippetString, undefined, { undoStopAfter: false, undoStopBefore: false, keepWhitespace: true }).then(inserted => {
+				assert.ok(inserted);
+				assert.strictEqual(doc.getText(), 'This is line 1\n  This is line 2\n  This is line 3');
+				assert.ok(doc.isDirty);
+			});
+		});
+	});
+
 	test('insert snippet with replacement, selection as argument', () => {
 		const snippetString = new SnippetString()
 			.appendText('has been');

diff --git a/extensions/vscode-api-tests/src/singlefolder-tests/workspace.test.ts b/extensions/vscode-api-tests/src/singlefolder-tests/workspace.test.ts
@@ -1226,6 +1226,27 @@ suite('vscode API - workspace', () => {
 		assert.deepStrictEqual(edt.selections, [new vscode.Selection(0, 0, 0, 3)]);
 	});
 
+	test('SnippetString in WorkspaceEdit with keepWhitespace', async function (): Promise<any> {
+		const file = await createRandomFile('This is line 1\n  ');
+
+		const document = await vscode.workspace.openTextDocument(file);
+		const edt = await vscode.window.showTextDocument(document);
+
+		assert.ok(edt === vscode.window.activeTextEditor);
+
+		const snippetText = new vscode.SnippetTextEdit(new vscode.Range(1, 3, 1, 3), new vscode.SnippetString('This is line 2\n  This is line 3'));
+		snippetText.keepWhitespace = true;
+		const we = new vscode.WorkspaceEdit();
+		we.set(document.uri, [snippetText]);
+		const success = await vscode.workspace.applyEdit(we);
+		if (edt !== vscode.window.activeTextEditor) {
+			return this.skip();
+		}
+
+		assert.ok(success);
+		assert.strictEqual(document.getText(), 'This is line 1\n  This is line 2\n  This is line 3');
+	});
+
 	test('Support creating binary files in a WorkspaceEdit', async function (): Promise<any> {
 
 		const fileUri = vscode.Uri.parse(`${testFs.scheme}:/${rndName()}`);

diff --git a/src/vs/editor/browser/services/bulkEditService.ts b/src/vs/editor/browser/services/bulkEditService.ts
@@ -55,7 +55,7 @@ export class ResourceTextEdit extends ResourceEdit implements IWorkspaceTextEdit
 
 	constructor(
 		readonly resource: URI,
-		readonly textEdit: TextEdit & { insertAsSnippet?: boolean },
+		readonly textEdit: TextEdit & { insertAsSnippet?: boolean; keepWhitespace?: boolean },
 		readonly versionId: number | undefined = undefined,
 		metadata?: WorkspaceEditMetadata,
 	) {

diff --git a/src/vs/editor/common/languages.ts b/src/vs/editor/common/languages.ts
@@ -1795,7 +1795,7 @@ export interface IWorkspaceFileEdit {
 
 export interface IWorkspaceTextEdit {
 	resource: URI;
-	textEdit: TextEdit & { insertAsSnippet?: boolean };
+	textEdit: TextEdit & { insertAsSnippet?: boolean; keepWhitespace?: boolean };
 	versionId: number | undefined;
 	metadata?: WorkspaceEditMetadata;
 }

diff --git a/src/vs/editor/contrib/snippet/browser/snippetSession.ts b/src/vs/editor/contrib/snippet/browser/snippetSession.ts
@@ -375,6 +375,7 @@ const _defaultOptions: ISnippetSessionInsertOptions = {
 export interface ISnippetEdit {
 	range: Range;
 	template: string;
+	keepWhitespace?: boolean;
 }
 
 export class SnippetSession {
@@ -569,7 +570,7 @@ export class SnippetSession {
 		let offset = 0;
 		for (let i = 0; i < snippetEdits.length; i++) {
 
-			const { range, template } = snippetEdits[i];
+			const { range, template, keepWhitespace } = snippetEdits[i];
 
 			// gaps between snippet edits are appended as text nodes. this
 			// ensures placeholder-offsets are later correct
@@ -582,7 +583,7 @@ export class SnippetSession {
 			}
 
 			const newNodes = parser.parseFragment(template, snippet);
-			SnippetSession.adjustWhitespace(model, range.getStartPosition(), true, snippet, new Set(newNodes));
+			SnippetSession.adjustWhitespace(model, range.getStartPosition(), keepWhitespace !== undefined ? !keepWhitespace : adjustWhitespace, snippet, new Set(newNodes));
 			snippet.resolveVariables(resolver);
 
 			const snippetText = snippet.toString();

diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -7973,6 +7973,7 @@ declare namespace monaco.languages {
 		resource: Uri;
 		textEdit: TextEdit & {
 			insertAsSnippet?: boolean;
+			keepWhitespace?: boolean;
 		};
 		versionId: number | undefined;
 		metadata?: WorkspaceEditMetadata;

diff --git a/src/vs/workbench/api/browser/mainThreadEditor.ts b/src/vs/workbench/api/browser/mainThreadEditor.ts
@@ -14,7 +14,7 @@ import { ITextModel, ITextModelUpdateOptions } from '../../../editor/common/mode
 import { ISingleEditOperation } from '../../../editor/common/core/editOperation.js';
 import { IModelService } from '../../../editor/common/services/model.js';
 import { SnippetController2 } from '../../../editor/contrib/snippet/browser/snippetController2.js';
-import { IApplyEditsOptions, IEditorPropertiesChangeData, IResolvedTextEditorConfiguration, ITextEditorConfigurationUpdate, IUndoStopOptions, TextEditorRevealType } from '../common/extHost.protocol.js';
+import { IApplyEditsOptions, IEditorPropertiesChangeData, IResolvedTextEditorConfiguration, ISnippetOptions, ITextEditorConfigurationUpdate, TextEditorRevealType } from '../common/extHost.protocol.js';
 import { IEditorPane } from '../../common/editor.js';
 import { equals } from '../../../base/common/arrays.js';
 import { CodeEditorStateFlag, EditorState } from '../../../editor/contrib/editorState/browser/editorState.js';
@@ -509,7 +509,7 @@ export class MainThreadTextEditor {
 		return true;
 	}
 
-	async insertSnippet(modelVersionId: number, template: string, ranges: readonly IRange[], opts: IUndoStopOptions) {
+	async insertSnippet(modelVersionId: number, template: string, ranges: readonly IRange[], opts: ISnippetOptions) {
 
 		if (!this._codeEditor || !this._codeEditor.hasModel()) {
 			return false;
@@ -542,6 +542,7 @@ export class MainThreadTextEditor {
 		snippetController.apply(edits, {
 			overwriteBefore: 0, overwriteAfter: 0,
 			undoStopBefore: opts.undoStopBefore, undoStopAfter: opts.undoStopAfter,
+			adjustWhitespace: !opts.keepWhitespace,
 			clipboardText
 		});
 

diff --git a/src/vs/workbench/api/common/extHost.protocol.ts b/src/vs/workbench/api/common/extHost.protocol.ts
@@ -261,6 +261,9 @@ export interface IApplyEditsOptions extends IUndoStopOptions {
 	setEndOfLine?: EndOfLineSequence;
 }
 
+export interface ISnippetOptions extends IUndoStopOptions {
+	keepWhitespace?: boolean;
+}
 export interface ITextDocumentShowOptions {
 	position?: EditorGroupColumn;
 	preserveFocus?: boolean;

diff --git a/src/vs/workbench/api/common/extHostTextEditor.ts b/src/vs/workbench/api/common/extHostTextEditor.ts
@@ -495,7 +495,7 @@ export class ExtHostTextEditor {
 				return that._applyEdit(edit);
 			},
 			// --- snippet edit
-			insertSnippet(snippet: SnippetString, where?: Position | readonly Position[] | Range | readonly Range[], options: { undoStopBefore: boolean; undoStopAfter: boolean } = { undoStopBefore: true, undoStopAfter: true }): Promise<boolean> {
+			insertSnippet(snippet: SnippetString, where?: Position | readonly Position[] | Range | readonly Range[], options: { undoStopBefore: boolean; undoStopAfter: boolean; keepWhitespace?: boolean } = { undoStopBefore: true, undoStopAfter: true }): Promise<boolean> {
 				if (that._disposed) {
 					return Promise.reject(new Error('TextEditor#insertSnippet not possible on closed editors'));
 				}
@@ -521,6 +521,9 @@ export class ExtHostTextEditor {
 						}
 					}
 				}
+				if (options.keepWhitespace === undefined) {
+					options.keepWhitespace = false;
+				}
 				return _proxy.$tryInsertSnippet(id, document.value.version, snippet.value, ranges, options);
 			},
 			setDecorations(decorationType: vscode.TextEditorDecorationType, ranges: Range[] | vscode.DecorationOptions[]): void {

diff --git a/src/vs/workbench/api/common/extHostTypeConverters.ts b/src/vs/workbench/api/common/extHostTypeConverters.ts
@@ -657,7 +657,8 @@ export namespace WorkspaceEdit {
 						textEdit: {
 							range: Range.from(entry.range),
 							text: entry.edit.value,
-							insertAsSnippet: true
+							insertAsSnippet: true,
+							keepWhitespace: entry.keepWhitespace
 						},
 						versionId: !toCreate.has(entry.uri) ? versionInfo?.getTextDocumentVersion(entry.uri) : undefined,
 						metadata: entry.metadata

diff --git a/src/vs/workbench/api/common/extHostTypes.ts b/src/vs/workbench/api/common/extHostTypes.ts
@@ -766,6 +766,8 @@ export class SnippetTextEdit implements vscode.SnippetTextEdit {
 
 	snippet: SnippetString;
 
+	keepWhitespace?: boolean;
+
 	constructor(range: Range, snippet: SnippetString) {
 		this.range = range;
 		this.snippet = snippet;
@@ -809,6 +811,7 @@ export interface IFileSnippetTextEdit {
 	readonly range: vscode.Range;
 	readonly edit: vscode.SnippetString;
 	readonly metadata?: vscode.WorkspaceEditEntryMetadata;
+	readonly keepWhitespace?: boolean;
 }
 
 export interface IFileCellEdit {
@@ -938,7 +941,7 @@ export class WorkspaceEdit implements vscode.WorkspaceEdit {
 						this.replaceNotebookCells(uri, edit.range, edit.newCells, metadata);
 					}
 				} else if (SnippetTextEdit.isSnippetTextEdit(edit)) {
-					this._edits.push({ _type: FileEditType.Snippet, uri, range: edit.range, edit: edit.snippet, metadata });
+					this._edits.push({ _type: FileEditType.Snippet, uri, range: edit.range, edit: edit.snippet, metadata, keepWhitespace: edit.keepWhitespace });
 
 				} else {
 					this._edits.push({ _type: FileEditType.Text, uri, edit, metadata });

diff --git a/src/vs/workbench/contrib/bulkEdit/browser/bulkTextEdits.ts b/src/vs/workbench/contrib/bulkEdit/browser/bulkTextEdits.ts
@@ -25,7 +25,7 @@ import { ISnippetEdit } from '../../../../editor/contrib/snippet/browser/snippet
 
 type ValidationResult = { canApply: true } | { canApply: false; reason: URI };
 
-type ISingleSnippetEditOperation = ISingleEditOperation & { insertAsSnippet?: boolean };
+type ISingleSnippetEditOperation = ISingleEditOperation & { insertAsSnippet?: boolean; keepWhitespace?: boolean };
 
 class ModelEditTask implements IDisposable {
 
@@ -80,7 +80,7 @@ class ModelEditTask implements IDisposable {
 		} else {
 			range = Range.lift(textEdit.range);
 		}
-		this._edits.push({ ...EditOperation.replaceMove(range, textEdit.text), insertAsSnippet: textEdit.insertAsSnippet });
+		this._edits.push({ ...EditOperation.replaceMove(range, textEdit.text), insertAsSnippet: textEdit.insertAsSnippet, keepWhitespace: textEdit.keepWhitespace });
 	}
 
 	validate(): ValidationResult {
@@ -152,7 +152,8 @@ class EditorEditTask extends ModelEditTask {
 					if (edit.range && edit.text !== null) {
 						snippetEdits.push({
 							range: Range.lift(edit.range),
-							template: edit.insertAsSnippet ? edit.text : SnippetParser.escape(edit.text)
+							template: edit.insertAsSnippet ? edit.text : SnippetParser.escape(edit.text),
+							keepWhitespace: edit.keepWhitespace
 						});
 					}
 				}

@@ -1312,6 +1312,10 @@ declare module 'vscode' {
 			 * Add undo stop after making the edits.
 			 */
 			readonly undoStopAfter: boolean;
+			/**
+			 * Keep whitespace of the {@link SnippetString.value} as is.
+			 */
+			readonly keepWhitespace?: boolean;
 		}): Thenable<boolean>;
 
 		/**
@@ -3776,6 +3780,11 @@ declare module 'vscode' {
 		 */
 		snippet: SnippetString;
 
+		/**
+		 * Whether the snippet edit should be applied with existing whitespace preserved.
+		 */
+		keepWhitespace?: boolean;
+
 		/**
 		 * Create a new snippet edit.
 		 *