Use null instead of undefined for openCodeEditor

mjbvz · mjbvz · commit db11576dbcae · 2019-09-19T17:38:07.000-07:00
microsoft#70384
diff --git a/src/vs/editor/browser/services/abstractCodeEditorService.ts b/src/vs/editor/browser/services/abstractCodeEditorService.ts
@@ -125,7 +125,7 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC
 	}
 
 	abstract getActiveCodeEditor(): ICodeEditor | undefined;
-	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
+	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined>;
 }
 
 export class ModelTransientSettingWatcher {
diff --git a/src/vs/editor/browser/services/codeEditorService.ts b/src/vs/editor/browser/services/codeEditorService.ts
@@ -46,5 +46,5 @@ export interface ICodeEditorService {
 	getTransientModelProperty(model: ITextModel, key: string): any;
 
 	getActiveCodeEditor(): ICodeEditor | undefined;
-	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
+	openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined>;
 }
diff --git a/src/vs/editor/browser/services/codeEditorServiceImpl.ts b/src/vs/editor/browser/services/codeEditorServiceImpl.ts
@@ -66,7 +66,7 @@ export abstract class CodeEditorServiceImpl extends AbstractCodeEditorService {
 	}
 
 	abstract getActiveCodeEditor(): ICodeEditor | undefined;
-	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
+	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined>;
 }
 
 interface IModelDecorationOptionsProvider extends IDisposable {
diff --git a/src/vs/editor/browser/services/openerService.ts b/src/vs/editor/browser/services/openerService.ts
@@ -14,7 +14,6 @@ import { URI } from 'vs/base/common/uri';
 import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';
 import { CommandsRegistry, ICommandService } from 'vs/platform/commands/common/commands';
 import { IOpener, IOpenerService, IValidator, IExternalUriResolver } from 'vs/platform/opener/common/opener';
-import { withUndefinedAsNull } from 'vs/base/common/types';
 
 export class OpenerService extends Disposable implements IOpenerService {
 
@@ -119,7 +118,7 @@ export class OpenerService extends Disposable implements IOpenerService {
 
 			return this._editorService.openCodeEditor(
 				{ resource, options: { selection, } },
-				withUndefinedAsNull(this._editorService.getFocusedCodeEditor()),
+				this._editorService.getFocusedCodeEditor(),
 				options && options.openToSide
 			).then(() => true);
 		}
diff --git a/src/vs/editor/contrib/goToDefinition/goToDefinitionCommands.ts b/src/vs/editor/contrib/goToDefinition/goToDefinitionCommands.ts
@@ -162,7 +162,7 @@ export class DefinitionAction extends EditorAction {
 		}
 	}
 
-	private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location | LocationLink, sideBySide: boolean): Promise<ICodeEditor | null> {
+	private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location | LocationLink, sideBySide: boolean): Promise<ICodeEditor | undefined> {
 		// range is the target-selection-range when we have one
 		// and the the fallback is the 'full' range
 		let range: IRange | undefined = undefined;
diff --git a/src/vs/editor/contrib/referenceSearch/referenceSearch.ts b/src/vs/editor/contrib/referenceSearch/referenceSearch.ts
@@ -28,7 +28,6 @@ import { URI } from 'vs/base/common/uri';
 import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';
 import { CancellationToken } from 'vs/base/common/cancellation';
 import { coalesce, flatten } from 'vs/base/common/arrays';
-import { withUndefinedAsNull } from 'vs/base/common/types';
 
 export const defaultReferenceSearchOptions: RequestOptions = {
 	getMetaTitle(model) {
@@ -107,7 +106,7 @@ let findReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour
 	}
 
 	const codeEditorService = accessor.get(ICodeEditorService);
-	return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {
+	return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {
 		if (!isCodeEditor(control) || !control.hasModel()) {
 			return undefined;
 		}
@@ -133,7 +132,7 @@ let showReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour
 	}
 
 	const codeEditorService = accessor.get(ICodeEditorService);
-	return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {
+	return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {
 		if (!isCodeEditor(control)) {
 			return undefined;
 		}
diff --git a/src/vs/editor/contrib/rename/rename.ts b/src/vs/editor/contrib/rename/rename.ts
@@ -29,7 +29,6 @@ import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService
 import { CancellationToken } from 'vs/base/common/cancellation';
 import { Disposable } from 'vs/base/common/lifecycle';
 import { CancelablePromise, createCancelablePromise } from 'vs/base/common/async';
-import { withUndefinedAsNull } from 'vs/base/common/types';
 
 class RenameSkeleton {
 
@@ -286,7 +285,7 @@ export class RenameAction extends EditorAction {
 		const [uri, pos] = Array.isArray(args) && args || [undefined, undefined];
 
 		if (URI.isUri(uri) && Position.isIPosition(pos)) {
-			return editorService.openCodeEditor({ resource: uri }, withUndefinedAsNull(editorService.getActiveCodeEditor())).then(editor => {
+			return editorService.openCodeEditor({ resource: uri }, editorService.getActiveCodeEditor()).then(editor => {
 				if (!editor) {
 					return;
 				}
diff --git a/src/vs/editor/standalone/browser/standaloneCodeServiceImpl.ts b/src/vs/editor/standalone/browser/standaloneCodeServiceImpl.ts
@@ -19,15 +19,15 @@ export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {
 		return undefined; // not supported in the standalone case
 	}
 
-	public openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
+	public openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
 		if (!source) {
-			return Promise.resolve(null);
+			return Promise.resolve(undefined);
 		}
 
 		return Promise.resolve(this.doOpenEditor(source, input));
 	}
 
-	private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor | null {
+	private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor | undefined {
 		const model = this.findModel(editor, input.resource);
 		if (!model) {
 			if (input.resource) {
@@ -39,7 +39,7 @@ export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {
 					return editor;
 				}
 			}
-			return null;
+			return undefined;
 		}
 
 		const selection = <IRange>(input.options ? input.options.selection : null);
diff --git a/src/vs/editor/test/browser/editorTestServices.ts b/src/vs/editor/test/browser/editorTestServices.ts
@@ -15,9 +15,9 @@ import { IInstantiationService } from 'vs/platform/instantiation/common/instanti
 export class TestCodeEditorService extends AbstractCodeEditorService {
 	public lastInput?: IResourceInput;
 	public getActiveCodeEditor(): ICodeEditor | undefined { return undefined; }
-	public openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
+	public openCodeEditor(input: IResourceInput, _source: ICodeEditor | undefined, _sideBySide?: boolean): Promise<ICodeEditor | undefined> {
 		this.lastInput = input;
-		return Promise.resolve(null);
+		return Promise.resolve(undefined);
 	}
 	public registerDecorationType(key: string, options: IDecorationRenderOptions, parentTypeKey?: string): void { }
 	public removeDecorationType(key: string): void { }
diff --git a/src/vs/editor/test/browser/services/decorationRenderOptions.test.ts b/src/vs/editor/test/browser/services/decorationRenderOptions.test.ts
@@ -19,8 +19,8 @@ export class TestCodeEditorServiceImpl extends CodeEditorServiceImpl {
 		return undefined;
 	}
 
-	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
-		return Promise.resolve(null);
+	openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
+		return Promise.resolve(undefined);
 	}
 }
 
diff --git a/src/vs/workbench/browser/parts/editor/breadcrumbsControl.ts b/src/vs/workbench/browser/parts/editor/breadcrumbsControl.ts
@@ -45,7 +45,7 @@ import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
 import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';
 import { IEditorGroupView } from 'vs/workbench/browser/parts/editor/editor';
 import { onDidChangeZoomLevel } from 'vs/base/browser/browser';
-import { withNullAsUndefined, withUndefinedAsNull } from 'vs/base/common/types';
+import { withNullAsUndefined } from 'vs/base/common/types';
 import { ILabelService } from 'vs/platform/label/common/label';
 
 class Item extends BreadcrumbsItem {
@@ -485,7 +485,7 @@ export class BreadcrumbsControl {
 						selection: Range.collapseToStart(element.symbol.selectionRange),
 						revealInCenterIfOutsideViewport: true
 					}
-				}, withUndefinedAsNull(this._getActiveCodeEditor()), group === SIDE_GROUP);
+				}, this._getActiveCodeEditor(), group === SIDE_GROUP);
 			}
 		}
 	}
diff --git a/src/vs/workbench/services/editor/browser/codeEditorService.ts b/src/vs/workbench/services/editor/browser/codeEditorService.ts
@@ -35,7 +35,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 		return undefined;
 	}
 
-	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
+	openCodeEditor(input: IResourceInput, source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
 
 		// Special case: If the active editor is a diff editor and the request to open originates and
 		// targets the modified side of it, we just apply the request there to prevent opening the modified
@@ -62,7 +62,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 		return this.doOpenCodeEditor(input, source, sideBySide);
 	}
 
-	private async doOpenCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
+	private async doOpenCodeEditor(input: IResourceInput, _source: ICodeEditor | undefined, sideBySide?: boolean): Promise<ICodeEditor | undefined> {
 		const control = await this.editorService.openEditor(input, sideBySide ? SIDE_GROUP : ACTIVE_GROUP);
 		if (control) {
 			const widget = control.getControl();
@@ -71,7 +71,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 			}
 		}
 
-		return null;
+		return undefined;
 	}
 }
 
diff --git a/src/vs/workbench/test/workbenchTestServices.ts b/src/vs/workbench/test/workbenchTestServices.ts
@@ -1174,7 +1174,7 @@ export class TestCodeEditorService implements ICodeEditorService {
 	setTransientModelProperty(_model: ITextModel, _key: string, _value: any): void { }
 	getTransientModelProperty(_model: ITextModel, _key: string) { }
 	getActiveCodeEditor(): ICodeEditor | undefined { return undefined; }
-	openCodeEditor(_input: IResourceInput, _source: ICodeEditor, _sideBySide?: boolean): Promise<ICodeEditor | null> { return Promise.resolve(null); }
+	openCodeEditor(_input: IResourceInput, _source: ICodeEditor, _sideBySide?: boolean): Promise<ICodeEditor | undefined> { return Promise.resolve(undefined); }
 }
 
 export class TestWindowService implements IWindowService {

Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`abstract getActiveCodeEditor(): ICodeEditor \| undefined;`
`128`		`- abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
	`128`	`+ abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined>;`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`export class ModelTransientSettingWatcher {`
Original file line number	Diff line number	Diff line change
`@@ -46,5 +46,5 @@ export interface ICodeEditorService {`
`46`	`46`	`getTransientModelProperty(model: ITextModel, key: string): any;`
`47`	`47`
`48`	`48`	`getActiveCodeEditor(): ICodeEditor \| undefined;`
`49`		`- openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
	`49`	`+ openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined>;`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ export abstract class CodeEditorServiceImpl extends AbstractCodeEditorService {`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`abstract getActiveCodeEditor(): ICodeEditor \| undefined;`
`69`		`- abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
	`69`	`+ abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined>;`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`interface IModelDecorationOptionsProvider extends IDisposable {`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ export class DefinitionAction extends EditorAction {`
`162`	`162`	`}`
`163`	`163`	`}`
`164`	`164`
`165`		`- private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location \| LocationLink, sideBySide: boolean): Promise<ICodeEditor \| null> {`
	`165`	`+ private _openReference(editor: ICodeEditor, editorService: ICodeEditorService, reference: Location \| LocationLink, sideBySide: boolean): Promise<ICodeEditor \| undefined> {`
`166`	`166`	`// range is the target-selection-range when we have one`
`167`	`167`	`// and the the fallback is the 'full' range`
`168`	`168`	`let range: IRange \| undefined = undefined;`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ import { URI } from 'vs/base/common/uri';`
`28`	`28`	`import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService';`
`29`	`29`	`import { CancellationToken } from 'vs/base/common/cancellation';`
`30`	`30`	`import { coalesce, flatten } from 'vs/base/common/arrays';`
`31`		`-import { withUndefinedAsNull } from 'vs/base/common/types';`
`32`	`31`
`33`	`32`	`export const defaultReferenceSearchOptions: RequestOptions = {`
`34`	`33`	`getMetaTitle(model) {`
`@@ -107,7 +106,7 @@ let findReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour`
`107`	`106`	`}`
`108`	`107`
`109`	`108`	`const codeEditorService = accessor.get(ICodeEditorService);`
`110`		`- return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {`
	`109`	`+ return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {`
`111`	`110`	`if (!isCodeEditor(control) \|\| !control.hasModel()) {`
`112`	`111`	`return undefined;`
`113`	`112`	`}`
`@@ -133,7 +132,7 @@ let showReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour`
`133`	`132`	`}`
`134`	`133`
`135`	`134`	`const codeEditorService = accessor.get(ICodeEditorService);`
`136`		`- return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {`
	`135`	`+ return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {`
`137`	`136`	`if (!isCodeEditor(control)) {`
`138`	`137`	`return undefined;`
`139`	`138`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,15 +19,15 @@ export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`19`	`19`	`return undefined; // not supported in the standalone case`
`20`	`20`	`}`
`21`	`21`
`22`		`- public openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null> {`
	`22`	`+ public openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined> {`
`23`	`23`	`if (!source) {`
`24`		`- return Promise.resolve(null);`
	`24`	`+ return Promise.resolve(undefined);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`return Promise.resolve(this.doOpenEditor(source, input));`
`28`	`28`	`}`
`29`	`29`
`30`		`- private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor \| null {`
	`30`	`+ private doOpenEditor(editor: ICodeEditor, input: IResourceInput): ICodeEditor \| undefined {`
`31`	`31`	`const model = this.findModel(editor, input.resource);`
`32`	`32`	`if (!model) {`
`33`	`33`	`if (input.resource) {`
`@@ -39,7 +39,7 @@ export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`39`	`39`	`return editor;`
`40`	`40`	`}`
`41`	`41`	`}`
`42`		`- return null;`
	`42`	`+ return undefined;`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`const selection = <IRange>(input.options ? input.options.selection : null);`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ export class TestCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`19`	`19`	`return undefined;`
`20`	`20`	`}`
`21`	`21`
`22`		`- openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null> {`
`23`		`- return Promise.resolve(null);`
	`22`	`+ openCodeEditor(input: IResourceInput, source: ICodeEditor \| undefined, sideBySide?: boolean): Promise<ICodeEditor \| undefined> {`
	`23`	`+ return Promise.resolve(undefined);`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`