1
>
/*---------------------------------------------------------------------------------------------
editorOptions.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import * as arrays from '../../../base/common/arrays.js';
7
>
import { IMarkdownString } from '../../../base/common/htmlContent.js';
8
>
import { IJSONSchema } from '../../../base/common/jsonSchema.js';
9
>
import * as objects from '../../../base/common/objects.js';
10
>
import * as platform from '../../../base/common/platform.js';
11
>
import { ScrollbarVisibility } from '../../../base/common/scrollable.js';
12
>
import { Constants } from '../../../base/common/uint.js';
13
>
import { EDITOR_FONT_DEFAULTS, FONT_VARIATION_OFF, FONT_VARIATION_TRANSLATE, FontInfo } from './fontInfo.js';
14
>
import { EDITOR_MODEL_DEFAULTS } from '../core/misc/textModelDefaults.js';
15
>
import { USUAL_WORD_SEPARATORS } from '../core/wordHelper.js';
16
>
import * as nls from '../../../nls.js';
17
>
import { AccessibilitySupport } from '../../../platform/accessibility/common/accessibility.js';
18
>
import { IConfigurationPropertySchema } from '../../../platform/configuration/common/configurationRegistry.js';
19
>
20
>
//#region typed options
21
>
22
>
/**
23
>
* Configuration options for auto closing quotes and brackets
24
>
*/
25
>
export type EditorAutoClosingStrategy = 'always' | 'languageDefined' | 'beforeWhitespace' | 'never';
26
>
27
>
/**
28
>
* Configuration options for auto wrapping quotes and brackets
29
>
*/
30
>
export type EditorAutoSurroundStrategy = 'languageDefined' | 'quotes' | 'brackets' | 'never';
31
>
32
>
/**
33
>
* Configuration options for typing over closing quotes or brackets
34
>
*/
35
>
export type EditorAutoClosingEditStrategy = 'always' | 'auto' | 'never';
36
>
37
>
type Unknown<T> = { [K in keyof T]: unknown };
38
>
39
>
/**
40
>
* Configuration options for auto indentation in the editor
41
>
*/
42
>
export const enum EditorAutoIndentStrategy {
43
>
None = 0,
44
>
Keep = 1,
45
>
Brackets = 2,
46
>
Advanced = 3,
47
>
Full = 4
48
>
}
49
>
50
>
/**
51
>
* Configuration options for the editor.
52
>
*/
53
>
export interface IEditorOptions {
54
>
/**
55
>
* This editor is used inside a diff editor.
56
>
*/
57
>
inDiffEditor?: boolean;
58
>
/**
59
>
* This editor is allowed to use variable line heights.
60
>
*/
61
>
allowVariableLineHeights?: boolean;
62
>
/**
63
>
* This editor is allowed to use variable font-sizes and font-families
64
>
*/
65
>
allowVariableFonts?: boolean;
66
>
/**
67
>
* This editor is allowed to use variable font-sizes and font-families in accessibility mode
68
>
*/
69
>
allowVariableFontsInAccessibilityMode?: boolean;
70
>
/**
71
>
* The aria label for the editor's textarea (when it is focused).
72
>
*/
73
>
ariaLabel?: string;
74
>
75
>
/**
76
>
* Whether the aria-required attribute should be set on the editors textarea.
77
>
*/
78
>
ariaRequired?: boolean;
79
>
/**
80
>
* Control whether a screen reader announces inline suggestion content immediately.
81
>
*/
82
>
screenReaderAnnounceInlineSuggestion?: boolean;
83
>
/**
84
>
* The `tabindex` property of the editor's textarea
85
>
*/
86
>
tabIndex?: number;
87
>
/**
88
>
* Render vertical lines at the specified columns.
89
>
* Defaults to empty array.
90
>
*/
91
>
rulers?: (number | IRulerOption)[];
92
>
/**
93
>
* Locales used for segmenting lines into words when doing word related navigations or operations.
94
>
*
95
>
* Specify the BCP 47 language tag of the word you wish to recognize (e.g., ja, zh-CN, zh-Hant-TW, etc.).
96
>
* Defaults to empty array
97
>
*/
98
>
wordSegmenterLocales?: string | string[];
99
>
/**
100
>
* A string containing the word separators used when doing word navigation.
101
>
* Defaults to `~!@#$%^&*()-=+[{]}\\|;:\'",.<>/?
102
>
*/
103
>
wordSeparators?: string;
104
>
/**
105
>
* Enable Linux primary clipboard.
106
>
* Defaults to true.
107
>
*/
108
>
selectionClipboard?: boolean;
109
>
/**
110
>
* Control the rendering of line numbers.
111
>
* If it is a function, it will be invoked when rendering a line number and the return value will be rendered.
112
>
* Otherwise, if it is a truthy, line numbers will be rendered normally (equivalent of using an identity function).
113
>
* Otherwise, line numbers will not be rendered.
114
>
* Defaults to `on`.
115
>
*/
116
>
lineNumbers?: LineNumbersType;
117
>
/**
118
>
* Controls the minimal number of visible leading and trailing lines surrounding the cursor.
119
>
* Defaults to 0.
120
>
*/
121
>
cursorSurroundingLines?: number;
122
>
/**
123
>
* Controls when `cursorSurroundingLines` should be enforced
124
>
* Defaults to `default`, `cursorSurroundingLines` is not enforced when cursor position is changed
125
>
* by mouse.
126
>
*/
127
>
cursorSurroundingLinesStyle?: 'default' | 'all';
128
>
/**
129
>
* Render last line number when the file ends with a newline.
130
>
* Defaults to 'on' for Windows and macOS and 'dimmed' for Linux.
131
>
*/
132
>
renderFinalNewline?: 'on' | 'off' | 'dimmed';
133
>
/**
134
>
* Remove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS).
135
>
* Defaults to 'prompt'.
136
>
*/
137
>
unusualLineTerminators?: 'auto' | 'off' | 'prompt';
138
>
/**
139
>
* Should the corresponding line be selected when clicking on the line number?
140
>
* Defaults to true.
141
>
*/
142
>
selectOnLineNumbers?: boolean;
143
>
/**
144
>
* Control the width of line numbers, by reserving horizontal space for rendering at least an amount of digits.
145
>
* Defaults to 5.
146
>
*/
147
>
lineNumbersMinChars?: number;
148
>
/**
149
>
* Enable the rendering of the glyph margin.
150
>
* Defaults to true in vscode and to false in monaco-editor.
151
>
*/
152
>
glyphMargin?: boolean;
153
>
/**
154
>
* The width reserved for line decorations (in px).
155
>
* Line decorations are placed between line numbers and the editor content.
156
>
* You can pass in a string in the format floating point followed by "ch". e.g. 1.3ch.
157
>
* Defaults to 10.
158
>
*/
159
>
lineDecorationsWidth?: number | string;
160
>
/**
161
>
* When revealing the cursor, a virtual padding (px) is added to the cursor, turning it into a rectangle.
162
>
* This virtual padding ensures that the cursor gets revealed before hitting the edge of the viewport.
163
>
* Defaults to 30 (px).
164
>
*/
165
>
revealHorizontalRightPadding?: number;
166
>
/**
167
>
* Render the editor selection with rounded borders.
168
>
* Defaults to true.
169
>
*/
170
>
roundedSelection?: boolean;
171
>
/**
172
>
* Class name to be added to the editor.
173
>
*/
174
>
extraEditorClassName?: string;
175
>
/**
176
>
* Should the editor be read only. See also `domReadOnly`.
177
>
* Defaults to false.
178
>
*/
179
>
readOnly?: boolean;
180
>
/**
181
>
* The message to display when the editor is readonly.
182
>
*/
183
>
readOnlyMessage?: IMarkdownString;
184
>
/**
185
>
* Should the textarea used for input use the DOM `readonly` attribute.
186
>
* Defaults to false.
187
>
*/
188
>
domReadOnly?: boolean;
189
>
/**
190
>
* Enable linked editing.
191
>
* Defaults to false.
192
>
*/
193
>
linkedEditing?: boolean;
194
>
/**
195
>
* deprecated, use linkedEditing instead
196
>
*/
197
>
renameOnType?: boolean;
198
>
/**
199
>
* Should the editor render validation decorations.
200
>
* Defaults to editable.
201
>
*/
202
>
renderValidationDecorations?: 'editable' | 'on' | 'off';
203
>
/**
204
>
* Control the behavior and rendering of the scrollbars.
205
>
*/
206
>
scrollbar?: IEditorScrollbarOptions;
207
>
/**
208
>
* Control the behavior of sticky scroll options
209
>
*/
210
>
stickyScroll?: IEditorStickyScrollOptions;
211
>
/**
212
>
* Control the behavior and rendering of the minimap.
213
>
*/
214
>
minimap?: IEditorMinimapOptions;
215
>
/**
216
>
* Control the behavior of the find widget.
217
>
*/
218
>
find?: IEditorFindOptions;
219
>
/**
220
>
* Display overflow widgets as `fixed`.
221
>
* Defaults to `false`.
222
>
*/
223
>
fixedOverflowWidgets?: boolean;
224
>
/**
225
>
* Allow content widgets and overflow widgets to overflow the editor viewport.
226
>
* Defaults to `true`.
227
>
*/
228
>
allowOverflow?: boolean;
229
>
/**
230
>
* The number of vertical lanes the overview ruler should render.
231
>
* Defaults to 3.
232
>
*/
233
>
overviewRulerLanes?: number;
234
>
/**
235
>
* Controls if a border should be drawn around the overview ruler.
236
>
* Defaults to `true`.
237
>
*/
238
>
overviewRulerBorder?: boolean;
239
>
/**
240
>
* Control the cursor animation style, possible values are 'blink', 'smooth', 'phase', 'expand' and 'solid'.
241
>
* Defaults to 'blink'.
242
>
*/
243
>
cursorBlinking?: 'blink' | 'smooth' | 'phase' | 'expand' | 'solid';
244
>
/**
245
>
* Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl.
246
>
* Defaults to false.
247
>
*/
248
>
mouseWheelZoom?: boolean;
249
>
/**
250
>
* Control the mouse pointer style, either 'text' or 'default' or 'copy'
251
>
* Defaults to 'text'
252
>
*/
253
>
mouseStyle?: 'text' | 'default' | 'copy';
254
>
/**
255
>
* Enable smooth caret animation.
256
>
* Defaults to 'off'.
257
>
*/
258
>
cursorSmoothCaretAnimation?: 'off' | 'explicit' | 'on';
259
>
/**
260
>
* Control the cursor style in insert mode.
261
>
* Defaults to 'line'.
262
>
*/
263
>
cursorStyle?: 'line' | 'block' | 'underline' | 'line-thin' | 'block-outline' | 'underline-thin';
264
>
/**
265
>
* Control the cursor style in overtype mode.
266
>
* Defaults to 'block'.
267
>
*/
268
>
overtypeCursorStyle?: 'line' | 'block' | 'underline' | 'line-thin' | 'block-outline' | 'underline-thin';
269
>
/**
270
>
* Controls whether paste in overtype mode should overwrite or insert.
271
>
*/
272
>
overtypeOnPaste?: boolean;
273
>
/**
274
>
* Control the width of the cursor when cursorStyle is set to 'line'
275
>
*/
276
>
cursorWidth?: number;
277
>
/**
278
>
* Control the height of the cursor when cursorStyle is set to 'line'
279
>
*/
280
>
cursorHeight?: number;
281
>
/**
282
>
* Enable font ligatures.
283
>
* Defaults to false.
284
>
*/
285
>
fontLigatures?: boolean | string;
286
>
/**
287
>
* Enable font variations.
288
>
* Defaults to false.
289
>
*/
290
>
fontVariations?: boolean | string;
291
>
/**
292
>
* Controls whether to use default color decorations or not using the default document color provider
293
>
*/
294
>
defaultColorDecorators?: 'auto' | 'always' | 'never';
295
>
/**
296
>
* Disable the use of `transform: translate3d(0px, 0px, 0px)` for the editor margin and lines layers.
297
>
* The usage of `transform: translate3d(0px, 0px, 0px)` acts as a hint for browsers to create an extra layer.
298
>
* Defaults to false.
299
>
*/
300
>
disableLayerHinting?: boolean;
301
>
/**
302
>
* Disable the optimizations for monospace fonts.
303
>
* Defaults to false.
304
>
*/
305
>
disableMonospaceOptimizations?: boolean;
306
>
/**
307
>
* Should the cursor be hidden in the overview ruler.
308
>
* Defaults to false.
309
>
*/
310
>
hideCursorInOverviewRuler?: boolean;
311
>
/**
312
>
* Enable that scrolling can go one screen size after the last line.
313
>
* Defaults to true.
314
>
*/
315
>
scrollBeyondLastLine?: boolean;
316
>
/**
317
>
* Scroll editor on middle click
318
>
*/
319
>
scrollOnMiddleClick?: boolean;
320
>
/**
321
>
* Enable that scrolling can go beyond the last column by a number of columns.
322
>
* Defaults to 5.
323
>
*/
324
>
scrollBeyondLastColumn?: number;
325
>
/**
326
>
* Enable that the editor animates scrolling to a position.
327
>
* Defaults to false.
328
>
*/
329
>
smoothScrolling?: boolean;
330
>
/**
331
>
* Enable that the editor will install a ResizeObserver to check if its container dom node size has changed.
332
>
* Defaults to false.
333
>
*/
334
>
automaticLayout?: boolean;
335
>
/**
336
>
* Control the wrapping of the editor.
337
>
* When `wordWrap` = "off", the lines will never wrap.
338
>
* When `wordWrap` = "on", the lines will wrap at the viewport width.
339
>
* When `wordWrap` = "wordWrapColumn", the lines will wrap at `wordWrapColumn`.
340
>
* When `wordWrap` = "bounded", the lines will wrap at min(viewport width, wordWrapColumn).
341
>
* Defaults to "off".
342
>
*/
343
>
wordWrap?: 'off' | 'on' | 'wordWrapColumn' | 'bounded';
344
>
/**
345
>
* Override the `wordWrap` setting.
346
>
*/
347
>
wordWrapOverride1?: 'off' | 'on' | 'inherit';
348
>
/**
349
>
* Override the `wordWrapOverride1` setting.
350
>
*/
351
>
wordWrapOverride2?: 'off' | 'on' | 'inherit';
352
>
/**
353
>
* Control the wrapping of the editor.
354
>
* When `wordWrap` = "off", the lines will never wrap.
355
>
* When `wordWrap` = "on", the lines will wrap at the viewport width.
356
>
* When `wordWrap` = "wordWrapColumn", the lines will wrap at `wordWrapColumn`.
357
>
* When `wordWrap` = "bounded", the lines will wrap at min(viewport width, wordWrapColumn).
358
>
* Defaults to 80.
359
>
*/
360
>
wordWrapColumn?: number;
361
>
/**
362
>
* Control indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'.
363
>
* Defaults to 'same' in vscode and to 'none' in monaco-editor.
364
>
*/
365
>
wrappingIndent?: 'none' | 'same' | 'indent' | 'deepIndent';
366
>
/**
367
>
* Controls the wrapping strategy to use.
368
>
* Defaults to 'simple'.
369
>
*/
370
>
wrappingStrategy?: 'simple' | 'advanced';
371
>
/**
372
>
* Create a softwrap on every quoted "\n" literal.
373
>
* Defaults to false.
374
>
*/
375
>
wrapOnEscapedLineFeeds?: boolean;
376
>
/**
377
>
* Configure word wrapping characters. A break will be introduced before these characters.
378
>
*/
379
>
wordWrapBreakBeforeCharacters?: string;
380
>
/**
381
>
* Configure word wrapping characters. A break will be introduced after these characters.
382
>
*/
383
>
wordWrapBreakAfterCharacters?: string;
384
>
/**
385
>
* Sets whether line breaks appear wherever the text would otherwise overflow its content box.
386
>
* When wordBreak = 'normal', Use the default line break rule.
387
>
* When wordBreak = 'keepAll', Word breaks should not be used for Chinese/Japanese/Korean (CJK) text. Non-CJK text behavior is the same as for normal.
388
>
*/
389
>
wordBreak?: 'normal' | 'keepAll';
390
>
/**
391
>
* Performance guard: Stop rendering a line after x characters.
392
>
* Defaults to 10000.
393
>
* Use -1 to never stop rendering
394
>
*/
395
>
stopRenderingLineAfter?: number;
396
>
/**
397
>
* Configure the editor's hover.
398
>
*/
399
>
hover?: IEditorHoverOptions;
400
>
/**
401
>
* Enable detecting links and making them clickable.
402
>
* Defaults to true.
403
>
*/
404
>
links?: boolean;
405
>
/**
406
>
* Enable inline color decorators and color picker rendering.
407
>
*/
408
>
colorDecorators?: boolean;
409
>
/**
410
>
* Controls what is the condition to spawn a color picker from a color dectorator
411
>
*/
412
>
colorDecoratorsActivatedOn?: 'clickAndHover' | 'click' | 'hover';
413
>
/**
414
>
* Controls the max number of color decorators that can be rendered in an editor at once.
415
>
*/
416
>
colorDecoratorsLimit?: number;
417
>
/**
418
>
* Control the behaviour of comments in the editor.
419
>
*/
420
>
comments?: IEditorCommentsOptions;
421
>
/**
422
>
* Enable custom contextmenu.
423
>
* Defaults to true.
424
>
*/
425
>
contextmenu?: boolean;
426
>
/**
427
>
* A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events.
428
>
* Defaults to 1.
429
>
*/
430
>
mouseWheelScrollSensitivity?: number;
431
>
/**
432
>
* FastScrolling mulitplier speed when pressing `Alt`
433
>
* Defaults to 5.
434
>
*/
435
>
fastScrollSensitivity?: number;
436
>
/**
437
>
* Enable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad.
438
>
* Defaults to true.
439
>
*/
440
>
scrollPredominantAxis?: boolean;
441
>
/**
442
>
* Make scrolling inertial - mostly useful with touchpad on linux.
443
>
*/
444
>
inertialScroll?: boolean;
445
>
/**
446
>
* Enable that the selection with the mouse and keys is doing column selection.
447
>
* Defaults to false.
448
>
*/
449
>
columnSelection?: boolean;
450
>
/**
451
>
* The modifier to be used to add multiple cursors with the mouse.
452
>
* Defaults to 'alt'
453
>
*/
454
>
multiCursorModifier?: 'ctrlCmd' | 'alt';
455
>
/**
456
>
* Merge overlapping selections.
457
>
* Defaults to true
458
>
*/
459
>
multiCursorMergeOverlapping?: boolean;
460
>
/**
461
>
* Configure the behaviour when pasting a text with the line count equal to the cursor count.
462
>
* Defaults to 'spread'.
463
>
*/
464
>
multiCursorPaste?: 'spread' | 'full';
465
>
/**
466
>
* Controls the max number of text cursors that can be in an active editor at once.
467
>
*/
468
>
multiCursorLimit?: number;
469
>
/**
470
>
* Enables middle mouse button to open links and Go To Definition
471
>
*/
472
>
mouseMiddleClickAction?: MouseMiddleClickAction;
473
>
/**
474
>
* Configure the editor's accessibility support.
475
>
* Defaults to 'auto'. It is best to leave this to 'auto'.
476
>
*/
477
>
accessibilitySupport?: 'auto' | 'off' | 'on';
478
>
/**
479
>
* Controls the number of lines in the editor that can be read out by a screen reader
480
>
*/
481
>
accessibilityPageSize?: number;
482
>
/**
483
>
* Suggest options.
484
>
*/
485
>
suggest?: ISuggestOptions;
486
>
inlineSuggest?: IInlineSuggestOptions;
487
>
/**
488
>
* Smart select options.
489
>
*/
490
>
smartSelect?: ISmartSelectOptions;
491
>
/**
492
>
*
493
>
*/
494
>
gotoLocation?: IGotoLocationOptions;
495
>
/**
496
>
* Enable quick suggestions (shadow suggestions)
497
>
* Defaults to true.
498
>
*/
499
>
quickSuggestions?: boolean | QuickSuggestionsValue | IQuickSuggestionsOptions;
500
>
/**
501
>
* Quick suggestions show delay (in ms)
502
>
* Defaults to 10 (ms)
503
>
*/
504
>
quickSuggestionsDelay?: number;
505
>
/**
506
>
* Controls the spacing around the editor.
507
>
*/
508
>
padding?: IEditorPaddingOptions;
509
>
/**
510
>
* Parameter hint options.
511
>
*/
512
>
parameterHints?: IEditorParameterHintOptions;
513
>
/**
514
>
* Options for auto closing brackets.
515
>
* Defaults to language defined behavior.
516
>
*/
517
>
autoClosingBrackets?: EditorAutoClosingStrategy;
518
>
/**
519
>
* Options for auto closing comments.
520
>
* Defaults to language defined behavior.
521
>
*/
522
>
autoClosingComments?: EditorAutoClosingStrategy;
523
>
/**
524
>
* Options for auto closing quotes.
525
>
* Defaults to language defined behavior.
526
>
*/
527
>
autoClosingQuotes?: EditorAutoClosingStrategy;
528
>
/**
529
>
* Options for pressing backspace near quotes or bracket pairs.
530
>
*/
531
>
autoClosingDelete?: EditorAutoClosingEditStrategy;
532
>
/**
533
>
* Options for typing over closing quotes or brackets.
534
>
*/
535
>
autoClosingOvertype?: EditorAutoClosingEditStrategy;
536
>
/**
537
>
* Options for auto surrounding.
538
>
* Defaults to always allowing auto surrounding.
539
>
*/
540
>
autoSurround?: EditorAutoSurroundStrategy;
541
>
/**
542
>
* Controls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines.
543
>
* Defaults to advanced.
544
>
*/
545
>
autoIndent?: 'none' | 'keep' | 'brackets' | 'advanced' | 'full';
546
>
/**
547
>
* Boolean which controls whether to autoindent on paste
548
>
*/
549
>
autoIndentOnPaste?: boolean;
550
>
/**
551
>
* Boolean which controls whether to autoindent on paste within a string when autoIndentOnPaste is enabled.
552
>
*/
553
>
autoIndentOnPasteWithinString?: boolean;
554
>
/**
555
>
* Emulate selection behaviour of tab characters when using spaces for indentation.
556
>
* This means selection will stick to tab stops.
557
>
*/
558
>
stickyTabStops?: boolean;
559
>
/**
560
>
* Enable format on type.
561
>
* Defaults to false.
562
>
*/
563
>
formatOnType?: boolean;
564
>
/**
565
>
* Enable format on paste.
566
>
* Defaults to false.
567
>
*/
568
>
formatOnPaste?: boolean;
569
>
/**
570
>
* Controls whether double-clicking next to a bracket or quote selects the content inside.
571
>
* Defaults to true.
572
>
*/
573
>
doubleClickSelectsBlock?: boolean;
574
>
/**
575
>
* Controls if the editor should allow to move selections via drag and drop.
576
>
* Defaults to false.
577
>
*/
578
>
dragAndDrop?: boolean;
579
>
/**
580
>
* Enable the suggestion box to pop-up on trigger characters.
581
>
* Defaults to true.
582
>
*/
583
>
suggestOnTriggerCharacters?: boolean;
584
>
/**
585
>
* Accept suggestions on ENTER.
586
>
* Defaults to 'on'.
587
>
*/
588
>
acceptSuggestionOnEnter?: 'on' | 'smart' | 'off';
589
>
/**
590
>
* Accept suggestions on provider defined characters.
591
>
* Defaults to true.
592
>
*/
593
>
acceptSuggestionOnCommitCharacter?: boolean;
594
>
/**
595
>
* Enable snippet suggestions. Default to 'true'.
596
>
*/
597
>
snippetSuggestions?: 'top' | 'bottom' | 'inline' | 'none';
598
>
/**
599
>
* Copying without a selection copies the current line.
600
>
*/
601
>
emptySelectionClipboard?: boolean;
602
>
/**
603
>
* Syntax highlighting is copied.
604
>
*/
605
>
copyWithSyntaxHighlighting?: boolean;
606
>
/**
607
>
* The history mode for suggestions.
608
>
*/
609
>
suggestSelection?: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
610
>
/**
611
>
* The font size for the suggest widget.
612
>
* Defaults to the editor font size.
613
>
*/
614
>
suggestFontSize?: number;
615
>
/**
616
>
* The line height for the suggest widget.
617
>
* Defaults to the editor line height.
618
>
*/
619
>
suggestLineHeight?: number;
620
>
/**
621
>
* Enable tab completion.
622
>
*/
623
>
tabCompletion?: 'on' | 'off' | 'onlySnippets';
624
>
/**
625
>
* Enable selection highlight.
626
>
* Defaults to true.
627
>
*/
628
>
selectionHighlight?: boolean;
629
>
/**
630
>
* Enable selection highlight for multiline selections.
631
>
* Defaults to false.
632
>
*/
633
>
selectionHighlightMultiline?: boolean;
634
>
/**
635
>
* Maximum length (in characters) for selection highlights.
636
>
* Set to 0 to have an unlimited length.
637
>
*/
638
>
selectionHighlightMaxLength?: number;
639
>
/**
640
>
* Enable semantic occurrences highlight.
641
>
* Defaults to 'singleFile'.
642
>
* 'off' disables occurrence highlighting
643
>
* 'singleFile' triggers occurrence highlighting in the current document
644
>
* 'multiFile' triggers occurrence highlighting across valid open documents
645
>
*/
646
>
occurrencesHighlight?: 'off' | 'singleFile' | 'multiFile';
647
>
/**
648
>
* Controls delay for occurrences highlighting
649
>
* Defaults to 250.
650
>
* Minimum value is 0
651
>
* Maximum value is 2000
652
>
*/
653
>
occurrencesHighlightDelay?: number;
654
>
/**
655
>
* Show code lens
656
>
* Defaults to true.
657
>
*/
658
>
codeLens?: boolean;
659
>
/**
660
>
* Code lens font family. Defaults to editor font family.
661
>
*/
662
>
codeLensFontFamily?: string;
663
>
/**
664
>
* Code lens font size. Default to 90% of the editor font size
665
>
*/
666
>
codeLensFontSize?: number;
667
>
/**
668
>
* Control the behavior and rendering of the code action lightbulb.
669
>
*/
670
>
lightbulb?: IEditorLightbulbOptions;
671
>
/**
672
>
* Timeout for running code actions on save.
673
>
*/
674
>
codeActionsOnSaveTimeout?: number;
675
>
/**
676
>
* Enable code folding.
677
>
* Defaults to true.
678
>
*/
679
>
folding?: boolean;
680
>
/**
681
>
* Selects the folding strategy. 'auto' uses the strategies contributed for the current document, 'indentation' uses the indentation based folding strategy.
682
>
* Defaults to 'auto'.
683
>
*/
684
>
foldingStrategy?: 'auto' | 'indentation';
685
>
/**
686
>
* Enable highlight for folded regions.
687
>
* Defaults to true.
688
>
*/
689
>
foldingHighlight?: boolean;
690
>
/**
691
>
* Auto fold imports folding regions.
692
>
* Defaults to true.
693
>
*/
694
>
foldingImportsByDefault?: boolean;
695
>
/**
696
>
* Maximum number of foldable regions.
697
>
* Defaults to 5000.
698
>
*/
699
>
foldingMaximumRegions?: number;
700
>
/**
701
>
* Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter.
702
>
* Defaults to 'mouseover'.
703
>
*/
704
>
showFoldingControls?: 'always' | 'never' | 'mouseover';
705
>
/**
706
>
* Controls whether clicking on the empty content after a folded line will unfold the line.
707
>
* Defaults to false.
708
>
*/
709
>
unfoldOnClickAfterEndOfLine?: boolean;
710
>
/**
711
>
* Enable highlighting of matching brackets.
712
>
* Defaults to 'always'.
713
>
*/
714
>
matchBrackets?: 'never' | 'near' | 'always';
715
>
/**
716
>
* Enable experimental rendering using WebGPU.
717
>
* Defaults to 'off'.
718
>
*/
719
>
experimentalGpuAcceleration?: 'on' | 'off';
720
>
/**
721
>
* Enable experimental whitespace rendering.
722
>
* Defaults to 'svg'.
723
>
*/
724
>
experimentalWhitespaceRendering?: 'svg' | 'font' | 'off';
725
>
/**
726
>
* Enable rendering of whitespace.
727
>
* Defaults to 'selection'.
728
>
*/
729
>
renderWhitespace?: 'none' | 'boundary' | 'selection' | 'trailing' | 'all';
730
>
/**
731
>
* Enable rendering of control characters.
732
>
* Defaults to true.
733
>
*/
734
>
renderControlCharacters?: boolean;
735
>
/**
736
>
* Enable rendering of current line highlight.
737
>
* Defaults to all.
738
>
*/
739
>
renderLineHighlight?: 'none' | 'gutter' | 'line' | 'all';
740
>
/**
741
>
* Control if the current line highlight should be rendered only the editor is focused.
742
>
* Defaults to false.
743
>
*/
744
>
renderLineHighlightOnlyWhenFocus?: boolean;
745
>
/**
746
>
* Inserting and deleting whitespace follows tab stops.
747
>
*/
748
>
useTabStops?: boolean;
749
>
/**
750
>
* Controls whether the editor should automatically remove indentation whitespace when joining lines with Delete.
751
>
* Defaults to false.
752
>
*/
753
>
trimWhitespaceOnDelete?: boolean;
754
>
/**
755
>
* The font family
756
>
*/
757
>
fontFamily?: string;
758
>
/**
759
>
* The font weight
760
>
*/
761
>
fontWeight?: string;
762
>
/**
763
>
* The font size
764
>
*/
765
>
fontSize?: number;
766
>
/**
767
>
* The line height
768
>
*/
769
>
lineHeight?: number;
770
>
/**
771
>
* The letter spacing
772
>
*/
773
>
letterSpacing?: number;
774
>
/**
775
>
* Controls fading out of unused variables.
776
>
*/
777
>
showUnused?: boolean;
778
>
/**
779
>
* Controls whether to focus the inline editor in the peek widget by default.
780
>
* Defaults to false.
781
>
*/
782
>
peekWidgetDefaultFocus?: 'tree' | 'editor';
783
>
784
>
/**
785
>
* Sets a placeholder for the editor.
786
>
* If set, the placeholder is shown if the editor is empty.
787
>
*/
788
>
placeholder?: string | undefined;
789
>
790
>
/**
791
>
* Controls whether the definition link opens element in the peek widget.
792
>
* Defaults to false.
793
>
*/
794
>
definitionLinkOpensInPeek?: boolean;
795
>
/**
796
>
* Controls strikethrough deprecated variables.
797
>
*/
798
>
showDeprecated?: boolean;
799
>
/**
800
>
* Controls whether suggestions allow matches in the middle of the word instead of only at the beginning
801
>
*/
802
>
matchOnWordStartOnly?: boolean;
803
>
/**
804
>
* Control the behavior and rendering of the inline hints.
805
>
*/
806
>
inlayHints?: IEditorInlayHintsOptions;
807
>
/**
808
>
* Control if the editor should use shadow DOM.
809
>
*/
810
>
useShadowDOM?: boolean;
811
>
/**
812
>
* Controls the behavior of editor guides.
813
>
*/
814
>
guides?: IGuidesOptions;
815
>
816
>
/**
817
>
* Controls the behavior of the unicode highlight feature
818
>
* (by default, ambiguous and invisible characters are highlighted).
819
>
*/
820
>
unicodeHighlight?: IUnicodeHighlightOptions;
821
>
822
>
/**
823
>
* Configures bracket pair colorization (disabled by default).
824
>
*/
825
>
bracketPairColorization?: IBracketPairColorizationOptions;
826
>
827
>
/**
828
>
* Controls dropping into the editor from an external source.
829
>
*
830
>
* When enabled, this shows a preview of the drop location and triggers an `onDropIntoEditor` event.
831
>
*/
832
>
dropIntoEditor?: IDropIntoEditorOptions;
833
>
834
>
/**
835
>
* Sets whether the new experimental edit context should be used instead of the text area.
836
>
*/
837
>
editContext?: boolean;
838
>
839
>
/**
840
>
* Controls whether to render rich HTML screen reader content when the EditContext is enabled
841
>
*/
842
>
renderRichScreenReaderContent?: boolean;
843
>
844
>
/**
845
>
* Controls support for changing how content is pasted into the editor.
846
>
*/
847
>
pasteAs?: IPasteAsOptions;
848
>
849
>
/**
850
>
* Controls whether the editor / terminal receives tabs or defers them to the workbench for navigation.
851
>
*/
852
>
tabFocusMode?: boolean;
853
>
854
>
/**
855
>
* Controls whether the accessibility hint should be provided to screen reader users when an inline completion is shown.
856
>
*/
857
>
inlineCompletionsAccessibilityVerbose?: boolean;
858
>
}
859
>
860
>
/**
861
>
* @internal
862
>
* The width of the minimap gutter, in pixels.
863
>
*/
864
>
export const MINIMAP_GUTTER_WIDTH = 8;
865
>
866
>
export interface IDiffEditorBaseOptions {
867
>
/**
868
>
* Allow the user to resize the diff editor split view.
869
>
* Defaults to true.
870
>
*/
871
>
enableSplitViewResizing?: boolean;
872
>
873
>
/**
874
>
* The default ratio when rendering side-by-side editors.
875
>
* Must be a number between 0 and 1, min sizes apply.
876
>
* Defaults to 0.5
877
>
*/
878
>
splitViewDefaultRatio?: number;
879
>
880
>
/**
881
>
* Render the differences in two side-by-side editors.
882
>
* Defaults to true.
883
>
*/
884
>
renderSideBySide?: boolean;
885
>
886
>
/**
887
>
* When `renderSideBySide` is enabled, `useInlineViewWhenSpaceIsLimited` is set,
888
>
* and the diff editor has a width less than `renderSideBySideInlineBreakpoint`, the inline view is used.
889
>
*/
890
>
renderSideBySideInlineBreakpoint?: number | undefined;
891
>
892
>
/**
893
>
* When `renderSideBySide` is enabled, `useInlineViewWhenSpaceIsLimited` is set,
894
>
* and the diff editor has a width less than `renderSideBySideInlineBreakpoint`, the inline view is used.
895
>
*/
896
>
useInlineViewWhenSpaceIsLimited?: boolean;
897
>
898
>
/**
899
>
* If set, the diff editor is optimized for small views.
900
>
* Defaults to `false`.
901
>
*/
902
>
compactMode?: boolean;
903
>
904
>
/**
905
>
* If set, the original editor's line numbers are hidden in the inline view.
906
>
* Defaults to `false`.
907
>
* @internal
908
>
*/
909
>
hideOriginalLineNumbers?: boolean;
910
>
911
>
/**
912
>
* Timeout in milliseconds after which diff computation is cancelled.
913
>
* Defaults to 5000.
914
>
*/
915
>
maxComputationTime?: number;
916
>
917
>
/**
918
>
* Maximum supported file size in MB.
919
>
* Defaults to 50.
920
>
*/
921
>
maxFileSize?: number;
922
>
923
>
/**
924
>
* Compute the diff by ignoring leading/trailing whitespace
925
>
* Defaults to true.
926
>
*/
927
>
ignoreTrimWhitespace?: boolean;
928
>
929
>
/**
930
>
* Render +/- indicators for added/deleted changes.
931
>
* Defaults to true.
932
>
*/
933
>
renderIndicators?: boolean;
934
>
935
>
/**
936
>
* Shows icons in the glyph margin to revert changes.
937
>
* Default to true.
938
>
*/
939
>
renderMarginRevertIcon?: boolean;
940
>
941
>
/**
942
>
* Indicates if the gutter menu should be rendered.
943
>
*/
944
>
renderGutterMenu?: boolean;
945
>
946
>
/**
947
>
* Original model should be editable?
948
>
* Defaults to false.
949
>
*/
950
>
originalEditable?: boolean;
951
>
952
>
/**
953
>
* Should the diff editor enable code lens?
954
>
* Defaults to false.
955
>
*/
956
>
diffCodeLens?: boolean;
957
>
958
>
/**
959
>
* Is the diff editor should render overview ruler
960
>
* Defaults to true
961
>
*/
962
>
renderOverviewRuler?: boolean;
963
>
964
>
/**
965
>
* Control the wrapping of the diff editor.
966
>
*/
967
>
diffWordWrap?: 'off' | 'on' | 'inherit';
968
>
969
>
/**
970
>
* Diff Algorithm
971
>
*/
972
>
diffAlgorithm?: 'legacy' | 'advanced' | 'advanced-external' | 'advanced-wasm';
973
>
974
>
/**
975
>
* Whether the diff editor aria label should be verbose.
976
>
*/
977
>
accessibilityVerbose?: boolean;
978
>
979
>
experimental?: {
980
>
/**
981
>
* Defaults to false.
982
>
*/
983
>
showMoves?: boolean;
984
>
985
>
showEmptyDecorations?: boolean;
986
>
987
>
/**
988
>
* Only applies when `renderSideBySide` is set to false.
989
>
*/
990
>
useTrueInlineView?: boolean;
991
>
};
992
>
993
>
/**
994
>
* Is the diff editor inside another editor
995
>
* Defaults to false
996
>
*/
997
>
isInEmbeddedEditor?: boolean;
998
>
999
>
/**
1000
>
* If the diff editor should only show the difference review mode.
1001
>
*/
1002
>
onlyShowAccessibleDiffViewer?: boolean;
1003
>
1004
>
hideUnchangedRegions?: {
1005
>
enabled?: boolean;
1006
>
revealLineCount?: number;
1007
>
minimumLineCount?: number;
1008
>
contextLineCount?: number;
1009
>
};
1010
>
}
1011
>
1012
>
/**
1013
>
* Configuration options for the diff editor.
1014
>
*/
1015
>
export interface IDiffEditorOptions extends IEditorOptions, IDiffEditorBaseOptions {
1016
>
}
1017
>
1018
>
/**
1019
>
* @internal
1020
>
*/
1021
>
export type ValidDiffEditorBaseOptions = Readonly<Required<IDiffEditorBaseOptions>>;
1022
>
1023
>
//#endregion
1024
>
1025
>
/**
1026
>
* An event describing that the configuration of the editor has changed.
1027
>
*/
1028
>
export class ConfigurationChangedEvent {
1029
>
private readonly _values: boolean[];
1030
>
/**
1031
>
* @internal
1032
>
*/
1033
>
constructor(values: boolean[]) {
1034
this._values = values;
1035
}
1037
return this._values[id];
1038
}
1040
>
1041
>
/**
1042
>
* All computed editor options.
1043
>
*/
1044
>
export interface IComputedEditorOptions {
1045
>
get<T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T>;
1046
>
}
1047
>
1048
>
//#region IEditorOption
1049
>
1050
>
/**
1051
>
* @internal
1052
>
*/
1053
>
export interface IEnvironmentalOptions {
1054
>
readonly memory: ComputeOptionsMemory | null;
1055
>
readonly outerWidth: number;
1056
>
readonly outerHeight: number;
1057
>
readonly fontInfo: FontInfo;
1058
>
readonly extraEditorClassName: string;
1059
>
readonly isDominatedByLongLines: boolean;
1060
>
readonly viewLineCount: number;
1061
>
readonly lineNumbersDigitCount: number;
1062
>
readonly emptySelectionClipboard: boolean;
1063
>
readonly pixelRatio: number;
1064
>
readonly tabFocusMode: boolean;
1065
>
readonly inputMode: 'insert' | 'overtype';
1066
>
readonly accessibilitySupport: AccessibilitySupport;
1067
>
readonly glyphMarginDecorationLaneCount: number;
1068
>
readonly editContextSupported: boolean;
1069
>
}
1070
>
1071
>
/**
1072
>
* @internal
1073
>
*/
1074
>
export class ComputeOptionsMemory {
1075
>
1076
>
public stableMinimapLayoutInput: IMinimapLayoutInput | null;
1077
>
public stableFitMaxMinimapScale: number;
1078
>
public stableFitRemainingWidth: number;
1079
>
1080
>
constructor() {
1081
this.stableMinimapLayoutInput = null;
1082
this.stableFitMaxMinimapScale = 0;
1083
this.stableFitRemainingWidth = 0;
1084
}
1086
>
1087
>
export interface IEditorOption<K extends EditorOption, V> {
1088
>
readonly id: K;
1089
>
readonly name: string;
1090
>
defaultValue: V;
1091
>
/**
1092
>
* @internal
1093
>
*/
1094
>
readonly schema: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema } | undefined;
1095
>
/**
1096
>
* @internal
1097
>
*/
1098
>
validate(input: unknown): V;
1099
>
/**
1100
>
* @internal
1101
>
*/
1102
>
compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V;
1103
>
1104
>
/**
1105
>
* Might modify `value`.
1106
>
*/
1107
>
applyUpdate(value: V | undefined, update: V): ApplyUpdateResult<V>;
1108
>
}
1109
>
1110
>
/**
1111
>
* @internal
1112
>
*/
1113
>
type PossibleKeyName0<V> = { [K in keyof IEditorOptions]: IEditorOptions[K] extends V | undefined ? K : never }[keyof IEditorOptions];
1114
>
/**
1115
>
* @internal
1116
>
*/
1117
>
type PossibleKeyName<V> = NonNullable<PossibleKeyName0<V>>;
1118
>
1119
>
/**
1120
>
* @internal
1121
>
*/
1122
>
abstract class BaseEditorOption<K extends EditorOption, T, V> implements IEditorOption<K, V> {
1123
>
1124
>
public readonly id: K;
1125
>
public readonly name: string;
1126
>
public readonly defaultValue: V;
1127
>
public readonly schema: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema } | undefined;
1128
>
1129
>
constructor(id: K, name: PossibleKeyName<T>, defaultValue: V, schema?: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema }) {
1130
>
this.id = id;
1131
>
this.name = name;
1132
>
this.defaultValue = defaultValue;
1133
>
this.schema = schema;
1134
>
}
1135
>
1136
>
public applyUpdate(value: V | undefined, update: V): ApplyUpdateResult<V> {
1137
return applyUpdate(value, update);
1138
}
1140
>
public abstract validate(input: unknown): V;
1141
>
1142
>
public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V {
1143
return value;
1144
}
1146
>
1147
>
export class ApplyUpdateResult<T> {
1148
>
constructor(
1149
public readonly newValue: T,
1150
public readonly didChange: boolean
1151
) { }
1153
>
1154
function applyUpdate<T>(value: T | undefined, update: T): ApplyUpdateResult<T> {
1155
if (typeof value !== 'object' || typeof update !== 'object' || !value || !update) {