Adds user-defined modes support

CHANGELOG.md

@@ -6,6 +6,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [8.3.0-beta] - 2018-05-05
 ### Added
+- Add user-defined modes for quickly toggling between sets of settings
+  - Adds *Switch Mode* command (`gitlens.switchMode`) to quickly switch the active mode
+  - Adds a built-in *Zen* mode which for a zen-like experience, disables many visual features
+    - Adds *Toggle Zen Mode* command (`gitlens.toggleZenMode`) to toggle Zen mode
+  - Adds a built-in *Review* mode which for reviewing code, enables many visual features
+    - Adds *Toggle Review Mode* command (`gitlens.toggleReviewMode`) to toggle Review mode
+  - Adds the active mode to the status bar, optional (on by default)
+    - Adds `gitlens.mode.statusBar.enabled` setting to specify whether to provide the active GitLens mode on the status bar
+    - Adds `gitlens.mode.statusBar.alignment` setting to specify the active GitLens mode alignment in the status bar
+  - Adds modes settings (`gitlens.mode.*`) to the interactive settings editor
+    ![modes settings](https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/cl-modes-settings.png)
+  - Adds `gitlens.mode.active` settings to specify the active GitLens mode, if any
+  - Adds `gitlens.modes` setting to specify the user-defined GitLens modes
 - Adds an icon for the *Compare File with Previous Revision* command (`gitlens.diffWithPrevious`) and moves it into the editor toolbar
 - Adds an icon for the *Compare File with Next Revision* command (`gitlens.diffWithNext`) and moves it into the editor toolbar
 - Adds *Show GitLens Explorer* (`gitlens.showGitExplorer`) command — shows/expands the *GitLens* explorer

README.md

@@ -372,6 +372,16 @@ An on-demand, [customizable](#gitlens-results-view-settings "Jump to the GitLens
   - Click the current and previous commit ids to execute the *Show Commit Details* command (`gitlens.showQuickCommitDetails`)
 
 ---
+### Modes
+- GitLens supports [user-defined](#modes-settings "Jump to the Modes settings") modes for quickly toggling between sets of settings
+  - Adds *Switch Mode* command (`gitlens.switchMode`) to quickly switch the active mode
+  - Adds a built-in *Zen* mode which for a zen-like experience, disables many visual features
+    - Adds *Toggle Zen Mode* command (`gitlens.toggleZenMode`) to toggle Zen mode
+  - Adds a built-in *Review* mode which for reviewing code, enables many visual features
+    - Adds *Toggle Review Mode* command (`gitlens.toggleReviewMode`) to toggle Review mode
+  - Adds the active mode to the **status bar** ([optional](#modes-settings "Jump to the Modes settings"), on by default)
+
+---
 ### Recent Changes
 <p align="center">
   <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/master/images/ss-recent-changes.png" alt="Recent Changes" />
@@ -671,13 +681,22 @@ See also [Explorer Settings](#explorer-settings "Jump to the Explorer settings")
 |`gitlens.hovers.annotations.changes`|Specifies whether to provide a changes (diff) hover for all lines when showing blame annotations
 |`gitlens.hovers.annotations.details`|Specifies whether to provide a commit details hover for all lines when showing blame annotations
 |`gitlens.hovers.annotations.enabled`|Specifies whether to provide any hovers when showing blame annotations
-|`gitlens.hovers.annotations.over`|Specifies when to trigger hovers when showing blame annotations<br /> `annotation` - only shown when hovering over the line annotation<br /> `line` - shown when hovering anywhere over the line
+|`gitlens.hovers.annotations.over`|Specifies when to trigger hovers when showing blame annotations<br />`annotation` - only shown when hovering over the line annotation<br />`line` - shown when hovering anywhere over the line
 |`gitlens.hovers.currentLine.changes`|Specifies whether to provide a changes (diff) hover for the current line
 |`gitlens.hovers.currentLine.details`|Specifies whether to provide a commit details hover for the current line
 |`gitlens.hovers.currentLine.enabled`|Specifies whether to provide any hovers for the current line
-|`gitlens.hovers.currentLine.over`|Specifies when to trigger hovers for the current line<br /> `annotation` - only shown when hovering over the line annotation<br /> `line` - shown when hovering anywhere over the line
+|`gitlens.hovers.currentLine.over`|Specifies when to trigger hovers for the current line<br />`annotation` - only shown when hovering over the line annotation<br />`line` - shown when hovering anywhere over the line
 |`gitlens.hovers.enabled`|Specifies whether to provide any hovers
 
+### Modes Settings
+
+|Name | Description
+|-----|------------
+|`gitlens.mode.active`|Specifies the active GitLens mode, if any
+|`gitlens.mode.statusBar.enabled`|Specifies whether to provide the active GitLens mode on the status bar
+|`gitlens.mode.statusBar.alignment`|Specifies the active GitLens mode alignment in the status bar<br />`left` - align to the left<br />`right` - align to the right
+|`gitlens.modes`|Specifies the user-defined GitLens modes
+
 ### Recent Changes Settings
 
 |Name | Description

package.json

@@ -670,6 +670,102 @@
                     "description": "Specifies which commands will be added to which menus",
                     "scope": "window"
                 },
+                "gitlens.mode.active": {
+                    "type": "string",
+                    "description": "Specifies the active GitLens mode, if any",
+                    "scope": "window"
+                },
+                "gitlens.mode.statusBar.enabled": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Specifies whether to provide the active GitLens mode on the status bar",
+                    "scope": "window"
+                },
+                "gitlens.mode.statusBar.alignment": {
+                    "type": "string",
+                    "default": "right",
+                    "enum": [
+                        "left",
+                        "right"
+                    ],
+                    "description": "Specifies the active GitLens mode alignment in the status bar\n `left` - align to the left\n `right` - align to the right",
+                    "scope": "window"
+                },
+                "gitlens.modes": {
+                    "type": "object",
+                    "properties": {
+                        "zen": {
+                            "type": "object",
+                            "required": [
+                                "name"
+                            ],
+                            "properties": {
+                                "name": { "type": "string"},
+                                "statusBarItemName": { "type": "string"},
+                                "description": { "type": "string"},
+                                "codeLens": { "type": "boolean" },
+                                "currentLine": { "type": "boolean" },
+                                "explorers": { "type": "boolean" },
+                                "hovers": { "type": "boolean" },
+                                "statusBar": { "type": "boolean" }
+                            }
+                        },
+                        "review": {
+                            "type": "object",
+                            "required": [
+                                "name"
+                            ],
+                            "properties": {
+                                "name": { "type": "string"},
+                                "statusBarItemName": { "type": "string"},
+                                "description": { "type": "string"},
+                                "codeLens": { "type": "boolean" },
+                                "currentLine": { "type": "boolean" },
+                                "explorers": { "type": "boolean" },
+                                "hovers": { "type": "boolean" },
+                                "statusBar": { "type": "boolean" }
+                            }
+                        }
+                    },
+                    "additionalProperties": {
+                        "type": "object",
+                        "required": [
+                            "name"
+                        ],
+                        "properties": {
+                            "name": { "type": "string"},
+                            "statusBarItemName": { "type": "string"},
+                            "description": { "type": "string"},
+                            "codeLens": { "type": "boolean" },
+                            "currentLine": { "type": "boolean" },
+                            "explorers": { "type": "boolean" },
+                            "hovers": { "type": "boolean" },
+                            "statusBar": { "type": "boolean" }
+                        }
+                    },
+                    "default": {
+                        "zen": {
+                            "name": "Zen",
+                            "statusBarItemName": "Zen",
+                            "description": "for a zen-like experience, disables many visual features",
+                            "codeLens": false,
+                            "currentLine": false,
+                            "explorers": false,
+                            "hovers": false,
+                            "statusBar": false
+                        },
+                        "review": {
+                            "name": "Review",
+                            "statusBarItemName": "Reviewing",
+                            "description": "for reviewing code, enables many visual features",
+                            "codeLens": true,
+                            "currentLine": true,
+                            "hovers": true
+                        }
+                    },
+                    "description": "Specifies the user-defined GitLens modes",
+                    "scope": "window"
+                },
                 "gitlens.outputLevel": {
                     "type": "string",
                     "default": "silent",
@@ -1242,6 +1338,21 @@
                 "category": "GitLens"
             },
             {
+                "command": "gitlens.switchMode",
+                "title": "Switch Mode",
+                "category": "GitLens"
+            },
+            {
+                "command": "gitlens.toggleReviewMode",
+                "title": "Toggle Review Mode",
+                "category": "GitLens"
+            },
+            {
+                "command": "gitlens.toggleZenMode",
+                "title": "Toggle Zen Mode",
+                "category": "GitLens"
+            },
+            {
                 "command": "gitlens.showCommitSearch",
                 "title": "Search Commits",
                 "category": "GitLens",
@@ -1848,6 +1959,18 @@
                     "when": "gitlens:enabled && gitlens:canToggleCodeLens"
                 },
                 {
+                    "command": "gitlens.switchMode",
+                    "when": "gitlens:enabled"
+                },
+                {
+                    "command": "gitlens.toggleReviewMode",
+                    "when": "gitlens:enabled"
+                },
+                {
+                    "command": "gitlens.toggleZenMode",
+                    "when": "gitlens:enabled"
+                },
+                {
                     "command": "gitlens.showCommitSearch",
                     "when": "gitlens:enabled"
                 },

src/annotations/lineAnnotationController.ts

@@ -1,7 +1,7 @@
 'use strict';
 import { ConfigurationChangeEvent, debug, DecorationRangeBehavior, DecorationRenderOptions, Disposable, Range, TextEditor, TextEditorDecorationType, window } from 'vscode';
 import { Annotations } from './annotations';
-import { configuration, IConfig } from './../configuration';
+import { configuration } from './../configuration';
 import { isTextEditor, RangeEndOfLineIndex } from './../constants';
 import { Container } from './../container';
 import { LinesChangeEvent } from './../trackers/gitLineTracker';
@@ -47,8 +47,7 @@ export class LineAnnotationController extends Disposable {
         if (!initializing && !configuration.changed(e, configuration.name('currentLine').value)) return;
 
         if (initializing || configuration.changed(e, configuration.name('currentLine')('enabled').value)) {
-            const cfg = configuration.get<IConfig>();
-            if (cfg.currentLine.enabled) {
+            if (Container.config.currentLine.enabled) {
                 this._enabled = true;
                 this.resume();
             }

src/annotations/lineHoverController.ts

@@ -1,7 +1,7 @@
 'use strict';
 import { CancellationToken, ConfigurationChangeEvent, debug, Disposable, Hover, HoverProvider, languages, Position, Range, TextDocument, TextEditor, window } from 'vscode';
 import { Annotations } from './annotations';
-import { configuration, IConfig } from './../configuration';
+import { configuration } from './../configuration';
 import { RangeEndOfLineIndex } from './../constants';
 import { Container } from './../container';
 import { LinesChangeEvent } from './../trackers/gitLineTracker';
@@ -38,9 +38,7 @@ export class LineHoverController extends Disposable {
             !configuration.changed(e, configuration.name('hovers')('enabled').value) &&
             !configuration.changed(e, configuration.name('hovers')('currentLine')('enabled').value)) return;
 
-        const cfg = configuration.get<IConfig>();
-
-        if (cfg.hovers.enabled && cfg.hovers.currentLine.enabled) {
+        if (Container.config.hovers.enabled && Container.config.hovers.currentLine.enabled) {
             Container.lineTracker.start(
                 this,
                 Disposable.from(Container.lineTracker.onDidChangeActiveLines(this.onActiveLinesChanged, this))

src/codeLensController.ts

@@ -1,6 +1,6 @@
 'use strict';
 import { ConfigurationChangeEvent, Disposable, languages } from 'vscode';
-import { configuration, ICodeLensConfig } from './configuration';
+import { configuration } from './configuration';
 import { CommandContext, setCommandContext } from './constants';
 import { Container } from './container';
 import { DocumentBlameStateChangeEvent, DocumentDirtyIdleTriggerEvent, GitDocumentState } from './trackers/gitDocumentTracker';
@@ -39,7 +39,7 @@ export class CodeLensController extends Disposable {
                 Logger.log('CodeLens config changed; resetting CodeLens provider');
             }
 
-            const cfg = configuration.get<ICodeLensConfig>(section);
+            const cfg = Container.config.codeLens;
             if (cfg.enabled && (cfg.recentChange.enabled || cfg.authors.enabled)) {
                 if (this._provider !== undefined) {
                     this._provider.reset();
@@ -72,7 +72,7 @@ export class CodeLensController extends Disposable {
     private onDirtyIdleTriggered(e: DocumentDirtyIdleTriggerEvent<GitDocumentState>) {
         if (this._provider === undefined || !e.document.isBlameable) return;
 
-        const maxLines = configuration.get<number>(configuration.name('advanced')('blame')('sizeThresholdAfterEdit').value);
+        const maxLines = Container.config.advanced.blame.sizeThresholdAfterEdit;
         if (maxLines > 0 && e.document.lineCount > maxLines) return;
 
         Logger.log('Dirty idle triggered; resetting CodeLens provider');

src/commands.ts

@@ -44,6 +44,7 @@ export * from './commands/showResultsExplorer';
 export * from './commands/stashApply';
 export * from './commands/stashDelete';
 export * from './commands/stashSave';
+export * from './commands/switchMode';
 export * from './commands/toggleCodeLens';
 export * from './commands/toggleFileBlame';
 export * from './commands/toggleFileHeatmap';
@@ -95,9 +96,12 @@ export function configureCommands(): void {
     Container.context.subscriptions.push(new Commands.StashApplyCommand());
     Container.context.subscriptions.push(new Commands.StashDeleteCommand());
     Container.context.subscriptions.push(new Commands.StashSaveCommand());
+    Container.context.subscriptions.push(new Commands.SwitchModeCommand());
     Container.context.subscriptions.push(new Commands.ToggleCodeLensCommand());
     Container.context.subscriptions.push(new Commands.ToggleFileBlameCommand());
     Container.context.subscriptions.push(new Commands.ToggleFileHeatmapCommand());
     Container.context.subscriptions.push(new Commands.ToggleFileRecentChangesCommand());
     Container.context.subscriptions.push(new Commands.ToggleLineBlameCommand());
+    Container.context.subscriptions.push(new Commands.ToggleReviewModeCommand());
+    Container.context.subscriptions.push(new Commands.ToggleZenModeCommand());
 }

src/commands/common.ts

@@ -57,11 +57,14 @@ export enum Commands {
     StashApply = 'gitlens.stashApply',
     StashDelete = 'gitlens.stashDelete',
     StashSave = 'gitlens.stashSave',
+    SwitchMode = 'gitlens.switchMode',
     ToggleCodeLens = 'gitlens.toggleCodeLens',
     ToggleFileBlame = 'gitlens.toggleFileBlame',
     ToggleFileHeatmap = 'gitlens.toggleFileHeatmap',
     ToggleFileRecentChanges = 'gitlens.toggleFileRecentChanges',
-    ToggleLineBlame = 'gitlens.toggleLineBlame'
+    ToggleLineBlame = 'gitlens.toggleLineBlame',
+    ToggleReviewMode = 'gitlens.toggleReviewMode',
+    ToggleZenMode = 'gitlens.toggleZenMode'
 }
 
 export function getCommandUri(uri?: Uri, editor?: TextEditor): Uri | undefined {

src/commands/switchMode.ts

@@ -0,0 +1,48 @@
+'use strict';
+import { ConfigurationTarget } from 'vscode';
+import { Command, Commands } from './common';
+import { configuration } from '../configuration';
+import { Container } from '../container';
+import { ModesQuickPick } from '../quickPicks/quickPicks';
+
+export class SwitchModeCommand extends Command {
+
+    constructor() {
+        super(Commands.SwitchMode);
+    }
+
+    async execute() {
+        const pick = await ModesQuickPick.show();
+        if (pick === undefined) return;
+
+        await configuration.update(configuration.name('mode')('active').value, pick.key, ConfigurationTarget.Global);
+    }
+}
+
+export class ToggleReviewModeCommand extends Command {
+
+    constructor() {
+        super(Commands.ToggleReviewMode);
+    }
+
+    async execute() {
+        if (!Object.keys(Container.config.modes).includes('review')) return;
+
+        const mode = Container.config.mode.active === 'review' ? undefined : 'review';
+        await configuration.update(configuration.name('mode')('active').value, mode, ConfigurationTarget.Global);
+    }
+}
+
+export class ToggleZenModeCommand extends Command {
+
+    constructor() {
+        super(Commands.ToggleZenMode);
+    }
+
+    async execute() {
+        if (!Object.keys(Container.config.modes).includes('zen')) return;
+
+        const mode = Container.config.mode.active === 'zen' ? undefined : 'zen';
+        await configuration.update(configuration.name('mode')('active').value, mode, ConfigurationTarget.Global);
+    }
+}

src/configuration.ts

@@ -26,6 +26,21 @@ export class Configuration {
         return this._onDidChange.event;
     }
 
+    private readonly _configAffectedByMode: string[];
+
+    constructor() {
+        this._configAffectedByMode = [
+            `gitlens.${this.name('mode').value}`,
+            `gitlens.${this.name('modes').value}`,
+            `gitlens.${this.name('codeLens').value}`,
+            `gitlens.${this.name('currentLine').value}`,
+            `gitlens.${this.name('gitExplorer').value}`,
+            `gitlens.${this.name('historyExplorer').value}`,
+            `gitlens.${this.name('hovers').value}`,
+            `gitlens.${this.name('statusBar').value}`
+        ];
+    }
+
     private onConfigurationChanged(e: ConfigurationChangeEvent) {
         if (!e.affectsConfiguration(ExtensionKey, null!)) return;
 
@@ -40,6 +55,21 @@ export class Configuration {
             setCommandContext(CommandContext.KeyMap, this.get<KeyMap>(section));
         }
 
+        if (configuration.changed(e, configuration.name('mode').value) ||
+            configuration.changed(e, configuration.name('modes').value)) {
+            const original = e.affectsConfiguration;
+            e = {
+                ...e,
+                affectsConfiguration: (section: string, resource?: Uri) => {
+                    if (this._configAffectedByMode.some(n => section.startsWith(n))) {
+                        return true;
+                    }
+
+                    return original(section, resource);
+                }
+            } as ConfigurationChangeEvent;
+        }
+
         this._onDidChange.fire(e);
     }
 
@@ -186,4 +216,4 @@ export class Configuration {
     }
 }
 
-export const configuration = new Configuration();
+export const configuration = new Configuration();

src/container.ts

@@ -23,7 +23,7 @@ export class Container {
 
     static initialize(context: ExtensionContext, config: IConfig) {
         this._context = context;
-        this._config = config;
+        this._config = Container.applyMode(config);
 
         context.subscriptions.push(this._lineTracker = new GitLineTracker());
         context.subscriptions.push(this._tracker = new GitDocumentTracker());
@@ -79,7 +79,7 @@ export class Container {
     private static _config: IConfig | undefined;
     static get config() {
         if (this._config === undefined) {
-            this._config = configuration.get<IConfig>();
+            this._config = Container.applyMode(configuration.get<IConfig>());
         }
         return this._config;
     }
@@ -173,4 +173,32 @@ export class Container {
     static resetConfig() {
         this._config = undefined;
     }
+
+    private static applyMode(config: IConfig) {
+        if (!config.mode.active) return config;
+
+        const mode = config.modes[config.mode.active];
+        if (mode == null) return config;
+
+        if (mode.codeLens != null) {
+            config.codeLens.enabled = mode.codeLens;
+        }
+        if (mode.currentLine != null) {
+            config.currentLine.enabled = mode.currentLine;
+        }
+        if (mode.explorers != null) {
+            config.gitExplorer.enabled = mode.explorers;
+        }
+        if (mode.explorers != null) {
+            config.historyExplorer.enabled = mode.explorers;
+        }
+        if (mode.hovers != null) {
+            config.hovers.enabled = mode.hovers;
+        }
+        if (mode.statusBar != null) {
+            config.statusBar.enabled = mode.statusBar;
+        }
+
+        return config;
+    }
 }

src/gitCodeLensProvider.ts

@@ -75,7 +75,7 @@ export class GitCodeLensProvider implements CodeLensProvider {
         if (document.isDirty) {
             // Only allow dirty blames if we are idle
             if (trackedDocument.isDirtyIdle) {
-                const maxLines = configuration.get<number>(configuration.name('advanced')('blame')('sizeThresholdAfterEdit').value);
+                const maxLines = Container.config.advanced.blame.sizeThresholdAfterEdit;
                 if (maxLines > 0 && document.lineCount > maxLines) {
                     dirty = true;
                 }
@@ -433,14 +433,8 @@ export class GitCodeLensProvider implements CodeLensProvider {
     }
 
     private getDirtyTitle(cfg: ICodeLensConfig) {
-        if (cfg.recentChange.enabled && cfg.authors.enabled) {
-            return configuration.get<string>(configuration.name('strings')('codeLens')('unsavedChanges')('recentChangeAndAuthors').value);
-        }
-        else if (cfg.recentChange.enabled) {
-            return  configuration.get<string>(configuration.name('strings')('codeLens')('unsavedChanges')('recentChangeOnly').value);
-        }
-        else {
-            return configuration.get<string>(configuration.name('strings')('codeLens')('unsavedChanges')('authorsOnly').value);
-        }
+        if (cfg.recentChange.enabled && cfg.authors.enabled) return Container.config.strings.codeLens.unsavedChanges.recentChangeAndAuthors;
+        if (cfg.recentChange.enabled) return Container.config.strings.codeLens.unsavedChanges.recentChangeOnly;
+        return Container.config.strings.codeLens.unsavedChanges.authorsOnly;
     }
 }

src/quickPicks/modesQuickPick.ts

@@ -0,0 +1,40 @@
+'use strict';
+import { QuickPickItem, QuickPickOptions, window } from 'vscode';
+import { Container } from '../container';
+import { GlyphChars } from '../constants';
+
+export interface ModesQuickPickItem extends QuickPickItem {
+    key: string | undefined;
+}
+
+export class ModesQuickPick {
+
+    static async show(): Promise<ModesQuickPickItem | undefined> {
+        const modes = Object.keys(Container.config.modes);
+        if (modes.length === 0) return undefined;
+
+        const mode = Container.config.mode.active;
+
+        const items = modes.map(key => {
+            const modeCfg = Container.config.modes[key];
+            return {
+                label: `${mode === key ? '$(check)\u00a0\u00a0' : '\u00a0\u00a0\u00a0\u00a0\u00a0'}${modeCfg.name} mode`,
+                description: modeCfg.description ? `\u00a0${GlyphChars.Dash}\u00a0 ${modeCfg.description}` : '',
+                key: key
+            } as ModesQuickPickItem;
+        });
+
+        if (mode) {
+            items.splice(0, 0, {
+                label: `Exit ${Container.config.modes[mode].name} mode`,
+                key: undefined
+            } as ModesQuickPickItem);
+        }
+
+        const pick = await window.showQuickPick(items, {
+            placeHolder: 'select a GitLens mode to enter'
+        } as QuickPickOptions);
+
+        return pick;
+    }
+}

src/quickPicks/quickPicks.ts

@@ -8,6 +8,7 @@ export * from './commitQuickPick';
 export * from './commitsQuickPick';
 export * from './commonQuickPicks';
 export * from './fileHistoryQuickPick';
+export * from './modesQuickPick';
 export * from './remotesQuickPick';
 export * from './repositoriesQuickPick';
 export * from './repoStatusQuickPick';

src/statusBarController.ts

@@ -1,7 +1,7 @@
 'use strict';
 import { ConfigurationChangeEvent, Disposable, StatusBarAlignment, StatusBarItem, TextEditor, window } from 'vscode';
 import { Commands } from './commands';
-import { configuration, IConfig, StatusBarCommand } from './configuration';
+import { configuration, StatusBarCommand } from './configuration';
 import { isTextEditor } from './constants';
 import { Container } from './container';
 import { LinesChangeEvent } from './trackers/gitLineTracker';
@@ -9,8 +9,9 @@ import { CommitFormatter, GitCommit, ICommitFormatOptions } from './gitService';
 
 export class StatusBarController extends Disposable {
 
+    private _blameStatusBarItem: StatusBarItem | undefined;
     private _disposable: Disposable;
-    private _statusBarItem: StatusBarItem | undefined;
+    private _modeStatusBarItem: StatusBarItem | undefined;
 
     constructor() {
         super(() => this.dispose());
@@ -22,9 +23,10 @@ export class StatusBarController extends Disposable {
     }
 
     dispose() {
-        this.clear();
+        this.clearBlame();
 
-        this._statusBarItem && this._statusBarItem.dispose();
+        this._blameStatusBarItem && this._blameStatusBarItem.dispose();
+        this._modeStatusBarItem && this._modeStatusBarItem.dispose();
 
         Container.lineTracker.stop(this);
         this._disposable && this._disposable.dispose();
@@ -33,21 +35,48 @@ export class StatusBarController extends Disposable {
     private onConfigurationChanged(e: ConfigurationChangeEvent) {
         const initializing = configuration.initializing(e);
 
+        if (initializing || configuration.changed(e, configuration.name('mode').value)) {
+            const mode = Container.config.mode.active && Container.config.mode.statusBar.enabled
+                ? Container.config.modes[Container.config.mode.active]
+                : undefined;
+            if (mode && mode.statusBarItemName) {
+                const alignment = Container.config.mode.statusBar.alignment !== 'left' ? StatusBarAlignment.Right : StatusBarAlignment.Left;
+
+                if (configuration.changed(e, configuration.name('mode')('statusBar')('alignment').value)) {
+                    if (this._modeStatusBarItem !== undefined && this._modeStatusBarItem.alignment !== alignment) {
+                        this._modeStatusBarItem.dispose();
+                        this._modeStatusBarItem = undefined;
+                    }
+                }
+
+                this._modeStatusBarItem = this._modeStatusBarItem || window.createStatusBarItem(alignment, alignment === StatusBarAlignment.Right ? 999 : 1);
+                this._modeStatusBarItem.command = Commands.SwitchMode;
+                this._modeStatusBarItem.text = mode.statusBarItemName;
+                this._modeStatusBarItem.tooltip = `Switch GitLens Mode`;
+                this._modeStatusBarItem.show();
+            }
+            else {
+                if (this._modeStatusBarItem !== undefined) {
+                    this._modeStatusBarItem.dispose();
+                    this._modeStatusBarItem = undefined;
+                }
+            }
+        }
+
         if (!initializing && !configuration.changed(e, configuration.name('statusBar').value)) return;
 
-        const cfg = configuration.get<IConfig>();
-        if (cfg.statusBar.enabled) {
-            const alignment = cfg.statusBar.alignment !== 'left' ? StatusBarAlignment.Right : StatusBarAlignment.Left;
+        if (Container.config.statusBar.enabled) {
+            const alignment = Container.config.statusBar.alignment !== 'left' ? StatusBarAlignment.Right : StatusBarAlignment.Left;
 
             if (configuration.changed(e, configuration.name('statusBar')('alignment').value)) {
-                if (this._statusBarItem !== undefined && this._statusBarItem.alignment !== alignment) {
-                    this._statusBarItem.dispose();
-                    this._statusBarItem = undefined;
+                if (this._blameStatusBarItem !== undefined && this._blameStatusBarItem.alignment !== alignment) {
+                    this._blameStatusBarItem.dispose();
+                    this._blameStatusBarItem = undefined;
                 }
             }
 
-            this._statusBarItem = this._statusBarItem || window.createStatusBarItem(alignment, alignment === StatusBarAlignment.Right ? 1000 : 0);
-            this._statusBarItem.command = cfg.statusBar.command;
+            this._blameStatusBarItem = this._blameStatusBarItem || window.createStatusBarItem(alignment, alignment === StatusBarAlignment.Right ? 1000 : 0);
+            this._blameStatusBarItem.command = Containerclass="p">.config.statusBar.command;
 
             if (initializing || configuration.changed(e, configuration.name('statusBar')('enabled').value)) {
                 Container.lineTracker.start(
@@ -60,9 +89,9 @@ export class StatusBarController extends Disposable {
             if (configuration.changed(e, configuration.name('statusBar')('enabled').value)) {
                 Container.lineTracker.stop(this);
 
-                if (this._statusBarItem !== undefined) {
-                    this._statusBarItem.dispose();
-                    this._statusBarItem = undefined;
+                if (this._blameStatusBarItem !== undefined) {
+                    this._blameStatusBarItem.dispose();
+                    this._blameStatusBarItem = undefined;
                 }
             }
         }
@@ -74,7 +103,7 @@ export class StatusBarController extends Disposable {
         if (!e.pending && e.lines !== undefined) {
             const state = Container.lineTracker.getState(e.lines[0]);
             if (state !== undefined && state.commit !== undefined) {
-                this.updateStatusBar(state.commit, e.editor!);
+                this.updateBlame(state.commit, e.editor!);
 
                 return;
             }
@@ -83,54 +112,54 @@ export class StatusBarController extends Disposable {
         }
 
         if (clear) {
-            this.clear();
+            this.clearBlame();
         }
     }
 
-    async clear() {
-        if (this._statusBarItem !== undefined) {
-            this._statusBarItem.hide();
+    async clearBlame() {
+        if (this._blameStatusBarItem !== undefined) {
+            this._blameStatusBarItem.hide();
         }
     }
 
-    private updateStatusBar(commit: GitCommit, editor: TextEditor) {
+    private updateBlame(commit: GitCommit, editor: TextEditor) {
         const cfg = Container.config.statusBar;
-        if (!cfg.enabled || this._statusBarItem === undefined || !isTextEditor(editor)) return;
+        if (!cfg.enabled || this._blameStatusBarItem === undefined || !isTextEditor(editor)) return;
 
-        this._statusBarItem.text = `$(git-commit) ${CommitFormatter.fromTemplate(cfg.format, commit, {
+        this._blameStatusBarItem.text = `$(git-commit) ${CommitFormatter.fromTemplate(cfg.format, commit, {
             truncateMessageAtNewLine: true,
             dateFormat: cfg.dateFormat === null ? Container.config.defaultDateFormat : cfg.dateFormat
         } as ICommitFormatOptions)}`;
 
         switch (cfg.command) {
             case StatusBarCommand.ToggleFileBlame:
-                this._statusBarItem.tooltip = 'Toggle Blame Annotations';
+                this._blameStatusBarItem.tooltip = 'Toggle Blame Annotations';
                 break;
             case StatusBarCommand.DiffWithPrevious:
-                this._statusBarItem.command = Commands.DiffLineWithPrevious;
-                this._statusBarItem.tooltip = 'Compare Line Revision with Previous';
+                this._blameStatusBarItem.command = Commands.DiffLineWithPrevious;
+                this._blameStatusBarItem.tooltip = 'Compare Line Revision with Previous';
                 break;
             case StatusBarCommand.DiffWithWorking:
-                this._statusBarItem.command = Commands.DiffLineWithWorking;
-                this._statusBarItem.tooltip = 'Compare Line Revision with Working';
+                this._blameStatusBarItem.command = Commands.DiffLineWithWorking;
+                this._blameStatusBarItem.tooltip = 'Compare Line Revision with Working';
                 break;
             case StatusBarCommand.ToggleCodeLens:
-                this._statusBarItem.tooltip = 'Toggle Git CodeLens';
+                this._blameStatusBarItem.tooltip = 'Toggle Git CodeLens';
                 break;
             case StatusBarCommand.ShowQuickCommitDetails:
-                this._statusBarItem.tooltip = 'Show Commit Details';
+                this._blameStatusBarItem.tooltip = 'Show Commit Details';
                 break;
             case StatusBarCommand.ShowQuickCommitFileDetails:
-                this._statusBarItem.tooltip = 'Show Line Commit Details';
+                this._blameStatusBarItem.tooltip = 'Show Line Commit Details';
                 break;
             case StatusBarCommand.ShowQuickFileHistory:
-                this._statusBarItem.tooltip = 'Show File History';
+                this._blameStatusBarItem.tooltip = 'Show File History';
                 break;
             case StatusBarCommand.ShowQuickCurrentBranchHistory:
-                this._statusBarItem.tooltip = 'Show Branch History';
+                this._blameStatusBarItem.tooltip = 'Show Branch History';
                 break;
         }
 
-        this._statusBarItem.show();
+        this._blameStatusBarItem.show();
     }
 }

src/ui/config.ts

@@ -223,6 +223,17 @@ export interface IMenuConfig {
     };
 }
 
+export interface IModeConfig {
+    name: string;
+    statusBarItemName?: string;
+    description?: string;
+    codeLens?: boolean;
+    currentLine?: boolean;
+    explorers?: boolean;
+    hovers?: boolean;
+    statusBar?: boolean;
+}
+
 export interface IResultsExplorerConfig {
     files: IExplorersFilesConfig;
 }
@@ -311,12 +322,20 @@ export interface IConfig {
     insiders: boolean;
     keymap: KeyMap;
     menus: boolean | IMenuConfig;
+    mode: {
+        active: string;
+        statusBar: {
+            enabled: boolean;
+            alignment: 'left' | 'right';
+        }
+    };
+    modes: { [key: string]: IModeConfig };
     outputLevel: OutputLevel;
 
     recentChanges: {
         highlight: {
             locations: HighlightLocations[];
-        };
+        }
         toggleMode: AnnotationsToggleMode;
     };
 
@@ -341,8 +360,8 @@ export interface IConfig {
                 recentChangeAndAuthors: string;
                 recentChangeOnly: string;
                 authorsOnly: string;
-            };
-        };
+            }
+        }
     };
 
     advanced: IAdvancedConfig;

src/ui/settings/index.html

@@ -829,6 +829,57 @@
                         </div>
                     </section>
 
+                    <section id="modes">
+                        <div class="section__header">
+                            <h2 class="section__title">Modes
+                                <a class="link__learn-more" title="Learn more" href="https://github.com/eamodio/vscode-gitlens/#modes">
+                                    <i class="icon icon__info"></i>
+                                </a>
+                            </h2>
+                            <p class="section__title-hint">GitLens supports user-defined modes for quickly toggling between sets of settings</p>
+                        </div>
+
+                        <div class="section__settings">
+                            <div class="settings-group">
+                                <div class="settings-group__setting nowrap">
+                                    <input class="setting" id="mode.statusBar.enabled" name="mode.statusBar.enabled" type="checkbox"/>
+                                    <label for="mode.statusBar.enabled">Show the active mode in the status bar</label>
+                                </div>
+
+                                <div class="settings-group__setting ml-2" data-enablement="mode.statusBar.enabled">
+                                    <label for="mode.statusBar.alignment">Position the annotation on the</label>
+                                    <select class="setting" id="mode.statusBar.alignment" name="mode.statusBar.alignment" disabled>
+                                        <option value="left">left</option>
+                                        <option value="right">right</option>
+                                    </select>
+                                </div>
+                            </div>
+
+                            <div class="section__preview">
+                                <img class="image__preview" src="{{root}}/images/settings/status-bar.png"/>
+                                <img class="image__preview--overlay hidden" src="{{root}}/images/settings/modes-status-bar-left.png" data-visibility="mode.statusBar.enabled &amp; mode.statusBar.alignment =left"/>
+                                <img class="image__preview--overlay hidden" src="{{root}}/images/settings/modes-status-bar-right.png" data-visibility="mode.statusBar.enabled &amp; mode.statusBar.alignment =right"/>
+                            </div>
+
+                            <p class="settings-group__hint">
+                                <i class="icon icon--lg icon__info"></i>
+                                For more advanced customizations or to add your own modes, open <a class="command" title="Open User Settings" href="command:workbench.action.openGlobalSettings">User Settings</a> and search for <b><i>gitlens.modes</i></b>
+                                <span class="settings-group__hint--more">
+                                    Use the
+                                    <a class="command" title="Run command" href="command:gitlens.switchMode">GitLens: Switch Mode</a> command to quickly switch the active mode
+                                </span>
+                                <span class="settings-group__hint--more">
+                                    Use the
+                                    <a class="command" title="Run command" href="command:gitlens.toggleReviewMode">GitLens: Toggle Review Mode</a> command to toggle Review mode
+                                </span>
+                                <span class="settings-group__hint--more">
+                                    Use the
+                                    <a class="command" title="Run command" href="command:gitlens.toggleZenMode">GitLens: Toggle Zen Mode</a> command to toggle Zen mode
+                                </span>
+                            </p>
+                        </div>
+                    </section>
+
                     <section id="recent-changes">
                         <div class="section__header">
                             <h2 class="section__title">Recent Changes
@@ -989,6 +1040,7 @@
                             <li><a class="jump-to" href="#blame">Gutter Blame</a></li>
                             <li><a class="jump-to" href="#heatmap">Gutter Heatmap</a></li>
                             <li><a class="jump-to" href="#hovers">Hovers</a></li>
+                            <li><a class="jump-to" href="#modes">Modes</a></li>
                             <li><a class="jump-to" href="#recent-changes">Recent Changes</a></li>
                             <li><a class="jump-to" href="#status-bar">Status Bar Blame</a></li>
                         </ul>

src/views/historyExplorer.ts

@@ -57,10 +57,10 @@ export class HistoryExplorer extends Disposable implements TreeDataProvider
 
         if (initializing || configuration.changed(e, configuration.name('historyExplorer')('enabled').value)) {
             if (Container.config.historyExplorer.enabled) {
-                this.undock(!initializing);
+                this.undock(!initializing, !configuration.changed(e, configuration.name('mode').value));
             }
             else {
-                this.dock(!initializing);
+                this.dock(!initializing, !configuration.changed(e, configuration.name('mode').value));
             }
         }
 
@@ -113,12 +113,14 @@ export class HistoryExplorer extends Disposable implements TreeDataProvider
         return node.getTreeItem();
     }
 
-    async dock(switchView: boolean = true) {
+    async dock(switchView: boolean = true, updateConfig: boolean = true) {
         if (switchView) {
             await Container.gitExplorer.switchTo(GitExplorerView.History);
         }
-        setCommandContext(CommandContext.HistoryExplorer, false);
-        configuration.updateEffective(configuration.name('historyExplorer')('enabled').value, false);
+        await setCommandContext(CommandContext.HistoryExplorer, false);
+        if (updateConfig) {
+            await configuration.updateEffective(configuration.name('historyExplorer')('enabled').value, false);
+        }
     }
 
     getQualifiedCommand(command: string) {
@@ -163,12 +165,14 @@ export class HistoryExplorer extends Disposable implements TreeDataProvider
         }
     }
 
-    async undock(switchView: boolean = true) {
+    async undock(switchView: boolean = true, updateConfig: boolean = true) {
         if (switchView) {
             await Container.gitExplorer.switchTo(GitExplorerView.Repository);
         }
-        setCommandContext(CommandContext.HistoryExplorer, true);
-        configuration.updateEffective(configuration.name('historyExplorer')('enabled').value, true);
+        await setCommandContext(CommandContext.HistoryExplorer, true);
+        if (updateConfig) {
+            await configuration.updateEffective(configuration.name('historyExplorer')('enabled').value, true);
+        }
     }
 
     private clearRoot() {

src/webviews/settingsEditor.ts

@@ -1,6 +1,6 @@
 'use strict';
 import { commands, workspace } from 'vscode';
-import { Container } from '../container';
+import { configuration, IConfig } from '../configuration';
 import { SettingsBootstrap } from '../ui/ipc';
 import { WebviewEditor } from './webviewEditor';
 
@@ -24,7 +24,8 @@ export class SettingsEditor extends WebviewEditor {
 
     getBootstrap() {
         return {
-            config: Container.config,
+            // Make sure to get the raw config, not from the container which has the modes mixed in
+            config: configuration.get<IConfig>(),
             scope: 'user',
             scopes: this.getAvailableScopes()
         } as SettingsBootstrap;

src/webviews/webviewEditor.ts

@@ -1,6 +1,6 @@
 'use strict';
 import { ConfigurationChangeEvent, ConfigurationTarget, Disposable, Uri, ViewColumn, WebviewPanel, WebviewPanelOnDidChangeViewStateEvent, window, workspace } from 'vscode';
-import { configuration } from '../configuration';
+import { configuration, IConfig } from '../configuration';
 import { Container } from '../container';
 import { Message, SettingsChangedMessage } from '../ui/ipc';
 import { Logger } from '../logger';
@@ -162,6 +162,7 @@ export abstract class WebviewEditor extends Disposable {
     }
 
     private postUpdatedConfiguration() {
-        return this.postMessage({ type: 'settingsChanged', config: Container.config } as SettingsChangedMessage, 'config');
+        // Make sure to get the raw config, not from the container which has the modes mixed in
+        return this.postMessage({ type: 'settingsChanged', config: configuration.get<IConfig>() } as SettingsChangedMessage, 'config');
     }
 }