Refines rebase editor

Adds button to rebase editor to toggle it on/off
Adds commands to toggle rebase editor on/off
Adds settings UI to toggle rebase editor on/off

Author: eamodio

package.json

@@ -104,6 +104,8 @@
 		"onCommand:gitlens.diffWithWorkingInDiffLeft",
 		"onCommand:gitlens.diffWithWorkingInDiffRight",
 		"onCommand:gitlens.diffLineWithWorking",
+		"onCommand:gitlens.disableRebaseEditor",
+		"onCommand:gitlens.enableRebaseEditor",
 		"onCommand:gitlens.toggleFileBlame",
 		"onCommand:gitlens.toggleFileBlameInDiffLeft",
 		"onCommand:gitlens.toggleFileBlameInDiffRight",
@@ -2758,6 +2760,16 @@
 				"title": "Open Line Changes with Working File",
 				"category": "GitLens"
 			},
+			{
+				"command": "gitlens.disableRebaseEditor",
+				"title": "Disable Interactive Rebase Editor",
+				"category": "GitLens"
+			},
+			{
+				"command": "gitlens.enableRebaseEditor",
+				"title": "Enable Interactive Rebase Editor",
+				"category": "GitLens"
+			},
 			{
 				"command": "gitlens.toggleFileBlame",
 				"title": "Toggle File Blame",
@@ -4526,6 +4538,14 @@
 					"command": "gitlens.diffLineWithWorking",
 					"when": "gitlens:activeFileStatus =~ /blameable/"
 				},
+				{
+					"command": "gitlens.disableRebaseEditor",
+					"when": "gitlens:enabled"
+				},
+				{
+					"command": "gitlens.enableRebaseEditor",
+					"when": "gitlens:enabled"
+				},
 				{
 					"command": "gitlens.externalDiff",
 					"when": "gitlens:activeFileStatus =~ /tracked/"
@@ -7919,7 +7939,7 @@
 		"customEditors": [
 			{
 				"viewType": "gitlens.rebase",
-				"displayName": "Interactive Rebase Editor",
+				"displayName": "GitLens Interactive Rebase Editor",
 				"selector": [
 					{
 						"filenamePattern": "git-rebase-todo"

src/commands.ts

@@ -34,6 +34,7 @@ export * from './commands/openPullRequestOnRemote';
 export * from './commands/openRepoOnRemote';
 export * from './commands/openRevisionFile';
 export * from './commands/openWorkingFile';
+export * from './commands/rebaseEditor';
 export * from './commands/refreshHover';
 export * from './commands/remoteProviders';
 export * from './commands/repositories';

src/commands/common.ts

@@ -63,6 +63,8 @@ export enum Commands {
 	DiffWithWorkingInDiffRight = 'gitlens.diffWithWorkingInDiffRight',
 	DiffLineWithWorking = 'gitlens.diffLineWithWorking',
 	DisconnectRemoteProvider = 'gitlens.disconnectRemoteProvider',
+	DisableRebaseEditor = 'gitlens.disableRebaseEditor',
+	EnableRebaseEditor = 'gitlens.enableRebaseEditor',
 	ExternalDiff = 'gitlens.externalDiff',
 	ExternalDiffAll = 'gitlens.externalDiffAll',
 	FetchRepositories = 'gitlens.fetchRepositories',

src/commands/rebaseEditor.ts

@@ -0,0 +1,25 @@
+'use strict';
+import { command, Command, Commands } from './common';
+import { Container } from '../container';
+
+@command()
+export class DisableRebaseEditorCommand extends Command {
+	constructor() {
+		super(Commands.DisableRebaseEditor);
+	}
+
+	execute() {
+		return Container.rebaseEditor.setEnabled(false);
+	}
+}
+
+@command()
+export class EnableRebaseEditorCommand extends Command {
+	constructor() {
+		super(Commands.EnableRebaseEditor);
+	}
+
+	execute() {
+		return Container.rebaseEditor.setEnabled(true);
+	}
+}

src/configuration.ts

@@ -137,10 +137,12 @@ export class Configuration {
 					.get<T>(section === undefined ? extensionId : section, defaultValue)!;
 	}
 
+	getAny<T>(section: string, scope?: ConfigurationScope | null): T | undefined;
+	getAny<T>(section: string, scope: ConfigurationScope | null | undefined, defaultValue: T): T;
 	getAny<T>(section: string, scope?: ConfigurationScope | null, defaultValue?: T) {
 		return defaultValue === undefined
-			? workspace.getConfiguration(undefined, scope).get<T>(section)!
-			: workspace.getConfiguration(undefined, scope).get<T>(section, defaultValue)!;
+			? workspace.getConfiguration(undefined, scope).get<T>(section)
+			: workspace.getConfiguration(undefined, scope).get<T>(section, defaultValue);
 	}
 
 	changed<S1 extends keyof Config>(e: ConfigurationChangeEvent, s1: S1, scope?: ConfigurationScope | null): boolean;
@@ -242,8 +244,8 @@ export class Configuration {
 			.inspect(section === undefined ? extensionId : section);
 	}
 
-	inspectAny(section: string, scope?: ConfigurationScope | null) {
-		return workspace.getConfiguration(undefined, scope).inspect(section);
+	inspectAny<T>(section: string, scope?: ConfigurationScope | null) {
+		return workspace.getConfiguration(undefined, scope).inspect<T>(section);
 	}
 
 	migrate<S1 extends keyof Config>(

src/container.ts

@@ -91,7 +91,7 @@ export class Container {
 			});
 		}
 
-		context.subscriptions.push(new RebaseEditorProvider());
+		context.subscriptions.push((this._rebaseEditor = new RebaseEditorProvider()));
 		context.subscriptions.push(new GitTerminalLinkProvider());
 		context.subscriptions.push(new GitFileSystemProvider());
 
@@ -237,6 +237,15 @@ export class Container {
 		return this._lineTracker;
 	}
 
+	private static _rebaseEditor: RebaseEditorProvider | undefined;
+	static get rebaseEditor() {
+		if (this._rebaseEditor === undefined) {
+			this._context.subscriptions.push((this._rebaseEditor = new RebaseEditorProvider()));
+		}
+
+		return this._rebaseEditor;
+	}
+
 	private static _remotesView: RemotesView | undefined;
 	static get remotesView() {
 		if (this._remotesView === undefined) {

src/webviews/apps/images/settings/rebase-editor.png

@@ -27,10 +27,13 @@ <h4 id="subhead"></h4>
 				<span class="shortcut"><kbd>alt ↓</kbd><span>Move Down</span></span>
 			</div>
 			<div class="actions">
-				<button name="start" class="button button--flat-primary" data-action="start">
+				<button name="disable" class="button button--flat-subtle" data-action="disable" tabindex="-1">
+					Disable Rebase Editor<span class="shortcut">Will Abort Rebase</span>
+				</button>
+				<button name="start" class="button button--flat-primary button--right" data-action="start">
 					Start Rebase <span class="shortcut">Ctrl+Enter</span>
 				</button>
-				<button name="abort" class="button button--flat" data-action="abort">
+				<button name="abort" class="button button--flat-secondary" data-action="abort">
 					Abort <span class="shortcut">Ctrl+A</span>
 				</button>
 			</div>

src/webviews/apps/rebase/rebase.html

@@ -7,6 +7,7 @@ import {
 	RebaseDidAbortCommandType,
 	RebaseDidChangeEntryCommandType,
 	RebaseDidChangeNotificationType,
+	RebaseDidDisableCommandType,
 	RebaseDidMoveEntryCommandType,
 	RebaseDidStartCommandType,
 	RebaseEntry,
@@ -124,6 +125,7 @@ class RebaseEditor extends App<RebaseState> {
 			}),
 			DOM.on('[data-action="start"]', 'click', () => this.onStartClicked()),
 			DOM.on('[data-action="abort"]', 'click', () => this.onAbortClicked()),
+			DOM.on('[data-action="disable"]', 'click', () => this.onDisableClicked()),
 			DOM.on('li[data-ref]', 'keydown', function (this: Element, e: KeyboardEvent) {
 				if ((e.target as HTMLElement).matches('select[data-ref]')) {
 					if (e.key === 'Escape') {
@@ -134,6 +136,10 @@ class RebaseEditor extends App<RebaseState> {
 				}
 
 				if (e.key === 'Enter' || e.key === ' ') {
+					if (e.key === 'Enter' && (e.target as HTMLElement).matches('a.entry-ref')) {
+						return;
+					}
+
 					const $select = (this as HTMLLIElement).querySelectorAll<HTMLSelectElement>('select[data-ref]')[0];
 					if ($select != null) {
 						$select.focus();
@@ -224,6 +230,10 @@ class RebaseEditor extends App<RebaseState> {
 		this.sendCommand(RebaseDidAbortCommandType, {});
 	}
 
+	private onDisableClicked() {
+		this.sendCommand(RebaseDidDisableCommandType, {});
+	}
+
 	private onSelectChanged($el: HTMLSelectElement) {
 		const ref = $el.dataset.ref;
 		if (ref) {
@@ -367,6 +377,8 @@ class RebaseEditor extends App<RebaseState> {
 				$select.appendChild(option);
 			}
 			$selectContainer.appendChild($select);
+		} else {
+			$entry.tabIndex = -1;
 		}
 
 		const $message = document.createElement('span');

src/webviews/apps/rebase/rebase.ts

@@ -116,3 +116,64 @@
 		transition-duration: 0s !important;
 	}
 }
+
+.button--flat-secondary {
+	background-color: var(--color-button-secondary-background);
+	border: 1px solid var(--color-button-secondary-background);
+	color: var(--color-button-foreground);
+	font-weight: 600;
+	transition: background-color 250ms, border-color 250ms, color 250ms;
+
+	&:not([disabled]):hover,
+	&:not([disabled]):focus {
+		.vscode-dark & {
+			background-color: white;
+			border-color: white;
+			color: black;
+		}
+
+		.vscode-light & {
+			background-color: var(--color-button-secondary-background--darken-30);
+			border-color: var(--color-button-secondary-background--darken-30);
+			color: white;
+		}
+	}
+
+	.preload & {
+		transition-duration: 0s !important;
+	}
+}
+
+.button--flat-subtle {
+	.vscode-light & {
+		border: 1px solid rgba(0, 0, 0, 0.2);
+		color: rgba(0, 0, 0, 0.6);
+	}
+	.vscode-dark & {
+		border: 1px solid rgba(255, 255, 255, 0.2);
+		color: rgba(255, 255, 255, 0.6);
+	}
+	transition: background-color 250ms, border-color 250ms, color 250ms;
+
+	&:not([disabled]):hover,
+	&:not([disabled]):focus {
+		.vscode-light & {
+			background-color: var(--color-button-secondary-background--darken-30);
+			border-color: var(--color-button-secondary-background--darken-30);
+			color: white;
+		}
+		.vscode-dark & {
+			background-color: white;
+			border-color: white;
+			color: black;
+		}
+	}
+
+	.preload & {
+		transition-duration: 0s !important;
+	}
+}
+
+.button--right {
+	margin-left: auto;
+}