getActiveCodeEditor should return undefined instead of null

mjbvz · mjbvz · commit 0fdba0997ca0 · 2019-09-19T17:28:03.000-07:00
microsoft#70384
diff --git a/src/vs/editor/browser/services/abstractCodeEditorService.ts b/src/vs/editor/browser/services/abstractCodeEditorService.ts
@@ -124,7 +124,7 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC
 		delete this._transientWatchers[w.uri];
 	}
 
-	abstract getActiveCodeEditor(): ICodeEditor | null;
+	abstract getActiveCodeEditor(): ICodeEditor | undefined;
 	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
 }
 
diff --git a/src/vs/editor/browser/services/codeEditorService.ts b/src/vs/editor/browser/services/codeEditorService.ts
@@ -45,6 +45,6 @@ export interface ICodeEditorService {
 	setTransientModelProperty(model: ITextModel, key: string, value: any): void;
 	getTransientModelProperty(model: ITextModel, key: string): any;
 
-	getActiveCodeEditor(): ICodeEditor | null;
+	getActiveCodeEditor(): ICodeEditor | undefined;
 	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
 }
diff --git a/src/vs/editor/browser/services/codeEditorServiceImpl.ts b/src/vs/editor/browser/services/codeEditorServiceImpl.ts
@@ -65,7 +65,7 @@ export abstract class CodeEditorServiceImpl extends AbstractCodeEditorService {
 		return provider.getOptions(this, writable);
 	}
 
-	abstract getActiveCodeEditor(): ICodeEditor | null;
+	abstract getActiveCodeEditor(): ICodeEditor | undefined;
 	abstract openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null>;
 }
 
diff --git a/src/vs/editor/contrib/rename/rename.ts b/src/vs/editor/contrib/rename/rename.ts
@@ -29,6 +29,7 @@ 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 {
 
@@ -285,7 +286,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 }, editorService.getActiveCodeEditor()).then(editor => {
+			return editorService.openCodeEditor({ resource: uri }, withUndefinedAsNull(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
@@ -15,8 +15,8 @@ import { IResourceInput } from 'vs/platform/editor/common/editor';
 
 export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {
 
-	public getActiveCodeEditor(): ICodeEditor | null {
-		return null; // not supported in the standalone case
+	public getActiveCodeEditor(): ICodeEditor | undefined {
+		return undefined; // not supported in the standalone case
 	}
 
 	public openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
diff --git a/src/vs/editor/test/browser/editorTestServices.ts b/src/vs/editor/test/browser/editorTestServices.ts
@@ -14,7 +14,7 @@ import { IInstantiationService } from 'vs/platform/instantiation/common/instanti
 
 export class TestCodeEditorService extends AbstractCodeEditorService {
 	public lastInput?: IResourceInput;
-	public getActiveCodeEditor(): ICodeEditor | null { return null; }
+	public getActiveCodeEditor(): ICodeEditor | undefined { return undefined; }
 	public openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
 		this.lastInput = input;
 		return Promise.resolve(null);
diff --git a/src/vs/editor/test/browser/services/decorationRenderOptions.test.ts b/src/vs/editor/test/browser/services/decorationRenderOptions.test.ts
@@ -15,8 +15,8 @@ import { TestTheme, TestThemeService } from 'vs/platform/theme/test/common/testT
 const themeServiceMock = new TestThemeService();
 
 export class TestCodeEditorServiceImpl extends CodeEditorServiceImpl {
-	getActiveCodeEditor(): ICodeEditor | null {
-		return null;
+	getActiveCodeEditor(): ICodeEditor | undefined {
+		return undefined;
 	}
 
 	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
diff --git a/src/vs/workbench/services/editor/browser/codeEditorService.ts b/src/vs/workbench/services/editor/browser/codeEditorService.ts
@@ -22,7 +22,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 		super(themeService);
 	}
 
-	getActiveCodeEditor(): ICodeEditor | null {
+	getActiveCodeEditor(): ICodeEditor | undefined {
 		const activeTextEditorWidget = this.editorService.activeTextEditorWidget;
 		if (isCodeEditor(activeTextEditorWidget)) {
 			return activeTextEditorWidget;
@@ -32,7 +32,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 			return activeTextEditorWidget.getModifiedEditor();
 		}
 
-		return null;
+		return undefined;
 	}
 
 	openCodeEditor(input: IResourceInput, source: ICodeEditor | null, sideBySide?: boolean): Promise<ICodeEditor | null> {
@@ -75,4 +75,4 @@ export class CodeEditorService extends CodeEditorServiceImpl {
 	}
 }
 
-registerSingleton(ICodeEditorService, CodeEditorService, true);
+registerSingleton(ICodeEditorService, CodeEditorService, true);
diff --git a/src/vs/workbench/test/workbenchTestServices.ts b/src/vs/workbench/test/workbenchTestServices.ts
@@ -1173,7 +1173,7 @@ export class TestCodeEditorService implements ICodeEditorService {
 	resolveDecorationOptions(_typeKey: string, _writable: boolean): IModelDecorationOptions { return Object.create(null); }
 	setTransientModelProperty(_model: ITextModel, _key: string, _value: any): void { }
 	getTransientModelProperty(_model: ITextModel, _key: string) { }
-	getActiveCodeEditor(): ICodeEditor | null { return null; }
+	getActiveCodeEditor(): ICodeEditor | undefined { return undefined; }
 	openCodeEditor(_input: IResourceInput, _source: ICodeEditor, _sideBySide?: boolean): Promise<ICodeEditor | null> { return Promise.resolve(null); }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC`
`124`	`124`	`delete this._transientWatchers[w.uri];`
`125`	`125`	`}`
`126`	`126`
`127`		`- abstract getActiveCodeEditor(): ICodeEditor \| null;`
	`127`	`+ abstract getActiveCodeEditor(): ICodeEditor \| undefined;`
`128`	`128`	`abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
`129`	`129`	`}`
`130`	`130`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,6 @@ export interface ICodeEditorService {`
`45`	`45`	`setTransientModelProperty(model: ITextModel, key: string, value: any): void;`
`46`	`46`	`getTransientModelProperty(model: ITextModel, key: string): any;`
`47`	`47`
`48`		`- getActiveCodeEditor(): ICodeEditor \| null;`
	`48`	`+ getActiveCodeEditor(): ICodeEditor \| undefined;`
`49`	`49`	`openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ export abstract class CodeEditorServiceImpl extends AbstractCodeEditorService {`
`65`	`65`	`return provider.getOptions(this, writable);`
`66`	`66`	`}`
`67`	`67`
`68`		`- abstract getActiveCodeEditor(): ICodeEditor \| null;`
	`68`	`+ abstract getActiveCodeEditor(): ICodeEditor \| undefined;`
`69`	`69`	`abstract openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null>;`
`70`	`70`	`}`
`71`	`71`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@ import { IResourceInput } from 'vs/platform/editor/common/editor';`
`15`	`15`
`16`	`16`	`export class StandaloneCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`17`	`17`
`18`		`- public getActiveCodeEditor(): ICodeEditor \| null {`
`19`		`- return null; // not supported in the standalone case`
	`18`	`+ public getActiveCodeEditor(): ICodeEditor \| undefined {`
	`19`	`+ return undefined; // not supported in the standalone case`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`public openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null> {`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@ import { TestTheme, TestThemeService } from 'vs/platform/theme/test/common/testT`
`15`	`15`	`const themeServiceMock = new TestThemeService();`
`16`	`16`
`17`	`17`	`export class TestCodeEditorServiceImpl extends CodeEditorServiceImpl {`
`18`		`- getActiveCodeEditor(): ICodeEditor \| null {`
`19`		`- return null;`
	`18`	`+ getActiveCodeEditor(): ICodeEditor \| undefined {`
	`19`	`+ return undefined;`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null> {`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {`
`22`	`22`	`super(themeService);`
`23`	`23`	`}`
`24`	`24`
`25`		`- getActiveCodeEditor(): ICodeEditor \| null {`
	`25`	`+ getActiveCodeEditor(): ICodeEditor \| undefined {`
`26`	`26`	`const activeTextEditorWidget = this.editorService.activeTextEditorWidget;`
`27`	`27`	`if (isCodeEditor(activeTextEditorWidget)) {`
`28`	`28`	`return activeTextEditorWidget;`
`@@ -32,7 +32,7 @@ export class CodeEditorService extends CodeEditorServiceImpl {`
`32`	`32`	`return activeTextEditorWidget.getModifiedEditor();`
`33`	`33`	`}`
`34`	`34`
`35`		`- return null;`
	`35`	`+ return undefined;`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`openCodeEditor(input: IResourceInput, source: ICodeEditor \| null, sideBySide?: boolean): Promise<ICodeEditor \| null> {`
`@@ -75,4 +75,4 @@ export class CodeEditorService extends CodeEditorServiceImpl {`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`
`78`		`-registerSingleton(ICodeEditorService, CodeEditorService, true);`
	`78`	`+registerSingleton(ICodeEditorService, CodeEditorService, true);`
Original file line number	Diff line number	Diff line change
`@@ -1173,7 +1173,7 @@ export class TestCodeEditorService implements ICodeEditorService {`
`1173`	`1173`	`resolveDecorationOptions(_typeKey: string, _writable: boolean): IModelDecorationOptions { return Object.create(null); }`
`1174`	`1174`	`setTransientModelProperty(_model: ITextModel, _key: string, _value: any): void { }`
`1175`	`1175`	`getTransientModelProperty(_model: ITextModel, _key: string) { }`
`1176`		`- getActiveCodeEditor(): ICodeEditor \| null { return null; }`
	`1176`	`+ getActiveCodeEditor(): ICodeEditor \| undefined { return undefined; }`
`1177`	`1177`	`openCodeEditor(_input: IResourceInput, _source: ICodeEditor, _sideBySide?: boolean): Promise<ICodeEditor \| null> { return Promise.resolve(null); }`
`1178`	`1178`	`}`
`1179`	`1179`