editors - some JSDoc 💄

Benjamin Pasero · Benjamin Pasero · commit b0ba712a9eb3 · 2020-03-03T12:04:53.000+01:00
diff --git a/src/vs/workbench/browser/parts/editor/editorControl.ts b/src/vs/workbench/browser/parts/editor/editorControl.ts
@@ -35,7 +35,7 @@ export class EditorControl extends Disposable {
 	readonly onDidSizeConstraintsChange = this._onDidSizeConstraintsChange.event;
 
 	private _activeEditorPane: BaseEditor | null = null;
-	private editorPanes: BaseEditor[] = [];
+	private readonly editorPanes: BaseEditor[] = [];
 
 	private readonly activeEditorPaneDisposables = this._register(new DisposableStore());
 	private dimension: Dimension | undefined;
@@ -62,7 +62,7 @@ export class EditorControl extends Disposable {
 		// Editor pane
 		const descriptor = Registry.as<IEditorRegistry>(EditorExtensions.Editors).getEditor(editor);
 		if (!descriptor) {
-			throw new Error('No editor descriptor found');
+			throw new Error(`No editor descriptor found for input id ${editor.getTypeId()}`);
 		}
 		const editorPane = this.doShowEditorPane(descriptor);
 
diff --git a/src/vs/workbench/services/editor/browser/editorService.ts b/src/vs/workbench/services/editor/browser/editorService.ts
@@ -451,7 +451,15 @@ export class EditorService extends Disposable implements EditorServiceImpl {
 	}
 
 	get visibleTextEditorControls(): Array<ICodeEditor | IDiffEditor> {
-		return this.visibleEditorPanes.map(editorPane => editorPane.getControl() as ICodeEditor | IDiffEditor).filter(control => isCodeEditor(control) || isDiffEditor(control));
+		const visibleTextEditorControls: Array<ICodeEditor | IDiffEditor> = [];
+		for (const visibleEditorPane of this.visibleEditorPanes) {
+			const control = visibleEditorPane.getControl();
+			if (isCodeEditor(control) || isDiffEditor(control)) {
+				visibleTextEditorControls.push(control);
+			}
+		}
+
+		return visibleTextEditorControls;
 	}
 
 	get visibleEditors(): IEditorInput[] {
diff --git a/src/vs/workbench/services/editor/common/editorGroupsService.ts b/src/vs/workbench/services/editor/common/editorGroupsService.ts
@@ -402,13 +402,13 @@ export interface IEditorGroup {
 	readonly ariaLabel: string;
 
 	/**
-	 * The active ediotr pane is the currently visible editor pane of the group.
+	 * The active editor pane is the currently visible editor pane of the group.
 	 */
 	readonly activeEditorPane: IVisibleEditorPane | undefined;
 
 	/**
 	 * The active editor is the currently visible editor of the group
-	 * within the current active control.
+	 * within the current active editor pane.
 	 */
 	readonly activeEditor: IEditorInput | null;
 
diff --git a/src/vs/workbench/services/editor/common/editorService.ts b/src/vs/workbench/services/editor/common/editorService.ts
@@ -66,22 +66,22 @@ export interface IEditorService {
 	/**
 	 * Emitted when the currently active editor changes.
 	 *
-	 * @see `IEditorService.activeEditor`
+	 * @see `IEditorService.activeEditorPane`
 	 */
 	readonly onDidActiveEditorChange: Event<void>;
 
 	/**
 	 * Emitted when any of the current visible editors changes.
 	 *
-	 * @see `IEditorService.visibleEditors`
+	 * @see `IEditorService.visibleEditorPanes`
 	 */
 	readonly onDidVisibleEditorsChange: Event<void>;
 
 	/**
 	 * The currently active editor pane or `undefined` if none. The editor pane is
 	 * the workbench container for editors of any kind.
 	 *
-	 * @see `IEditorService.activeEditor`
+	 * @see `IEditorService.activeEditor` for access to the active editor input
 	 */
 	readonly activeEditorPane: IVisibleEditorPane | undefined;
 
@@ -109,6 +109,8 @@ export interface IEditorService {
 
 	/**
 	 * All editor panes that are currently visible across all editor groups.
+	 *
+	 * @see `IEditorService.visibleEditors` for access to the visible editor inputs
 	 */
 	readonly visibleEditorPanes: ReadonlyArray<IVisibleEditorPane>;
 
