Skip to content

Commit e7376ad

Browse files
jriekenjrieken
committed
better names for TextDocumentSaveReason, microsoft#12830 
1 parent 5c602c0 commit e7376ad

4 files changed

Lines changed: 38 additions & 37 deletions

File tree

‎src/vs/vscode.d.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3588,14 +3588,15 @@ declare namespace vscode {
35883588
export enum TextDocumentSaveReason {
35893589

35903590
/**
3591-
* Explicitly triggered, e.g. by the user pressing save or by an API call.
3591+
* Manually triggered, e.g. by the user pressing save, by starting debugging,
3592+
* or by an API call.
35923593
*/
3593-
Explicit = 1,
3594+
Manual = 1,
35943595

35953596
/**
35963597
* Automatic after a delay.
35973598
*/
3598-
Auto = 2,
3599+
AfterDelay = 2,
35993600

36003601
/**
36013602
* When the editor lost focus.

‎src/vs/workbench/api/node/extHostTypeConverters.ts‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
*--------------------------------------------------------------------------------------------*/
55
'use strict';
66

7-
import {ExtHostCommands} from 'vs/workbench/api/node/extHostCommands';
7+
import { ExtHostCommands } from 'vs/workbench/api/node/extHostCommands';
88
import Severity from 'vs/base/common/severity';
9-
import {isFalsyOrEmpty} from 'vs/base/common/arrays';
10-
import {IDisposable} from 'vs/base/common/lifecycle';
11-
import {stringDiff} from 'vs/base/common/diff/diff';
9+
import { isFalsyOrEmpty } from 'vs/base/common/arrays';
10+
import { IDisposable } from 'vs/base/common/lifecycle';
11+
import { stringDiff } from 'vs/base/common/diff/diff';
1212
import * as modes from 'vs/editor/common/modes';
1313
import * as types from './extHostTypes';
14-
import {Position as EditorPosition} from 'vs/platform/editor/common/editor';
15-
import {IPosition, ISelection, IRange, IDecorationOptions, ISingleEditOperation} from 'vs/editor/common/editorCommon';
16-
import {IWorkspaceSymbol} from 'vs/workbench/parts/search/common/search';
14+
import { Position as EditorPosition } from 'vs/platform/editor/common/editor';
15+
import { IPosition, ISelection, IRange, IDecorationOptions, ISingleEditOperation } from 'vs/editor/common/editorCommon';
16+
import { IWorkspaceSymbol } from 'vs/workbench/parts/search/common/search';
1717
import * as vscode from 'vscode';
1818
import URI from 'vs/base/common/uri';
1919
import { SaveReason } from 'vs/workbench/parts/files/common/files';
@@ -69,8 +69,8 @@ export function toPosition(position: IPosition): types.Position {
6969
return new types.Position(position.lineNumber - 1, position.column - 1);
7070
}
7171

72-
export function fromPosition(position: types.Position):IPosition {
73-
return { lineNumber: position.line + 1, column: position.character + 1};
72+
export function fromPosition(position: types.Position): IPosition {
73+
return { lineNumber: position.line + 1, column: position.character + 1 };
7474
}
7575

7676
export function fromDiagnosticSeverity(value: number): Severity {
@@ -118,26 +118,26 @@ export function toViewColumn(position?: EditorPosition): vscode.ViewColumn {
118118
return;
119119
}
120120
if (position === EditorPosition.LEFT) {
121-
return <number> types.ViewColumn.One;
121+
return <number>types.ViewColumn.One;
122122
} else if (position === EditorPosition.CENTER) {
123-
return <number> types.ViewColumn.Two;
123+
return <number>types.ViewColumn.Two;
124124
} else if (position === EditorPosition.RIGHT) {
125-
return <number> types.ViewColumn.Three;
125+
return <number>types.ViewColumn.Three;
126126
}
127127
}
128128

129129
function isDecorationOptions(something: any): something is vscode.DecorationOptions {
130130
return (typeof something.range !== 'undefined');
131131
}
132132

133-
function isDecorationOptionsArr(something: vscode.Range[]|vscode.DecorationOptions[]): something is vscode.DecorationOptions[] {
133+
function isDecorationOptionsArr(something: vscode.Range[] | vscode.DecorationOptions[]): something is vscode.DecorationOptions[] {
134134
if (something.length === 0) {
135135
return true;
136136
}
137137
return isDecorationOptions(something[0]) ? true : false;
138138
}
139139

140-
export function fromRangeOrRangeWithMessage(ranges:vscode.Range[]|vscode.DecorationOptions[]): IDecorationOptions[] {
140+
export function fromRangeOrRangeWithMessage(ranges: vscode.Range[] | vscode.DecorationOptions[]): IDecorationOptions[] {
141141
if (isDecorationOptionsArr(ranges)) {
142142
return ranges.map((r): IDecorationOptions => {
143143
return {
@@ -182,8 +182,8 @@ export const TextEdit = {
182182

183183
for (let j = 0; j < changes.length; j++) {
184184
const {originalStart, originalLength, modifiedStart, modifiedLength} = changes[j];
185-
const start = fromPosition(<types.Position> document.positionAt(editOffset + originalStart));
186-
const end = fromPosition(<types.Position> document.positionAt(editOffset + originalStart + originalLength));
185+
const start = fromPosition(<types.Position>document.positionAt(editOffset + originalStart));
186+
const end = fromPosition(<types.Position>document.positionAt(editOffset + originalStart + originalLength));
187187

188188
result.push({
189189
text: modified.substr(modifiedStart, modifiedLength),
@@ -195,7 +195,7 @@ export const TextEdit = {
195195
return result;
196196
},
197197

198-
from(edit: vscode.TextEdit): ISingleEditOperation{
198+
from(edit: vscode.TextEdit): ISingleEditOperation {
199199
return <ISingleEditOperation>{
200200
text: edit.newText,
201201
range: fromRange(edit.range)
@@ -443,9 +443,9 @@ export namespace TextDocumentSaveReason {
443443
export function to(reason: SaveReason): vscode.TextDocumentSaveReason {
444444
switch (reason) {
445445
case SaveReason.AUTO:
446-
return types.TextDocumentSaveReason.Auto;
446+
return types.TextDocumentSaveReason.AfterDelay;
447447
case SaveReason.EXPLICIT:
448-
return types.TextDocumentSaveReason.Explicit;
448+
return types.TextDocumentSaveReason.Manual;
449449
case SaveReason.FOCUS_CHANGE:
450450
case SaveReason.WINDOW_CHANGE:
451451
return types.TextDocumentSaveReason.FocusOut;

‎src/vs/workbench/api/node/extHostTypes.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
'use strict';
66

77
import URI from 'vs/base/common/uri';
8-
import {illegalArgument} from 'vs/base/common/errors';
8+
import { illegalArgument } from 'vs/base/common/errors';
99

1010
export class Disposable {
1111

@@ -149,7 +149,7 @@ export class Position {
149149
}
150150
}
151151

152-
translate(change: { lineDelta?: number; characterDelta?: number;}): Position;
152+
translate(change: { lineDelta?: number; characterDelta?: number; }): Position;
153153
translate(lineDelta?: number, characterDelta?: number): Position;
154154
translate(lineDeltaOrChange: number | { lineDelta?: number; characterDelta?: number; }, characterDelta: number = 0): Position {
155155

@@ -230,7 +230,7 @@ export class Range {
230230

231231
constructor(start: Position, end: Position);
232232
constructor(startLine: number, startColumn: number, endLine: number, endColumn: number);
233-
constructor(startLineOrStart: number|Position, startColumnOrEnd: number|Position, endLine?: number, endColumn?: number) {
233+
constructor(startLineOrStart: number | Position, startColumnOrEnd: number | Position, endLine?: number, endColumn?: number) {
234234
let start: Position;
235235
let end: Position;
236236

@@ -367,7 +367,7 @@ export class Selection extends Range {
367367

368368
constructor(anchor: Position, active: Position);
369369
constructor(anchorLine: number, anchorColumn: number, activeLine: number, activeColumn: number);
370-
constructor(anchorLineOrAnchor: number|Position, anchorColumnOrActive: number|Position, activeLine?: number, activeColumn?: number) {
370+
constructor(anchorLineOrAnchor: number | Position, anchorColumnOrActive: number | Position, activeLine?: number, activeColumn?: number) {
371371
let anchor: Position;
372372
let active: Position;
373373

@@ -679,7 +679,7 @@ export class SymbolInformation {
679679
if (locationOrUri instanceof Location) {
680680
this.location = locationOrUri;
681681
} else if (rangeOrContainer instanceof Range) {
682-
this.location = new Location(<URI> locationOrUri, rangeOrContainer);
682+
this.location = new Location(<URI>locationOrUri, rangeOrContainer);
683683
}
684684
}
685685

@@ -832,8 +832,8 @@ export enum TextEditorLineNumbersStyle {
832832
}
833833

834834
export enum TextDocumentSaveReason {
835-
Explicit = 1,
836-
Auto = 2,
835+
Manual = 1,
836+
AfterDelay = 2,
837837
FocusOut = 3
838838
}
839839

‎src/vs/workbench/test/node/api/extHostDocumentSaveParticipant.test.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66

77
import * as assert from 'assert';
88
import URI from 'vs/base/common/uri';
9-
import {TPromise} from 'vs/base/common/winjs.base';
10-
import {ExtHostDocuments} from 'vs/workbench/api/node/extHostDocuments';
11-
import {TextDocumentSaveReason, TextEdit, Position} from 'vs/workbench/api/node/extHostTypes';
12-
import {MainThreadWorkspaceShape} from 'vs/workbench/api/node/extHost.protocol';
13-
import {ExtHostDocumentSaveParticipant} from 'vs/workbench/api/node/extHostDocumentSaveParticipant';
14-
import {OneGetThreadService} from './testThreadService';
9+
import { TPromise } from 'vs/base/common/winjs.base';
10+
import { ExtHostDocuments } from 'vs/workbench/api/node/extHostDocuments';
11+
import { TextDocumentSaveReason, TextEdit, Position } from 'vs/workbench/api/node/extHostTypes';
12+
import { MainThreadWorkspaceShape } from 'vs/workbench/api/node/extHost.protocol';
13+
import { ExtHostDocumentSaveParticipant } from 'vs/workbench/api/node/extHostDocumentSaveParticipant';
14+
import { OneGetThreadService } from './testThreadService';
1515
import * as EditorCommon from 'vs/editor/common/editorCommon';
16-
import {IResourceEdit} from 'vs/editor/common/services/bulkEdit';
16+
import { IResourceEdit } from 'vs/editor/common/services/bulkEdit';
1717
import { SaveReason } from 'vs/workbench/parts/files/common/files';
1818

1919
suite('ExtHostDocumentSaveParticipant', () => {
@@ -62,7 +62,7 @@ suite('ExtHostDocumentSaveParticipant', () => {
6262
sub.dispose();
6363

6464
assert.ok(event);
65-
assert.equal(event.reason, TextDocumentSaveReason.Explicit);
65+
assert.equal(event.reason, TextDocumentSaveReason.Manual);
6666
assert.equal(typeof event.waitUntil, 'function');
6767
});
6868
});

0 commit comments

Comments
 (0)