editor.guides.bracketPairs: 'active' | 'all' | 'none' -> boolean | 'active'

Author: hediet

src/vs/editor/browser/viewParts/indentGuides/indentGuides.ts

@@ -105,7 +105,7 @@ export class IndentGuidesOverlay extends DynamicViewOverlay {
 	// --- end event handlers
 
 	public prepareRender(ctx: RenderingContext): void {
-		if (!this._bracketPairGuideOptions.indentation && !this._bracketPairGuideOptions.bracketPairs) {
+		if (!this._bracketPairGuideOptions.indentation && this._bracketPairGuideOptions.bracketPairs === false) {
 			this._renderResult = null;
 			return;
 		}
@@ -155,19 +155,19 @@ export class IndentGuidesOverlay extends DynamicViewOverlay {
 		visibleEndLineNumber: number,
 		activeCursorPosition: Position | null
 	): IndentGuide[][] {
-		const bracketGuides = this._bracketPairGuideOptions.bracketPairs !== 'none'
+		const bracketGuides = this._bracketPairGuideOptions.bracketPairs !== false
 			? this._context.model.getBracketGuidesInRangeByLine(
 				visibleStartLineNumber,
 				visibleEndLineNumber,
 				activeCursorPosition,
 				{
 					highlightActive: this._bracketPairGuideOptions.highlightActiveBracketPair,
-					horizontalGuides: this._bracketPairGuideOptions.bracketPairsHorizontal === 'all'
+					horizontalGuides: this._bracketPairGuideOptions.bracketPairsHorizontal === true
 						? HorizontalGuidesState.Enabled
 						: this._bracketPairGuideOptions.bracketPairsHorizontal === 'active'
 							? HorizontalGuidesState.EnabledForActive
 							: HorizontalGuidesState.Disabled,
-					includeInactive: this._bracketPairGuideOptions.bracketPairs === 'all',
+					includeInactive: this._bracketPairGuideOptions.bracketPairs === true,
 				}
 			)
 			: null;

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

@@ -278,11 +278,6 @@ function migrateOptions(options: IEditorOptions): void {
 	};
 	if (!options.guides) {
 		options.guides = {};
-	} else {
-		// migrate bracketPairs: boolean -> : 'all' | 'active' | 'none'
-		if (options.guides.bracketPairs as any === true) {
-			options.guides.bracketPairs = 'all';
-		}
 	}
 
 	if (renderIndentGuides !== undefined) {

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

@@ -3347,15 +3347,15 @@ class BracketPairColorization extends BaseEditorOption<EditorOption.bracketPairC
 export interface IGuidesOptions {
 	/**
 	 * Enable rendering of bracket pair guides.
-	 * Defaults to 'none'.
+	 * Defaults to false.
 	*/
-	bracketPairs?: 'all' | 'active' | 'none';
+	bracketPairs?: boolean | 'active';
 
 	/**
 	 * Enable rendering of vertical bracket pair guides.
 	 * Defaults to 'active'.
 	 */
-	bracketPairsHorizontal?: 'all' | 'active' | 'none';
+	bracketPairsHorizontal?: boolean | 'active';
 
 	/**
 	 * Enable highlighting of the active bracket pair.
@@ -3387,7 +3387,7 @@ export type InternalGuidesOptions = Readonly<Required<IGuidesOptions>>;
 class GuideOptions extends BaseEditorOption<EditorOption.guides, InternalGuidesOptions> {
 	constructor() {
 		const defaults: InternalGuidesOptions = {
-			bracketPairs: 'none',
+			bracketPairs: false,
 			bracketPairsHorizontal: 'active',
 			highlightActiveBracketPair: true,
 
@@ -3399,14 +3399,14 @@ class GuideOptions extends BaseEditorOption<EditorOption.guides, InternalGuidesO
 			EditorOption.guides, 'guides', defaults,
 			{
 				'editor.guides.bracketPairs': {
-					type: 'string',
-					enum: ['all', 'active', 'none'],
+					type: ['boolean', 'string'],
+					enum: [true, 'active', false],
 					default: defaults.bracketPairs,
 					description: nls.localize('editor.guides.bracketPairs', "Controls whether bracket pair guides are enabled or not.")
 				},
 				'editor.guides.bracketPairsHorizontal': {
-					type: 'string',
-					enum: ['all', 'active', 'none'],
+					type: ['boolean', 'string'],
+					enum: [true, 'active', false],
 					default: defaults.bracketPairsHorizontal,
 					description: nls.localize('editor.guides.bracketPairsHorizontal', "Controls whether horizontal bracket pair guides are enabled or not.")
 				},
@@ -3435,8 +3435,8 @@ class GuideOptions extends BaseEditorOption<EditorOption.guides, InternalGuidesO
 		}
 		const input = _input as IGuidesOptions;
 		return {
-			bracketPairs: stringSet(input.bracketPairs, this.defaultValue.bracketPairs, ['all', 'active', 'none']),
-			bracketPairsHorizontal: stringSet(input.bracketPairsHorizontal, this.defaultValue.bracketPairsHorizontal, ['all', 'active', 'none']),
+			bracketPairs: primitiveSet(input.bracketPairs, this.defaultValue.bracketPairs, [true, false, 'active']),
+			bracketPairsHorizontal: primitiveSet(input.bracketPairsHorizontal, this.defaultValue.bracketPairsHorizontal, [true, false, 'active']),
 			highlightActiveBracketPair: boolean(input.highlightActiveBracketPair, this.defaultValue.highlightActiveBracketPair),
 
 			indentation: boolean(input.indentation, this.defaultValue.indentation),
@@ -3445,6 +3445,14 @@ class GuideOptions extends BaseEditorOption<EditorOption.guides, InternalGuidesO
 	}
 }
 
+function primitiveSet<T extends string | boolean>(value: unknown, defaultValue: T, allowedValues: T[]): T {
+	const idx = allowedValues.indexOf(value as any);
+	if (idx === -1) {
+		return defaultValue;
+	}
+	return allowedValues[idx];
+}
+
 //#endregion
 
 //#region suggest

src/vs/monaco.d.ts

@@ -3864,14 +3864,14 @@ declare namespace monaco.editor {
 	export interface IGuidesOptions {
 		/**
 		 * Enable rendering of bracket pair guides.
-		 * Defaults to 'none'.
+		 * Defaults to false.
 		*/
-		bracketPairs?: 'all' | 'active' | 'none';
+		bracketPairs?: boolean | 'active';
 		/**
 		 * Enable rendering of vertical bracket pair guides.
 		 * Defaults to 'active'.
 		 */
-		bracketPairsHorizontal?: 'all' | 'active' | 'none';
+		bracketPairsHorizontal?: boolean | 'active';
 		/**
 		 * Enable highlighting of the active bracket pair.
 		 * Defaults to true.