-
Notifications
You must be signed in to change notification settings - Fork 29k
/
formatActions.ts
303 lines (261 loc) · 10.4 KB
/
formatActions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { isNonEmptyArray } from 'vs/base/common/arrays';
import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
import { onUnexpectedError } from 'vs/base/common/errors';
import { KeyChord, KeyCode, KeyMod } from 'vs/base/common/keyCodes';
import { DisposableStore } from 'vs/base/common/lifecycle';
import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
import { EditorAction, EditorContributionInstantiation, registerEditorAction, registerEditorContribution, ServicesAccessor } from 'vs/editor/browser/editorExtensions';
import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';
import { EditorOption } from 'vs/editor/common/config/editorOptions';
import { CharacterSet } from 'vs/editor/common/core/characterClassifier';
import { Range } from 'vs/editor/common/core/range';
import { IEditorContribution } from 'vs/editor/common/editorCommon';
import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
import { IEditorWorkerService } from 'vs/editor/common/services/editorWorker';
import { ILanguageFeaturesService } from 'vs/editor/common/services/languageFeatures';
import { alertFormattingEdits, formatDocumentRangesWithSelectedProvider, formatDocumentWithSelectedProvider, FormattingMode, getOnTypeFormattingEdits } from 'vs/editor/contrib/format/browser/format';
import { FormattingEdit } from 'vs/editor/contrib/format/browser/formattingEdit';
import * as nls from 'vs/nls';
import { CommandsRegistry, ICommandService } from 'vs/platform/commands/common/commands';
import { ContextKeyExpr } from 'vs/platform/contextkey/common/contextkey';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
import { IEditorProgressService, Progress } from 'vs/platform/progress/common/progress';
class FormatOnType implements IEditorContribution {
public static readonly ID = 'editor.contrib.autoFormat';
private readonly _disposables = new DisposableStore();
private readonly _sessionDisposables = new DisposableStore();
constructor(
private readonly _editor: ICodeEditor,
@ILanguageFeaturesService private readonly _languageFeaturesService: ILanguageFeaturesService,
@IEditorWorkerService private readonly _workerService: IEditorWorkerService
) {
this._disposables.add(_languageFeaturesService.onTypeFormattingEditProvider.onDidChange(this._update, this));
this._disposables.add(_editor.onDidChangeModel(() => this._update()));
this._disposables.add(_editor.onDidChangeModelLanguage(() => this._update()));
this._disposables.add(_editor.onDidChangeConfiguration(e => {
if (e.hasChanged(EditorOption.formatOnType)) {
this._update();
}
}));
this._update();
}
dispose(): void {
this._disposables.dispose();
this._sessionDisposables.dispose();
}
private _update(): void {
// clean up
this._sessionDisposables.clear();
// we are disabled
if (!this._editor.getOption(EditorOption.formatOnType)) {
return;
}
// no model
if (!this._editor.hasModel()) {
return;
}
const model = this._editor.getModel();
// no support
const [support] = this._languageFeaturesService.onTypeFormattingEditProvider.ordered(model);
if (!support || !support.autoFormatTriggerCharacters) {
return;
}
// register typing listeners that will trigger the format
const triggerChars = new CharacterSet();
for (const ch of support.autoFormatTriggerCharacters) {
triggerChars.add(ch.charCodeAt(0));
}
this._sessionDisposables.add(this._editor.onDidType((text: string) => {
const lastCharCode = text.charCodeAt(text.length - 1);
if (triggerChars.has(lastCharCode)) {
this._trigger(String.fromCharCode(lastCharCode));
}
}));
}
private _trigger(ch: string): void {
if (!this._editor.hasModel()) {
return;
}
if (this._editor.getSelections().length > 1 || !this._editor.getSelection().isEmpty()) {
return;
}
const model = this._editor.getModel();
const position = this._editor.getPosition();
const cts = new CancellationTokenSource();
// install a listener that checks if edits happens before the
// position on which we format right now. If so, we won't
// apply the format edits
const unbind = this._editor.onDidChangeModelContent((e) => {
if (e.isFlush) {
// a model.setValue() was called
// cancel only once
cts.cancel();
unbind.dispose();
return;
}
for (let i = 0, len = e.changes.length; i < len; i++) {
const change = e.changes[i];
if (change.range.endLineNumber <= position.lineNumber) {
// cancel only once
cts.cancel();
unbind.dispose();
return;
}
}
});
getOnTypeFormattingEdits(
this._workerService,
this._languageFeaturesService,
model,
position,
ch,
model.getFormattingOptions(),
cts.token
).then(edits => {
if (cts.token.isCancellationRequested) {
return;
}
if (isNonEmptyArray(edits)) {
FormattingEdit.execute(this._editor, edits, true);
alertFormattingEdits(edits);
}
}).finally(() => {
unbind.dispose();
});
}
}
class FormatOnPaste implements IEditorContribution {
public static readonly ID = 'editor.contrib.formatOnPaste';
private readonly _callOnDispose = new DisposableStore();
private readonly _callOnModel = new DisposableStore();
constructor(
private readonly editor: ICodeEditor,
@ILanguageFeaturesService private readonly _languageFeaturesService: ILanguageFeaturesService,
@IInstantiationService private readonly _instantiationService: IInstantiationService,
) {
this._callOnDispose.add(editor.onDidChangeConfiguration(() => this._update()));
this._callOnDispose.add(editor.onDidChangeModel(() => this._update()));
this._callOnDispose.add(editor.onDidChangeModelLanguage(() => this._update()));
this._callOnDispose.add(_languageFeaturesService.documentRangeFormattingEditProvider.onDidChange(this._update, this));
}
dispose(): void {
this._callOnDispose.dispose();
this._callOnModel.dispose();
}
private _update(): void {
// clean up
this._callOnModel.clear();
// we are disabled
if (!this.editor.getOption(EditorOption.formatOnPaste)) {
return;
}
// no model
if (!this.editor.hasModel()) {
return;
}
// no formatter
if (!this._languageFeaturesService.documentRangeFormattingEditProvider.has(this.editor.getModel())) {
return;
}
this._callOnModel.add(this.editor.onDidPaste(({ range }) => this._trigger(range)));
}
private _trigger(range: Range): void {
if (!this.editor.hasModel()) {
return;
}
if (this.editor.getSelections().length > 1) {
return;
}
this._instantiationService.invokeFunction(formatDocumentRangesWithSelectedProvider, this.editor, range, FormattingMode.Silent, Progress.None, CancellationToken.None).catch(onUnexpectedError);
}
}
class FormatDocumentAction extends EditorAction {
constructor() {
super({
id: 'editor.action.formatDocument',
label: nls.localize('formatDocument.label', "Format Document"),
alias: 'Format Document',
precondition: ContextKeyExpr.and(EditorContextKeys.notInCompositeEditor, EditorContextKeys.writable, EditorContextKeys.hasDocumentFormattingProvider),
kbOpts: {
kbExpr: EditorContextKeys.editorTextFocus,
primary: KeyMod.Shift | KeyMod.Alt | KeyCode.KeyF,
linux: { primary: KeyMod.CtrlCmd | KeyMod.Shift | KeyCode.KeyI },
weight: KeybindingWeight.EditorContrib
},
contextMenuOpts: {
group: '1_modification',
order: 1.3
}
});
}
async run(accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
if (editor.hasModel()) {
const instaService = accessor.get(IInstantiationService);
const progressService = accessor.get(IEditorProgressService);
await progressService.showWhile(
instaService.invokeFunction(formatDocumentWithSelectedProvider, editor, FormattingMode.Explicit, Progress.None, CancellationToken.None),
250
);
}
}
}
class FormatSelectionAction extends EditorAction {
constructor() {
super({
id: 'editor.action.formatSelection',
label: nls.localize('formatSelection.label', "Format Selection"),
alias: 'Format Selection',
precondition: ContextKeyExpr.and(EditorContextKeys.writable, EditorContextKeys.hasDocumentSelectionFormattingProvider),
kbOpts: {
kbExpr: EditorContextKeys.editorTextFocus,
primary: KeyChord(KeyMod.CtrlCmd | KeyCode.KeyK, KeyMod.CtrlCmd | KeyCode.KeyF),
weight: KeybindingWeight.EditorContrib
},
contextMenuOpts: {
when: EditorContextKeys.hasNonEmptySelection,
group: '1_modification',
order: 1.31
}
});
}
async run(accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
if (!editor.hasModel()) {
return;
}
const instaService = accessor.get(IInstantiationService);
const model = editor.getModel();
const ranges = editor.getSelections().map(range => {
return range.isEmpty()
? new Range(range.startLineNumber, 1, range.startLineNumber, model.getLineMaxColumn(range.startLineNumber))
: range;
});
const progressService = accessor.get(IEditorProgressService);
await progressService.showWhile(
instaService.invokeFunction(formatDocumentRangesWithSelectedProvider, editor, ranges, FormattingMode.Explicit, Progress.None, CancellationToken.None),
250
);
}
}
registerEditorContribution(FormatOnType.ID, FormatOnType, EditorContributionInstantiation.BeforeFirstInteraction);
registerEditorContribution(FormatOnPaste.ID, FormatOnPaste, EditorContributionInstantiation.BeforeFirstInteraction);
registerEditorAction(FormatDocumentAction);
registerEditorAction(FormatSelectionAction);
// this is the old format action that does both (format document OR format selection)
// and we keep it here such that existing keybinding configurations etc will still work
CommandsRegistry.registerCommand('editor.action.format', async accessor => {
const editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();
if (!editor || !editor.hasModel()) {
return;
}
const commandService = accessor.get(ICommandService);
if (editor.getSelection().isEmpty()) {
await commandService.executeCommand('editor.action.formatDocument');
} else {
await commandService.executeCommand('editor.action.formatSelection');
}
});