commonEditorConfig.ts 25.8 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5 6
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
'use strict';

A
Alex Dima 已提交
7
import * as nls from 'vs/nls';
J
Johannes Rieken 已提交
8 9
import Event, { Emitter } from 'vs/base/common/event';
import { Disposable } from 'vs/base/common/lifecycle';
A
Alex Dima 已提交
10
import * as objects from 'vs/base/common/objects';
A
Alex Dima 已提交
11
import * as platform from 'vs/base/common/platform';
J
Johannes Rieken 已提交
12 13
import { Extensions, IConfigurationRegistry, IConfigurationNode } from 'vs/platform/configuration/common/configurationRegistry';
import { Registry } from 'vs/platform/platform';
A
Alex Dima 已提交
14
import * as editorCommon from 'vs/editor/common/editorCommon';
15
import { FontInfo, BareFontInfo } from 'vs/editor/common/config/fontInfo';
A
Alex Dima 已提交
16
import { EditorZoom } from 'vs/editor/common/config/editorZoom';
17
import * as editorOptions from 'vs/editor/common/config/editorOptions';
18 19 20
import EDITOR_DEFAULTS = editorOptions.EDITOR_DEFAULTS;
import EDITOR_FONT_DEFAULTS = editorOptions.EDITOR_FONT_DEFAULTS;
import EDITOR_MODEL_DEFAULTS = editorOptions.EDITOR_MODEL_DEFAULTS;
E
Erich Gamma 已提交
21

22 23 24 25 26 27 28
/**
 * Control what pressing Tab does.
 * If it is false, pressing Tab or Shift-Tab will be handled by the editor.
 * If it is true, pressing Tab or Shift-Tab will move the browser focus.
 * Defaults to false.
 */
export interface ITabFocus {
J
Johannes Rieken 已提交
29
	onDidChangeTabFocus: Event<boolean>;
30
	getTabFocusMode(): boolean;
J
Johannes Rieken 已提交
31
	setTabFocusMode(tabFocusMode: boolean): void;
32 33 34 35 36 37
}

export const TabFocus: ITabFocus = new class {
	private _tabFocus: boolean = false;

	private _onDidChangeTabFocus: Emitter<boolean> = new Emitter<boolean>();
J
Johannes Rieken 已提交
38
	public onDidChangeTabFocus: Event<boolean> = this._onDidChangeTabFocus.event;
39 40 41 42 43

	public getTabFocusMode(): boolean {
		return this._tabFocus;
	}

J
Johannes Rieken 已提交
44
	public setTabFocusMode(tabFocusMode: boolean): void {
45 46 47 48 49 50 51 52 53
		if (this._tabFocus === tabFocusMode) {
			return;
		}

		this._tabFocus = tabFocusMode;
		this._onDidChangeTabFocus.fire(this._tabFocus);
	}
};

A
Alex Dima 已提交
54 55 56 57 58
export interface IEnvConfiguration {
	extraEditorClassName: string;
	outerWidth: number;
	outerHeight: number;
	canUseTranslate3d: boolean;
59
	emptySelectionClipboard: boolean;
A
Alex Dima 已提交
60 61
	pixelRatio: number;
	zoomLevel: number;
62
	accessibilitySupport: platform.AccessibilitySupport;
63 64
}

A
Alex Dima 已提交
65
export abstract class CommonEditorConfiguration extends Disposable implements editorCommon.IConfiguration {
E
Erich Gamma 已提交
66

67 68
	protected _rawOptions: editorOptions.IEditorOptions;
	protected _validatedOptions: editorOptions.IValidatedEditorOptions;
69
	public editor: editorOptions.InternalEditorOptions;
J
Johannes Rieken 已提交
70
	private _isDominatedByLongLines: boolean;
71
	private _lineNumbersDigitCount: number;
E
Erich Gamma 已提交
72

73 74
	private _onDidChange = this._register(new Emitter<editorOptions.IConfigurationChangedEvent>());
	public onDidChange: Event<editorOptions.IConfigurationChangedEvent> = this._onDidChange.event;
A
Alex Dima 已提交
75

A
Alex Dima 已提交
76
	constructor(options: editorOptions.IEditorOptions) {
A
Alex Dima 已提交
77
		super();
78

79 80 81 82 83 84
		// Do a "deep clone of sorts" on the incoming options
		this._rawOptions = objects.mixin({}, options || {});
		this._rawOptions.scrollbar = objects.mixin({}, this._rawOptions.scrollbar || {});
		this._rawOptions.minimap = objects.mixin({}, this._rawOptions.minimap || {});
		this._rawOptions.find = objects.mixin({}, this._rawOptions.find || {});

85
		this._validatedOptions = editorOptions.EditorOptionsValidator.validate(this._rawOptions, EDITOR_DEFAULTS);
A
Alex Dima 已提交
86
		this.editor = null;
E
Erich Gamma 已提交
87
		this._isDominatedByLongLines = false;
88
		this._lineNumbersDigitCount = 1;
A
Alex Dima 已提交
89

90
		this._register(EditorZoom.onDidChangeZoomLevel(_ => this._recomputeOptions()));
91
		this._register(TabFocus.onDidChangeTabFocus(_ => this._recomputeOptions()));
E
Erich Gamma 已提交
92 93 94 95 96 97 98
	}

	public dispose(): void {
		super.dispose();
	}

	protected _recomputeOptions(): void {
A
Alex Dima 已提交
99 100
		const oldOptions = this.editor;
		const newOptions = this._computeInternalOptions();
101

A
Alex Dima 已提交
102
		if (oldOptions && oldOptions.equals(newOptions)) {
103
			return;
E
Erich Gamma 已提交
104 105
		}

106
		this.editor = newOptions;
E
Erich Gamma 已提交
107

A
Alex Dima 已提交
108 109
		if (oldOptions) {
			this._onDidChange.fire(oldOptions.createChangeEvent(newOptions));
110
		}
E
Erich Gamma 已提交
111
	}
112

113
	public getRawOptions(): editorOptions.IEditorOptions {
114
		return this._rawOptions;
E
Erich Gamma 已提交
115
	}
116

117
	private _computeInternalOptions(): editorOptions.InternalEditorOptions {
118
		const opts = this._validatedOptions;
A
Alex Dima 已提交
119 120
		const partialEnv = this._getEnvConfiguration();
		const bareFontInfo = BareFontInfo.createFromRawSettings(this._rawOptions, partialEnv.zoomLevel);
A
Alex Dima 已提交
121
		const env: editorOptions.IEnvironmentalOptions = {
A
Alex Dima 已提交
122 123
			outerWidth: partialEnv.outerWidth,
			outerHeight: partialEnv.outerHeight,
124
			fontInfo: this.readConfiguration(bareFontInfo),
125
			extraEditorClassName: partialEnv.extraEditorClassName,
126 127
			isDominatedByLongLines: this._isDominatedByLongLines,
			lineNumbersDigitCount: this._lineNumbersDigitCount,
A
Alex Dima 已提交
128
			canUseTranslate3d: partialEnv.canUseTranslate3d,
129
			emptySelectionClipboard: partialEnv.emptySelectionClipboard,
A
Alex Dima 已提交
130
			pixelRatio: partialEnv.pixelRatio,
131 132
			tabFocusMode: TabFocus.getTabFocusMode(),
			accessibilitySupport: partialEnv.accessibilitySupport
A
Alex Dima 已提交
133
		};
134
		return editorOptions.InternalEditorOptionsFactory.createInternalEditorOptions(env, opts);
E
Erich Gamma 已提交
135 136
	}

137
	public updateOptions(newOptions: editorOptions.IEditorOptions): void {
138
		this._rawOptions = objects.mixin(this._rawOptions, newOptions || {});
139
		this._validatedOptions = editorOptions.EditorOptionsValidator.validate(this._rawOptions, EDITOR_DEFAULTS);
E
Erich Gamma 已提交
140 141 142
		this._recomputeOptions();
	}

J
Johannes Rieken 已提交
143
	public setIsDominatedByLongLines(isDominatedByLongLines: boolean): void {
E
Erich Gamma 已提交
144 145 146 147
		this._isDominatedByLongLines = isDominatedByLongLines;
		this._recomputeOptions();
	}

J
Johannes Rieken 已提交
148
	public setMaxLineNumber(maxLineNumber: number): void {
149
		let digitCount = CommonEditorConfiguration._digitCount(maxLineNumber);
150
		if (this._lineNumbersDigitCount === digitCount) {
A
Alex Dima 已提交
151 152
			return;
		}
153
		this._lineNumbersDigitCount = digitCount;
E
Erich Gamma 已提交
154 155 156
		this._recomputeOptions();
	}

157
	private static _digitCount(n: number): number {
158 159 160 161 162 163 164
		var r = 0;
		while (n) {
			n = Math.floor(n / 10);
			r++;
		}
		return r ? r : 1;
	}
A
Alex Dima 已提交
165
	protected abstract _getEnvConfiguration(): IEnvConfiguration;
166

167
	protected abstract readConfiguration(styling: BareFontInfo): FontInfo;
168

E
Erich Gamma 已提交
169 170
}

171 172
const configurationRegistry = <IConfigurationRegistry>Registry.as(Extensions.Configuration);
const editorConfiguration: IConfigurationNode = {
E
Erich Gamma 已提交
173 174 175
	'id': 'editor',
	'order': 5,
	'type': 'object',
176
	'title': nls.localize('editorConfigurationTitle', "Editor"),
177
	'overridable': true,
J
Johannes Rieken 已提交
178 179
	'properties': {
		'editor.fontFamily': {
E
Erich Gamma 已提交
180
			'type': 'string',
181
			'default': EDITOR_FONT_DEFAULTS.fontFamily,
E
Erich Gamma 已提交
182 183
			'description': nls.localize('fontFamily', "Controls the font family.")
		},
J
Johannes Rieken 已提交
184
		'editor.fontWeight': {
185
			'type': 'string',
186
			'enum': ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'],
187
			'default': EDITOR_FONT_DEFAULTS.fontWeight,
188 189
			'description': nls.localize('fontWeight', "Controls the font weight.")
		},
J
Johannes Rieken 已提交
190
		'editor.fontSize': {
E
Erich Gamma 已提交
191
			'type': 'number',
192
			'default': EDITOR_FONT_DEFAULTS.fontSize,
193
			'description': nls.localize('fontSize', "Controls the font size in pixels.")
E
Erich Gamma 已提交
194
		},
J
Johannes Rieken 已提交
195
		'editor.lineHeight': {
E
Erich Gamma 已提交
196
			'type': 'number',
197
			'default': EDITOR_FONT_DEFAULTS.lineHeight,
198
			'description': nls.localize('lineHeight', "Controls the line height. Use 0 to compute the lineHeight from the fontSize.")
E
Erich Gamma 已提交
199
		},
200 201
		'editor.letterSpacing': {
			'type': 'number',
202
			'default': EDITOR_FONT_DEFAULTS.letterSpacing,
203 204
			'description': nls.localize('letterSpacing', "Controls the letter spacing in pixels.")
		},
J
Johannes Rieken 已提交
205
		'editor.lineNumbers': {
206 207
			'type': 'string',
			'enum': ['off', 'on', 'relative'],
208
			'default': 'on',
209
			'description': nls.localize('lineNumbers', "Controls the display of line numbers. Possible values are 'on', 'off', and 'relative'. 'relative' shows the line count from the current cursor position.")
E
Erich Gamma 已提交
210
		},
J
Johannes Rieken 已提交
211
		'editor.rulers': {
212 213 214 215
			'type': 'array',
			'items': {
				'type': 'number'
			},
A
Alex Dima 已提交
216
			'default': EDITOR_DEFAULTS.viewInfo.rulers,
217 218
			'description': nls.localize('rulers', "Columns at which to show vertical rulers")
		},
J
Johannes Rieken 已提交
219
		'editor.wordSeparators': {
A
Alex Dima 已提交
220
			'type': 'string',
221
			'default': EDITOR_DEFAULTS.wordSeparators,
A
Alex Dima 已提交
222 223
			'description': nls.localize('wordSeparators', "Characters that will be used as word separators when doing word related navigations or operations")
		},
J
Johannes Rieken 已提交
224
		'editor.tabSize': {
225
			'type': 'number',
226
			'default': EDITOR_MODEL_DEFAULTS.tabSize,
E
Erich Gamma 已提交
227
			'minimum': 1,
228
			'description': nls.localize('tabSize', "The number of spaces a tab is equal to. This setting is overriden based on the file contents when `editor.detectIndentation` is on."),
229
			'errorMessage': nls.localize('tabSize.errorMessage', "Expected 'number'. Note that the value \"auto\" has been replaced by the `editor.detectIndentation` setting.")
E
Erich Gamma 已提交
230
		},
J
Johannes Rieken 已提交
231
		'editor.insertSpaces': {
232
			'type': 'boolean',
233
			'default': EDITOR_MODEL_DEFAULTS.insertSpaces,
234
			'description': nls.localize('insertSpaces', "Insert spaces when pressing Tab. This setting is overriden based on the file contents when `editor.detectIndentation` is on."),
235
			'errorMessage': nls.localize('insertSpaces.errorMessage', "Expected 'boolean'. Note that the value \"auto\" has been replaced by the `editor.detectIndentation` setting.")
E
Erich Gamma 已提交
236
		},
J
Johannes Rieken 已提交
237
		'editor.detectIndentation': {
238
			'type': 'boolean',
239
			'default': EDITOR_MODEL_DEFAULTS.detectIndentation,
A
Alex Dima 已提交
240
			'description': nls.localize('detectIndentation', "When opening a file, `editor.tabSize` and `editor.insertSpaces` will be detected based on the file contents.")
241
		},
J
Johannes Rieken 已提交
242
		'editor.roundedSelection': {
E
Erich Gamma 已提交
243
			'type': 'boolean',
A
Alex Dima 已提交
244
			'default': EDITOR_DEFAULTS.viewInfo.roundedSelection,
E
Erich Gamma 已提交
245 246
			'description': nls.localize('roundedSelection', "Controls if selections have rounded corners")
		},
J
Johannes Rieken 已提交
247
		'editor.scrollBeyondLastLine': {
E
Erich Gamma 已提交
248
			'type': 'boolean',
A
Alex Dima 已提交
249
			'default': EDITOR_DEFAULTS.viewInfo.scrollBeyondLastLine,
E
Erich Gamma 已提交
250 251
			'description': nls.localize('scrollBeyondLastLine', "Controls if the editor will scroll beyond the last line")
		},
252 253
		'editor.minimap.enabled': {
			'type': 'boolean',
A
Alex Dima 已提交
254
			'default': EDITOR_DEFAULTS.viewInfo.minimap.enabled,
255 256
			'description': nls.localize('minimap.enabled', "Controls if the minimap is shown")
		},
257
		'editor.minimap.renderCharacters': {
258
			'type': 'boolean',
A
Alex Dima 已提交
259
			'default': EDITOR_DEFAULTS.viewInfo.minimap.renderCharacters,
260
			'description': nls.localize('minimap.renderCharacters', "Render the actual characters on a line (as opposed to color blocks)")
261
		},
A
Alex Dima 已提交
262 263
		'editor.minimap.maxColumn': {
			'type': 'number',
A
Alex Dima 已提交
264
			'default': EDITOR_DEFAULTS.viewInfo.minimap.maxColumn,
A
Alex Dima 已提交
265 266
			'description': nls.localize('minimap.maxColumn', "Limit the width of the minimap to render at most a certain number of columns")
		},
267 268 269
		'editor.find.seedSearchStringFromSelection': {
			'type': 'boolean',
			'default': EDITOR_DEFAULTS.contribInfo.find.seedSearchStringFromSelection,
270
			'description': nls.localize('find.seedSearchStringFromSelection', "Controls if we seed the search string in Find Widget from editor selection")
271
		},
R
rebornix 已提交
272 273 274 275 276
		'editor.find.autoFindInSelection': {
			'type': 'boolean',
			'default': EDITOR_DEFAULTS.contribInfo.find.autoFindInSelection,
			'description': nls.localize('find.autoFindInSelection', "Controls if Find in Selection flag is turned on when multiple characters or lines of text are selected in the editor")
		},
J
Johannes Rieken 已提交
277
		'editor.wordWrap': {
278
			'type': 'string',
A
Alex Dima 已提交
279
			'enum': ['off', 'on', 'wordWrapColumn', 'bounded'],
280 281 282
			'enumDescriptions': [
				nls.localize('wordWrap.off', "Lines will never wrap."),
				nls.localize('wordWrap.on', "Lines will wrap at the viewport width."),
A
Alex Dima 已提交
283 284 285 286 287 288
				nls.localize({
					key: 'wordWrap.wordWrapColumn',
					comment: [
						'- `editor.wordWrapColumn` refers to a different setting and should not be localized.'
					]
				}, "Lines will wrap at `editor.wordWrapColumn`."),
A
Alex Dima 已提交
289 290 291 292
				nls.localize({
					key: 'wordWrap.bounded',
					comment: [
						'- viewport means the edge of the visible window size.',
A
Alex Dima 已提交
293
						'- `editor.wordWrapColumn` refers to a different setting and should not be localized.'
A
Alex Dima 已提交
294 295
					]
				}, "Lines will wrap at the minimum of viewport and `editor.wordWrapColumn`."),
296
			],
297
			'default': EDITOR_DEFAULTS.wordWrap,
A
Alex Dima 已提交
298 299 300 301 302 303 304
			'description': nls.localize({
				key: 'wordWrap',
				comment: [
					'- \'off\', \'on\', \'wordWrapColumn\' and \'bounded\' refer to values the setting can take and should not be localized.',
					'- `editor.wordWrapColumn` refers to a different setting and should not be localized.'
				]
			}, "Controls how lines should wrap. Can be:\n - 'off' (disable wrapping),\n - 'on' (viewport wrapping),\n - 'wordWrapColumn' (wrap at `editor.wordWrapColumn`) or\n - 'bounded' (wrap at minimum of viewport and `editor.wordWrapColumn`).")
305 306 307
		},
		'editor.wordWrapColumn': {
			'type': 'integer',
308
			'default': EDITOR_DEFAULTS.wordWrapColumn,
309
			'minimum': 1,
A
Alex Dima 已提交
310 311 312 313 314 315 316
			'description': nls.localize({
				key: 'wordWrapColumn',
				comment: [
					'- `editor.wordWrap` refers to a different setting and should not be localized.',
					'- \'wordWrapColumn\' and \'bounded\' refer to values the different setting can take and should not be localized.'
				]
			}, "Controls the wrapping column of the editor when `editor.wordWrap` is 'wordWrapColumn' or 'bounded'.")
317
		},
J
Johannes Rieken 已提交
318
		'editor.wrappingIndent': {
E
Erich Gamma 已提交
319 320
			'type': 'string',
			'enum': ['none', 'same', 'indent'],
321
			'default': 'same',
E
Erich Gamma 已提交
322 323
			'description': nls.localize('wrappingIndent', "Controls the indentation of wrapped lines. Can be one of 'none', 'same' or 'indent'.")
		},
J
Johannes Rieken 已提交
324
		'editor.mouseWheelScrollSensitivity': {
E
Erich Gamma 已提交
325
			'type': 'number',
A
Alex Dima 已提交
326
			'default': EDITOR_DEFAULTS.viewInfo.scrollbar.mouseWheelScrollSensitivity,
E
Erich Gamma 已提交
327 328
			'description': nls.localize('mouseWheelScrollSensitivity', "A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events")
		},
329
		'editor.multiCursorModifier': {
330
			'type': 'string',
331 332 333 334 335
			'enum': ['ctrlCmd', 'alt'],
			'enumDescriptions': [
				nls.localize('multiCursorModifier.ctrlCmd', "Maps to `Control` on Windows and Linux and to `Command` on OSX."),
				nls.localize('multiCursorModifier.alt', "Maps to `Alt` on Windows and Linux and to `Option` on OSX.")
			],
336
			'default': 'alt',
337 338 339 340 341 342 343
			'description': nls.localize({
				key: 'multiCursorModifier',
				comment: [
					'- `ctrlCmd` refers to a value the setting can take and should not be localized.',
					'- `Control` and `Command` refer to the modifier keys Ctrl or Cmd on the keyboard and can be localized.'
				]
			}, "The modifier to be used to add multiple cursors with the mouse. `ctrlCmd` maps to `Control` on Windows and Linux and to `Command` on OSX. The Go To Definition and Open Link mouse gestures will adapt such that they do not conflict with the multicursor modifier.")
344
		},
J
Johannes Rieken 已提交
345
		'editor.quickSuggestions': {
346
			'anyOf': [
347 348 349
				{
					type: 'boolean',
				},
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
				{
					type: 'object',
					properties: {
						strings: {
							type: 'boolean',
							default: false,
							description: nls.localize('quickSuggestions.strings', "Enable quick suggestions inside strings.")
						},
						comments: {
							type: 'boolean',
							default: false,
							description: nls.localize('quickSuggestions.comments', "Enable quick suggestions inside comments.")
						},
						other: {
							type: 'boolean',
							default: true,
							description: nls.localize('quickSuggestions.other', "Enable quick suggestions outside of strings and comments.")
						},
					}
				}
			],
A
Alex Dima 已提交
371
			'default': EDITOR_DEFAULTS.contribInfo.quickSuggestions,
372
			'description': nls.localize('quickSuggestions', "Controls if suggestions should automatically show up while typing")
E
Erich Gamma 已提交
373
		},
J
Johannes Rieken 已提交
374
		'editor.quickSuggestionsDelay': {
E
Erich Gamma 已提交
375
			'type': 'integer',
A
Alex Dima 已提交
376
			'default': EDITOR_DEFAULTS.contribInfo.quickSuggestionsDelay,
E
Erich Gamma 已提交
377 378 379
			'minimum': 0,
			'description': nls.localize('quickSuggestionsDelay', "Controls the delay in ms after which quick suggestions will show up")
		},
J
Johannes Rieken 已提交
380
		'editor.parameterHints': {
J
Joao Moreno 已提交
381
			'type': 'boolean',
A
Alex Dima 已提交
382
			'default': EDITOR_DEFAULTS.contribInfo.parameterHints,
J
Joao Moreno 已提交
383 384
			'description': nls.localize('parameterHints', "Enables parameter hints")
		},
J
Johannes Rieken 已提交
385
		'editor.autoClosingBrackets': {
E
Erich Gamma 已提交
386
			'type': 'boolean',
387
			'default': EDITOR_DEFAULTS.autoClosingBrackets,
E
Erich Gamma 已提交
388 389
			'description': nls.localize('autoClosingBrackets', "Controls if the editor should automatically close brackets after opening them")
		},
J
Johannes Rieken 已提交
390
		'editor.formatOnType': {
E
Erich Gamma 已提交
391
			'type': 'boolean',
A
Alex Dima 已提交
392
			'default': EDITOR_DEFAULTS.contribInfo.formatOnType,
E
Erich Gamma 已提交
393 394
			'description': nls.localize('formatOnType', "Controls if the editor should automatically format the line after typing")
		},
395 396
		'editor.formatOnPaste': {
			'type': 'boolean',
A
Alex Dima 已提交
397
			'default': EDITOR_DEFAULTS.contribInfo.formatOnPaste,
398
			'description': nls.localize('formatOnPaste', "Controls if the editor should automatically format the pasted content. A formatter must be available and the formatter should be able to format a range in a document.")
399
		},
J
Johannes Rieken 已提交
400
		'editor.suggestOnTriggerCharacters': {
E
Erich Gamma 已提交
401
			'type': 'boolean',
A
Alex Dima 已提交
402
			'default': EDITOR_DEFAULTS.contribInfo.suggestOnTriggerCharacters,
E
Erich Gamma 已提交
403 404
			'description': nls.localize('suggestOnTriggerCharacters', "Controls if suggestions should automatically show up when typing trigger characters")
		},
J
Johannes Rieken 已提交
405
		'editor.acceptSuggestionOnEnter': {
406 407
			'type': 'string',
			'enum': ['on', 'smart', 'off'],
A
Alex Dima 已提交
408
			'default': EDITOR_DEFAULTS.contribInfo.acceptSuggestionOnEnter,
409
			'description': nls.localize('acceptSuggestionOnEnter', "Controls if suggestions should be accepted on 'Enter' - in addition to 'Tab'. Helps to avoid ambiguity between inserting new lines or accepting suggestions. The value 'smart' means only accept a suggestion with Enter when it makes a textual change")
410 411 412
		},
		'editor.acceptSuggestionOnCommitCharacter': {
			'type': 'boolean',
A
Alex Dima 已提交
413
			'default': EDITOR_DEFAULTS.contribInfo.acceptSuggestionOnCommitCharacter,
414
			'description': nls.localize('acceptSuggestionOnCommitCharacter', "Controls if suggestions should be accepted on commit characters. For instance in JavaScript the semi-colon (';') can be a commit character that accepts a suggestion and types that character.")
415
		},
416
		'editor.snippetSuggestions': {
417
			'type': 'string',
418
			'enum': ['top', 'bottom', 'inline', 'none'],
A
Alex Dima 已提交
419
			'default': EDITOR_DEFAULTS.contribInfo.snippetSuggestions,
420
			'description': nls.localize('snippetSuggestions', "Controls whether snippets are shown with other suggestions and how they are sorted.")
421
		},
422 423
		'editor.emptySelectionClipboard': {
			'type': 'boolean',
424
			'default': EDITOR_DEFAULTS.emptySelectionClipboard,
425 426
			'description': nls.localize('emptySelectionClipboard', "Controls whether copying without a selection copies the current line.")
		},
427
		'editor.wordBasedSuggestions': {
428
			'type': 'boolean',
A
Alex Dima 已提交
429
			'default': EDITOR_DEFAULTS.contribInfo.wordBasedSuggestions,
J
Johannes Rieken 已提交
430
			'description': nls.localize('wordBasedSuggestions', "Controls whether completions should be computed based on words in the document.")
431
		},
J
Johannes Rieken 已提交
432
		'editor.suggestFontSize': {
J
Joao Moreno 已提交
433 434 435 436 437
			'type': 'integer',
			'default': 0,
			'minimum': 0,
			'description': nls.localize('suggestFontSize', "Font size for the suggest widget")
		},
J
Johannes Rieken 已提交
438
		'editor.suggestLineHeight': {
J
Joao Moreno 已提交
439 440 441 442 443
			'type': 'integer',
			'default': 0,
			'minimum': 0,
			'description': nls.localize('suggestLineHeight', "Line height for the suggest widget")
		},
J
Johannes Rieken 已提交
444
		'editor.selectionHighlight': {
E
Erich Gamma 已提交
445
			'type': 'boolean',
A
Alex Dima 已提交
446
			'default': EDITOR_DEFAULTS.contribInfo.selectionHighlight,
E
Erich Gamma 已提交
447 448
			'description': nls.localize('selectionHighlight', "Controls whether the editor should highlight similar matches to the selection")
		},
449 450
		'editor.occurrencesHighlight': {
			'type': 'boolean',
A
Alex Dima 已提交
451
			'default': EDITOR_DEFAULTS.contribInfo.occurrencesHighlight,
452 453
			'description': nls.localize('occurrencesHighlight', "Controls whether the editor should highlight semantic symbol occurrences")
		},
J
Johannes Rieken 已提交
454
		'editor.overviewRulerLanes': {
E
Erich Gamma 已提交
455 456 457 458
			'type': 'integer',
			'default': 3,
			'description': nls.localize('overviewRulerLanes', "Controls the number of decorations that can show up at the same position in the overview ruler")
		},
459
		'editor.overviewRulerBorder': {
460
			'type': 'boolean',
A
Alex Dima 已提交
461
			'default': EDITOR_DEFAULTS.viewInfo.overviewRulerBorder,
462
			'description': nls.localize('overviewRulerBorder', "Controls if a border should be drawn around the overview ruler.")
463
		},
J
Johannes Rieken 已提交
464
		'editor.cursorBlinking': {
465
			'type': 'string',
466
			'enum': ['blink', 'smooth', 'phase', 'expand', 'solid'],
467
			'default': editorOptions.blinkingStyleToString(EDITOR_DEFAULTS.viewInfo.cursorBlinking),
468
			'description': nls.localize('cursorBlinking', "Control the cursor animation style, possible values are 'blink', 'smooth', 'phase', 'expand' and 'solid'")
469
		},
470 471
		'editor.mouseWheelZoom': {
			'type': 'boolean',
A
Alex Dima 已提交
472
			'default': EDITOR_DEFAULTS.viewInfo.mouseWheelZoom,
473 474
			'description': nls.localize('mouseWheelZoom', "Zoom the font of the editor when using mouse wheel and holding Ctrl")
		},
J
Johannes Rieken 已提交
475
		'editor.cursorStyle': {
M
markrendle 已提交
476
			'type': 'string',
477
			'enum': ['block', 'block-outline', 'line', 'line-thin', 'underline', 'underline-thin'],
478
			'default': editorOptions.cursorStyleToString(EDITOR_DEFAULTS.viewInfo.cursorStyle),
479
			'description': nls.localize('cursorStyle', "Controls the cursor style, accepted values are 'block', 'block-outline', 'line', 'line-thin', 'underline' and 'underline-thin'")
M
markrendle 已提交
480
		},
J
Johannes Rieken 已提交
481
		'editor.fontLigatures': {
482
			'type': 'boolean',
A
Alex Dima 已提交
483
			'default': EDITOR_DEFAULTS.viewInfo.fontLigatures,
484 485
			'description': nls.localize('fontLigatures', "Enables font ligatures")
		},
J
Johannes Rieken 已提交
486
		'editor.hideCursorInOverviewRuler': {
E
Erich Gamma 已提交
487
			'type': 'boolean',
A
Alex Dima 已提交
488
			'default': EDITOR_DEFAULTS.viewInfo.hideCursorInOverviewRuler,
E
Erich Gamma 已提交
489 490 491
			'description': nls.localize('hideCursorInOverviewRuler', "Controls if the cursor should be hidden in the overview ruler.")
		},
		'editor.renderWhitespace': {
492 493
			'type': 'string',
			'enum': ['none', 'boundary', 'all'],
A
Alex Dima 已提交
494
			default: EDITOR_DEFAULTS.viewInfo.renderWhitespace,
495
			description: nls.localize('renderWhitespace', "Controls how the editor should render whitespace characters, possibilities are 'none', 'boundary', and 'all'. The 'boundary' option does not render single spaces between words.")
E
Erich Gamma 已提交
496
		},
497 498
		'editor.renderControlCharacters': {
			'type': 'boolean',
A
Alex Dima 已提交
499
			default: EDITOR_DEFAULTS.viewInfo.renderControlCharacters,
500 501
			description: nls.localize('renderControlCharacters', "Controls whether the editor should render control characters")
		},
502 503
		'editor.renderIndentGuides': {
			'type': 'boolean',
A
Alex Dima 已提交
504
			default: EDITOR_DEFAULTS.viewInfo.renderIndentGuides,
505 506
			description: nls.localize('renderIndentGuides', "Controls whether the editor should render indent guides")
		},
507
		'editor.renderLineHighlight': {
508 509
			'type': 'string',
			'enum': ['none', 'gutter', 'line', 'all'],
A
Alex Dima 已提交
510
			default: EDITOR_DEFAULTS.viewInfo.renderLineHighlight,
511
			description: nls.localize('renderLineHighlight', "Controls how the editor should render the current line highlight, possibilities are 'none', 'gutter', 'line', and 'all'.")
512
		},
J
Johannes Rieken 已提交
513
		'editor.codeLens': {
E
Erich Gamma 已提交
514
			'type': 'boolean',
A
Alex Dima 已提交
515
			'default': EDITOR_DEFAULTS.contribInfo.codeLens,
516
			'description': nls.localize('codeLens', "Controls if the editor shows code lenses")
E
Erich Gamma 已提交
517
		},
J
Johannes Rieken 已提交
518
		'editor.folding': {
M
Martin Aeschlimann 已提交
519
			'type': 'boolean',
A
Alex Dima 已提交
520
			'default': EDITOR_DEFAULTS.contribInfo.folding,
521
			'description': nls.localize('folding', "Controls whether the editor has code folding enabled")
M
Martin Aeschlimann 已提交
522
		},
523 524 525 526 527
		'editor.showFoldingControls': {
			'type': 'string',
			'enum': ['always', 'mouseover'],
			'default': EDITOR_DEFAULTS.contribInfo.showFoldingControls,
			'description': nls.localize('showFoldingControls', "Controls whether the fold controls on the gutter are automatically hidden.")
528
		},
529
		'editor.matchBrackets': {
530
			'type': 'boolean',
A
Alex Dima 已提交
531
			'default': EDITOR_DEFAULTS.contribInfo.matchBrackets,
532
			'description': nls.localize('matchBrackets', "Highlight matching brackets when one of them is selected.")
533
		},
I
isidor 已提交
534 535
		'editor.glyphMargin': {
			'type': 'boolean',
A
Alex Dima 已提交
536
			'default': EDITOR_DEFAULTS.viewInfo.glyphMargin,
I
isidor 已提交
537 538
			'description': nls.localize('glyphMargin', "Controls whether the editor should render the vertical glyph margin. Glyph margin is mostly used for debugging.")
		},
J
Johannes Rieken 已提交
539
		'editor.useTabStops': {
540
			'type': 'boolean',
541
			'default': EDITOR_DEFAULTS.useTabStops,
542 543
			'description': nls.localize('useTabStops', "Inserting and deleting whitespace follows tab stops")
		},
J
Johannes Rieken 已提交
544
		'editor.trimAutoWhitespace': {
545
			'type': 'boolean',
546
			'default': EDITOR_MODEL_DEFAULTS.trimAutoWhitespace,
547 548
			'description': nls.localize('trimAutoWhitespace', "Remove trailing auto inserted whitespace")
		},
J
Johannes Rieken 已提交
549
		'editor.stablePeek': {
550
			'type': 'boolean',
551
			'default': false,
552
			'description': nls.localize('stablePeek', "Keep peek editors open even when double clicking their content or when hitting Escape.")
553
		},
554
		'editor.dragAndDrop': {
555
			'type': 'boolean',
556
			'default': EDITOR_DEFAULTS.dragAndDrop,
557
			'description': nls.localize('dragAndDrop', "Controls if the editor should allow to move selections via drag and drop.")
558
		},
559 560 561 562 563 564 565 566 567 568 569
		'editor.accessibilitySupport': {
			'type': 'string',
			'enum': ['auto', 'on', 'off'],
			'enumDescriptions': [
				nls.localize('accessibilitySupport.auto', "The editor will use platform APIs to detect when a Screen Reader is attached."),
				nls.localize('accessibilitySupport.on', "The editor will be permanently optimized for usage with a Screen Reader."),
				nls.localize('accessibilitySupport.off', "The editor will never be optimized for usage with a Screen Reader."),
			],
			'default': EDITOR_DEFAULTS.accessibilitySupport,
			'description': nls.localize('accessibilitySupport', "Controls whether the editor should run in a mode where it is optimized for screen readers.")
		},
J
Johannes Rieken 已提交
570
		'diffEditor.renderSideBySide': {
E
Erich Gamma 已提交
571 572 573 574
			'type': 'boolean',
			'default': true,
			'description': nls.localize('sideBySide', "Controls if the diff editor shows the diff side by side or inline")
		},
J
Johannes Rieken 已提交
575
		'diffEditor.ignoreTrimWhitespace': {
E
Erich Gamma 已提交
576 577 578
			'type': 'boolean',
			'default': true,
			'description': nls.localize('ignoreTrimWhitespace', "Controls if the diff editor shows changes in leading or trailing whitespace as diffs")
579 580 581 582 583
		},
		'diffEditor.renderIndicators': {
			'type': 'boolean',
			'default': true,
			'description': nls.localize('renderIndicators', "Controls if the diff editor shows +/- indicators for added/removed changes")
E
Erich Gamma 已提交
584 585
		}
	}
A
Alex Dima 已提交
586 587 588 589 590
};

if (platform.isLinux) {
	editorConfiguration['properties']['editor.selectionClipboard'] = {
		'type': 'boolean',
A
Alex Dima 已提交
591
		'default': EDITOR_DEFAULTS.contribInfo.selectionClipboard,
A
Alex Dima 已提交
592 593 594 595
		'description': nls.localize('selectionClipboard', "Controls if the Linux primary clipboard should be supported.")
	};
}

596
configurationRegistry.registerConfiguration(editorConfiguration);