Implement deleting right at end of line includes leading whitespace

Author: alexdima

src/vs/editor/common/config/editorOptions.ts

@@ -726,6 +726,11 @@ export interface IEditorOptions {
 	 * Inserting and deleting whitespace follows tab stops.
 	 */
 	useTabStops?: boolean;
+	/**
+	 * Controls whether the editor should automatically remove indentation whitespace when joining lines with Delete.
+	 * Defaults to false.
+	 */
+	trimWhitespaceOnDelete?: boolean;
 	/**
 	 * The font family
 	 */
@@ -5710,6 +5715,7 @@ export const enum EditorOption {
 	suggestSelection,
 	tabCompletion,
 	tabIndex,
+	trimWhitespaceOnDelete,
 	unicodeHighlighting,
 	unusualLineTerminators,
 	useShadowDOM,
@@ -6492,6 +6498,10 @@ export const EditorOptions = {
 		EditorOption.tabIndex, 'tabIndex',
 		0, -1, Constants.MAX_SAFE_SMALL_INTEGER
 	)),
+	trimWhitespaceOnDelete: register(new EditorBooleanOption(
+		EditorOption.trimWhitespaceOnDelete, 'trimWhitespaceOnDelete', false,
+		{ description: nls.localize('trimWhitespaceOnDelete', "Controls whether the editor will also delete the next line's indentation whitespace when deleting a newline.") }
+	)),
 	unicodeHighlight: register(new UnicodeHighlight()),
 	unusualLineTerminators: register(new EditorStringEnumOption(
 		EditorOption.unusualLineTerminators, 'unusualLineTerminators',

src/vs/editor/common/cursor/cursorDeleteOperations.ts

@@ -23,18 +23,7 @@ export class DeleteOperations {
 		for (let i = 0, len = selections.length; i < len; i++) {
 			const selection = selections[i];
 
-			let deleteSelection: Range = selection;
-
-			if (deleteSelection.isEmpty()) {
-				const position = selection.getPosition();
-				const rightOfPosition = MoveOperations.right(config, model, position);
-				deleteSelection = new Range(
-					rightOfPosition.lineNumber,
-					rightOfPosition.column,
-					position.lineNumber,
-					position.column
-				);
-			}
+			const deleteSelection = this.getDeleteRightRange(selection, model, config);
 
 			if (deleteSelection.isEmpty()) {
 				// Probably at end of file => ignore
@@ -51,6 +40,37 @@ export class DeleteOperations {
 		return [shouldPushStackElementBefore, commands];
 	}
 
+	private static getDeleteRightRange(selection: Selection, model: ICursorSimpleModel, config: CursorConfiguration): Range {
+		if (!selection.isEmpty()) {
+			return selection;
+		}
+
+		const position = selection.getPosition();
+		const rightOfPosition = MoveOperations.right(config, model, position);
+
+		if (config.trimWhitespaceOnDelete && rightOfPosition.lineNumber !== position.lineNumber) {
+			// Smart line join (deleting leading whitespace) is on
+			// (and) Delete is happening at the end of a line
+			const firstNonWhitespaceColumn = model.getLineFirstNonWhitespaceColumn(rightOfPosition.lineNumber);
+			if (firstNonWhitespaceColumn > 0) {
+				// The next line has content
+				return new Range(
+					rightOfPosition.lineNumber,
+					firstNonWhitespaceColumn,
+					position.lineNumber,
+					position.column
+				);
+			}
+		}
+
+		return new Range(
+			rightOfPosition.lineNumber,
+			rightOfPosition.column,
+			position.lineNumber,
+			position.column
+		);
+	}
+
 	public static isAutoClosingPairDelete(
 		autoClosingDelete: EditorAutoClosingEditStrategy,
 		autoClosingBrackets: EditorAutoClosingStrategy,
@@ -150,7 +170,7 @@ export class DeleteOperations {
 		const commands: Array<ICommand | null> = [];
 		let shouldPushStackElementBefore = (prevEditOperationType !== EditOperationType.DeletingLeft);
 		for (let i = 0, len = selections.length; i < len; i++) {
-			const deleteRange = DeleteOperations.getDeleteRange(selections[i], model, config);
+			const deleteRange = DeleteOperations.getDeleteLeftRange(selections[i], model, config);
 
 			// Ignore empty delete ranges, as they have no effect
 			// They happen if the cursor is at the beginning of the file.
@@ -169,43 +189,13 @@ export class DeleteOperations {
 
 	}
 
-	private static getDeleteRange(selection: Selection, model: ICursorSimpleModel, config: CursorConfiguration,): Range {
-		const position = selection.getPosition();
-		const startPosition = selection.getSelectionStart();
-
-		const startLineNumber = Math.min(startPosition.lineNumber, position.lineNumber);
-		const endLineNumber = Math.max(startPosition.lineNumber, position.lineNumber);
-		let startColumn = position.column;
-		let endColumn = startPosition.column;
-		if (startLineNumber === startPosition.lineNumber) {
-			//top down deletion
-			startColumn = startPosition.column;
-			endColumn = position.column;
-		}
-		let firstNonWhiteSpaceColumn = model.getLineFirstNonWhitespaceColumn(endLineNumber);
-		let lastNonWhiteSpaceColumn = model.getLineLastNonWhitespaceColumn(startLineNumber);
-		//deleting new line character + trimming white space
-		if (startLineNumber !== endLineNumber && model.getLineContent(startLineNumber).length > 0) {
-			//expand delete range to include extra white space (last non whitespace char to first non white char on following line)
-			if (startColumn < lastNonWhiteSpaceColumn) {
-				lastNonWhiteSpaceColumn = startColumn;
-			}
-			if (endColumn > firstNonWhiteSpaceColumn) {
-				firstNonWhiteSpaceColumn = endColumn;
-			}
-			if (/^[ \t]*$/.test(model.getLineContent(startLineNumber))) {
-				//if line with '\n' character has only spaces/tabs -- no need to trim left side
-				return Range.fromPositions(new Position(startLineNumber, startColumn),
-					new Position(endLineNumber, firstNonWhiteSpaceColumn));
-			}
-			return Range.fromPositions(new Position(startLineNumber, lastNonWhiteSpaceColumn),
-				new Position(endLineNumber, firstNonWhiteSpaceColumn));
-		}
-
+	private static getDeleteLeftRange(selection: Selection, model: ICursorSimpleModel, config: CursorConfiguration): Range {
 		if (!selection.isEmpty()) {
 			return selection;
 		}
 
+		const position = selection.getPosition();
+
 		// Unintend when using tab stops and cursor is within indentation
 		if (config.useTabStops && position.column > 1) {
 			const lineContent = model.getLineContent(position.lineNumber);

src/vs/editor/common/cursorCommon.ts

@@ -60,6 +60,7 @@ export class CursorConfiguration {
 	public readonly lineHeight: number;
 	public readonly typicalHalfwidthCharacterWidth: number;
 	public readonly useTabStops: boolean;
+	public readonly trimWhitespaceOnDelete: boolean;
 	public readonly wordSeparators: string;
 	public readonly emptySelectionClipboard: boolean;
 	public readonly copyWithSyntaxHighlighting: boolean;
@@ -98,6 +99,7 @@ export class CursorConfiguration {
 			|| e.hasChanged(EditorOption.autoClosingOvertype)
 			|| e.hasChanged(EditorOption.autoSurround)
 			|| e.hasChanged(EditorOption.useTabStops)
+			|| e.hasChanged(EditorOption.trimWhitespaceOnDelete)
 			|| e.hasChanged(EditorOption.fontInfo)
 			|| e.hasChanged(EditorOption.readOnly)
 			|| e.hasChanged(EditorOption.wordSegmenterLocales)
@@ -126,6 +128,7 @@ export class CursorConfiguration {
 		this.typicalHalfwidthCharacterWidth = fontInfo.typicalHalfwidthCharacterWidth;
 		this.pageSize = Math.max(1, Math.floor(layoutInfo.height / this.lineHeight) - 2);
 		this.useTabStops = options.get(EditorOption.useTabStops);
+		this.trimWhitespaceOnDelete = options.get(EditorOption.trimWhitespaceOnDelete);
 		this.wordSeparators = options.get(EditorOption.wordSeparators);
 		this.emptySelectionClipboard = options.get(EditorOption.emptySelectionClipboard);
 		this.copyWithSyntaxHighlighting = options.get(EditorOption.copyWithSyntaxHighlighting);

src/vs/editor/common/standalone/standaloneEnums.ts

@@ -311,37 +311,38 @@ export enum EditorOption {
 	suggestSelection = 134,
 	tabCompletion = 135,
 	tabIndex = 136,
-	unicodeHighlighting = 137,
-	unusualLineTerminators = 138,
-	useShadowDOM = 139,
-	useTabStops = 140,
-	wordBreak = 141,
-	wordSegmenterLocales = 142,
-	wordSeparators = 143,
-	wordWrap = 144,
-	wordWrapBreakAfterCharacters = 145,
-	wordWrapBreakBeforeCharacters = 146,
-	wordWrapColumn = 147,
-	wordWrapOverride1 = 148,
-	wordWrapOverride2 = 149,
-	wrappingIndent = 150,
-	wrappingStrategy = 151,
-	showDeprecated = 152,
-	inertialScroll = 153,
-	inlayHints = 154,
-	wrapOnEscapedLineFeeds = 155,
-	effectiveCursorStyle = 156,
-	editorClassName = 157,
-	pixelRatio = 158,
-	tabFocusMode = 159,
-	layoutInfo = 160,
-	wrappingInfo = 161,
-	defaultColorDecorators = 162,
-	colorDecoratorsActivatedOn = 163,
-	inlineCompletionsAccessibilityVerbose = 164,
-	effectiveEditContext = 165,
-	scrollOnMiddleClick = 166,
-	effectiveAllowVariableFonts = 167
+	trimWhitespaceOnDelete = 137,
+	unicodeHighlighting = 138,
+	unusualLineTerminators = 139,
+	useShadowDOM = 140,
+	useTabStops = 141,
+	wordBreak = 142,
+	wordSegmenterLocales = 143,
+	wordSeparators = 144,
+	wordWrap = 145,
+	wordWrapBreakAfterCharacters = 146,
+	wordWrapBreakBeforeCharacters = 147,
+	wordWrapColumn = 148,
+	wordWrapOverride1 = 149,
+	wordWrapOverride2 = 150,
+	wrappingIndent = 151,
+	wrappingStrategy = 152,
+	showDeprecated = 153,
+	inertialScroll = 154,
+	inlayHints = 155,
+	wrapOnEscapedLineFeeds = 156,
+	effectiveCursorStyle = 157,
+	editorClassName = 158,
+	pixelRatio = 159,
+	tabFocusMode = 160,
+	layoutInfo = 161,
+	wrappingInfo = 162,
+	defaultColorDecorators = 163,
+	colorDecoratorsActivatedOn = 164,
+	inlineCompletionsAccessibilityVerbose = 165,
+	effectiveEditContext = 166,
+	scrollOnMiddleClick = 167,
+	effectiveAllowVariableFonts = 168
 }
 
 /**

src/vs/editor/test/browser/controller/cursor.test.ts

@@ -5604,30 +5604,6 @@ suite('Editor Controller', () => {
 		});
 	});
 
-	test('feature request - #134898: Trimming whitespace when deleting newline character', () => {
-		const model = createTextModel(
-			[
-				'Hello world!',
-				'    ',
-				'    another line'
-			].join('\n'),
-			undefined,
-			{
-				insertSpaces: false
-			},
-		);
-		withTestCodeEditor(model, {}, (editor, viewModel) => {
-			viewModel.setSelections('test', [new Selection(2, 5, 3, 1)]);
-			//when deleting middle empty line -- no text present so left spaces/tabs preserved
-			CoreEditingCommands.DeleteLeft.runEditorCommand(null, editor, null);
-			assert.strictEqual(model.getLineContent(2), '    another line');
-			//removes the extra white space in front of line 2 when deleting new line character
-			viewModel.setSelections('test', [new Selection(1, 13, 2, 1)]);
-			CoreEditingCommands.DeleteLeft.runEditorCommand(null, editor, null);
-			assert.strictEqual(model.getLineContent(1), 'Hello world!another line');
-		});
-	});
-
 	test('issue #78527 - does not close quote on odd count', () => {
 		usingCursor({
 			text: [

src/vs/monaco.d.ts

@@ -3859,6 +3859,11 @@ declare namespace monaco.editor {
 		 * Inserting and deleting whitespace follows tab stops.
 		 */
 		useTabStops?: boolean;
+		/**
+		 * Controls whether the editor should automatically remove indentation whitespace when joining lines with Delete.
+		 * Defaults to false.
+		 */
+		trimWhitespaceOnDelete?: boolean;
 		/**
 		 * The font family
 		 */
@@ -5159,37 +5164,38 @@ declare namespace monaco.editor {
 		suggestSelection = 134,
 		tabCompletion = 135,
 		tabIndex = 136,
-		unicodeHighlighting = 137,
-		unusualLineTerminators = 138,
-		useShadowDOM = 139,
-		useTabStops = 140,
-		wordBreak = 141,
-		wordSegmenterLocales = 142,
-		wordSeparators = 143,
-		wordWrap = 144,
-		wordWrapBreakAfterCharacters = 145,
-		wordWrapBreakBeforeCharacters = 146,
-		wordWrapColumn = 147,
-		wordWrapOverride1 = 148,
-		wordWrapOverride2 = 149,
-		wrappingIndent = 150,
-		wrappingStrategy = 151,
-		showDeprecated = 152,
-		inertialScroll = 153,
-		inlayHints = 154,
-		wrapOnEscapedLineFeeds = 155,
-		effectiveCursorStyle = 156,
-		editorClassName = 157,
-		pixelRatio = 158,
-		tabFocusMode = 159,
-		layoutInfo = 160,
-		wrappingInfo = 161,
-		defaultColorDecorators = 162,
-		colorDecoratorsActivatedOn = 163,
-		inlineCompletionsAccessibilityVerbose = 164,
-		effectiveEditContext = 165,
-		scrollOnMiddleClick = 166,
-		effectiveAllowVariableFonts = 167
+		trimWhitespaceOnDelete = 137,
+		unicodeHighlighting = 138,
+		unusualLineTerminators = 139,
+		useShadowDOM = 140,
+		useTabStops = 141,
+		wordBreak = 142,
+		wordSegmenterLocales = 143,
+		wordSeparators = 144,
+		wordWrap = 145,
+		wordWrapBreakAfterCharacters = 146,
+		wordWrapBreakBeforeCharacters = 147,
+		wordWrapColumn = 148,
+		wordWrapOverride1 = 149,
+		wordWrapOverride2 = 150,
+		wrappingIndent = 151,
+		wrappingStrategy = 152,
+		showDeprecated = 153,
+		inertialScroll = 154,
+		inlayHints = 155,
+		wrapOnEscapedLineFeeds = 156,
+		effectiveCursorStyle = 157,
+		editorClassName = 158,
+		pixelRatio = 159,
+		tabFocusMode = 160,
+		layoutInfo = 161,
+		wrappingInfo = 162,
+		defaultColorDecorators = 163,
+		colorDecoratorsActivatedOn = 164,
+		inlineCompletionsAccessibilityVerbose = 165,
+		effectiveEditContext = 166,
+		scrollOnMiddleClick = 167,
+		effectiveAllowVariableFonts = 168
 	}
 
 	export const EditorOptions: {
@@ -5336,6 +5342,7 @@ declare namespace monaco.editor {
 		suggestSelection: IEditorOption<EditorOption.suggestSelection, 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix'>;
 		tabCompletion: IEditorOption<EditorOption.tabCompletion, 'on' | 'off' | 'onlySnippets'>;
 		tabIndex: IEditorOption<EditorOption.tabIndex, number>;
+		trimWhitespaceOnDelete: IEditorOption<EditorOption.trimWhitespaceOnDelete, boolean>;
 		unicodeHighlight: IEditorOption<EditorOption.unicodeHighlighting, any>;
 		unusualLineTerminators: IEditorOption<EditorOption.unusualLineTerminators, 'off' | 'auto' | 'prompt'>;
 		useShadowDOM: IEditorOption<EditorOption.useShadowDOM, boolean>;