Make getFocusedCodeEditor return undefined instead of null

mjbvz · mjbvz · commit b18ef0e7340d · 2019-09-19T17:23:38.000-07:00
microsoft#70384
diff --git a/src/vs/editor/browser/services/abstractCodeEditorService.ts b/src/vs/editor/browser/services/abstractCodeEditorService.ts
@@ -70,8 +70,8 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC
 		return Object.keys(this._diffEditors).map(id => this._diffEditors[id]);
 	}
 
-	getFocusedCodeEditor(): ICodeEditor | null {
-		let editorWithWidgetFocus: ICodeEditor | null = null;
+	getFocusedCodeEditor(): ICodeEditor | undefined {
+		let editorWithWidgetFocus: ICodeEditor | undefined;
 
 		const editors = this.listCodeEditors();
 		for (const editor of editors) {
diff --git a/src/vs/editor/browser/services/codeEditorService.ts b/src/vs/editor/browser/services/codeEditorService.ts
@@ -33,9 +33,10 @@ export interface ICodeEditorService {
 	listDiffEditors(): IDiffEditor[];
 
 	/**
-	 * Returns the current focused code editor (if the focus is in the editor or in an editor widget) or null.
+	 * Returns the current focused code editor (if the focus is in the editor or in an editor widget) or
+	 * `undefined` if none.
 	 */
-	getFocusedCodeEditor(): ICodeEditor | null;
+	getFocusedCodeEditor(): ICodeEditor | undefined;
 
 	registerDecorationType(key: string, options: IDecorationRenderOptions, parentTypeKey?: string): void;
 	removeDecorationType(key: string): void;
diff --git a/src/vs/editor/browser/services/openerService.ts b/src/vs/editor/browser/services/openerService.ts
@@ -14,6 +14,7 @@ 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 {
 
@@ -118,7 +119,7 @@ export class OpenerService extends Disposable implements IOpenerService {
 
 			return this._editorService.openCodeEditor(
 				{ resource, options: { selection, } },
-				this._editorService.getFocusedCodeEditor(),
+				withUndefinedAsNull(this._editorService.getFocusedCodeEditor()),
 				options && options.openToSide
 			).then(() => true);
 		}
diff --git a/src/vs/editor/contrib/referenceSearch/peekViewWidget.ts b/src/vs/editor/contrib/referenceSearch/peekViewWidget.ts
@@ -57,8 +57,8 @@ export namespace PeekContext {
 	export const notInPeekEditor: ContextKeyExpr = inPeekEditor.toNegated();
 }
 
-export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor | null {
-	let editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();
+export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor | undefined {
+	const editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();
 	if (editor instanceof EmbeddedCodeEditorWidget) {
 		return editor.getParentEditor();
 	}
diff --git a/src/vs/editor/contrib/referenceSearch/referenceSearch.ts b/src/vs/editor/contrib/referenceSearch/referenceSearch.ts
@@ -28,6 +28,7 @@ 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) {
@@ -106,7 +107,7 @@ let findReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour
 	}
 
 	const codeEditorService = accessor.get(ICodeEditorService);
-	return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {
+	return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {
 		if (!isCodeEditor(control) || !control.hasModel()) {
 			return undefined;
 		}
@@ -132,7 +133,7 @@ let showReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour
 	}
 
 	const codeEditorService = accessor.get(ICodeEditorService);
-	return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {
+	return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {
 		if (!isCodeEditor(control)) {
 			return undefined;
 		}
diff --git a/src/vs/workbench/contrib/scm/browser/dirtydiffDecorator.ts b/src/vs/workbench/contrib/scm/browser/dirtydiffDecorator.ts
@@ -149,7 +149,7 @@ function getChangeTypeColor(theme: ITheme, changeType: ChangeType): Color | unde
 	}
 }
 
-function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor | null {
+function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor | undefined {
 	const diffEditors = accessor.get(ICodeEditorService).listDiffEditors();
 
 	for (const diffEditor of diffEditors) {
diff --git a/src/vs/workbench/test/workbenchTestServices.ts b/src/vs/workbench/test/workbenchTestServices.ts
@@ -1167,7 +1167,7 @@ export class TestCodeEditorService implements ICodeEditorService {
 	addDiffEditor(_editor: IDiffEditor): void { }
 	removeDiffEditor(_editor: IDiffEditor): void { }
 	listDiffEditors(): IDiffEditor[] { return []; }
-	getFocusedCodeEditor(): ICodeEditor | null { return null; }
+	getFocusedCodeEditor(): ICodeEditor | undefined { return undefined; }
 	registerDecorationType(_key: string, _options: IDecorationRenderOptions, _parentTypeKey?: string): void { }
 	removeDecorationType(_key: string): void { }
 	resolveDecorationOptions(_typeKey: string, _writable: boolean): IModelDecorationOptions { return Object.create(null); }

Original file line number	Diff line number	Diff line change
`@@ -70,8 +70,8 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC`
`70`	`70`	`return Object.keys(this._diffEditors).map(id => this._diffEditors[id]);`
`71`	`71`	`}`
`72`	`72`
`73`		`- getFocusedCodeEditor(): ICodeEditor \| null {`
`74`		`- let editorWithWidgetFocus: ICodeEditor \| null = null;`
	`73`	`+ getFocusedCodeEditor(): ICodeEditor \| undefined {`
	`74`	`+ let editorWithWidgetFocus: ICodeEditor \| undefined;`
`75`	`75`
`76`	`76`	`const editors = this.listCodeEditors();`
`77`	`77`	`for (const editor of editors) {`
Original file line number	Diff line number	Diff line change
`@@ -57,8 +57,8 @@ export namespace PeekContext {`
`57`	`57`	`export const notInPeekEditor: ContextKeyExpr = inPeekEditor.toNegated();`
`58`	`58`	`}`
`59`	`59`
`60`		`-export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor \| null {`
`61`		`- let editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();`
	`60`	`+export function getOuterEditor(accessor: ServicesAccessor): ICodeEditor \| undefined {`
	`61`	`+ const editor = accessor.get(ICodeEditorService).getFocusedCodeEditor();`
`62`	`62`	`if (editor instanceof EmbeddedCodeEditorWidget) {`
`63`	`63`	`return editor.getParentEditor();`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ 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';`
`31`	`32`
`32`	`33`	`export const defaultReferenceSearchOptions: RequestOptions = {`
`33`	`34`	`getMetaTitle(model) {`
`@@ -106,7 +107,7 @@ let findReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour`
`106`	`107`	`}`
`107`	`108`
`108`	`109`	`const codeEditorService = accessor.get(ICodeEditorService);`
`109`		`- return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {`
	`110`	`+ return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {`
`110`	`111`	`if (!isCodeEditor(control) \|\| !control.hasModel()) {`
`111`	`112`	`return undefined;`
`112`	`113`	`}`
`@@ -132,7 +133,7 @@ let showReferencesCommand: ICommandHandler = (accessor: ServicesAccessor, resour`
`132`	`133`	`}`
`133`	`134`
`134`	`135`	`const codeEditorService = accessor.get(ICodeEditorService);`
`135`		`- return codeEditorService.openCodeEditor({ resource }, codeEditorService.getFocusedCodeEditor()).then(control => {`
	`136`	`+ return codeEditorService.openCodeEditor({ resource }, withUndefinedAsNull(codeEditorService.getFocusedCodeEditor())).then(control => {`
`136`	`137`	`if (!isCodeEditor(control)) {`
`137`	`138`	`return undefined;`
`138`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ function getChangeTypeColor(theme: ITheme, changeType: ChangeType): Color \| unde`
`149`	`149`	`}`
`150`	`150`	`}`
`151`	`151`
`152`		`-function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor \| null {`
	`152`	`+function getOuterEditorFromDiffEditor(accessor: ServicesAccessor): ICodeEditor \| undefined {`
`153`	`153`	`const diffEditors = accessor.get(ICodeEditorService).listDiffEditors();`
`154`	`154`
`155`	`155`	`for (const diffEditor of diffEditors) {`