Adds auto-refresh setting to the custom view

eamodio · eamodio · commit 6d09a1a9f279 · 2017-10-19T03:14:27.000-04:00
Adds auto-refresh toggling commands
Adds per-workspace state for toggling auto-refresh on/off
Adds layout selection commands
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ### Added
 - Adds `Open All Changes (with difftool)` command (`gitlens.externalDiffAll`) - opens all working changes with the configured git difftool -- closes [#164](https://github.com/eamodio/vscode-gitlens/issues/164)
   - Also adds the command to the Source Control group context menu
+- Adds `gitlens.gitExplorer.autoRefresh` setting to specify whether or not to automatically refresh the `GitLens` custom view when the repository or the file system changes
+- Adds `Enable Automatic Refresh` command (`gitlens.gitExplorer.setAutoRefreshToOn`) to enable the automatic refresh of the `GitLens` custom view
+- Adds `Disable Automatic Refresh` command (`gitlens.gitExplorer.setAutoRefreshToOff`) to disable the automatic refresh of the `GitLens` custom view
+- Adds `Show Files in Automatic View` command (`gitlens.gitExplorer.setFilesLayoutToAuto`) to change to an automatic layout for the files in the `GitLens` custom view
+- Adds `Show Files in List View` command (`gitlens.gitExplorer.setFilesLayoutToList`) to change to a list layout for the files in the `GitLens` custom view
+- Adds `Show Files in Tree View` command (`gitlens.gitExplorer.setFilesLayoutToTree`) to change to a tree layout for the files in the `GitLens` custom view
 
 ### Changed
 - Renames `Directory Compare` command (`gitlens.diffDirectory`) to `Compare Directory with Branch...`
@@ -17,6 +23,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ### Fixed
 - Fixes [#163](https://github.com/eamodio/vscode-gitlens/issues/163) - GitLens can cause git locking in the background
+- Fixes issue where the `GitLens` custom view would refresh more than once when a file system change was detected
+- Fixes issue where opening commit search could be filled out with `#00000000`
 
 ## [5.6.5] - 2017-10-16
 ### Removed
diff --git a/README.md b/README.md
@@ -371,6 +371,7 @@ GitLens is highly customizable and provides many configuration settings to allow
 |-----|------------
 |`gitlens.gitExplorer.enabled`|Specifies whether or not to show the `GitLens` custom view"
 |`gitlens.gitExplorer.view`|Specifies the starting view (mode) of the `GitLens` custom view<br /> `auto` - shows the last selected view, defaults to `repository`<br />`history` - shows the commit history of the active file<br />`repository` - shows a repository explorer"
+|`gitlens.gitExplorer.autoRefresh`|Specifies whether or not to automatically refresh the `GitLens` custom view when the repository or the file system changes
 |`gitlens.gitExplorer.files.layout`|Specifies how the `GitLens` custom view will display files<br /> `auto` - automatically switches between displaying files as a `tree` or `list` based on the `gitlens.gitExplorer.files.threshold` setting and the number of files at each nesting level<br /> `list` - displays files as a list<br /> `tree` - displays files as a tree
 |`gitlens.gitExplorer.files.compact`|Specifies whether or not to compact (flatten) unnecessary file nesting in the `GitLens` custom view<br />Only applies when displaying files as a `tree` or `auto`
 |`gitlens.gitExplorer.files.threshold`|Specifies when to switch between displaying files as a `tree` or `list` based on the number of files in a nesting level in the `GitLens` custom view<br />Only applies when displaying files as `auto`
diff --git a/package.json b/package.json
@@ -417,6 +417,11 @@
                     "default": null,
                     "description": "Specifies how all absolute dates will be formatted by default\nSee https://momentjs.com/docs/#/displaying/format/ for valid formats"
                 },
+                "gitlens.gitExplorer.autoRefresh": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Specifies whether or not to automatically refresh the `GitLens` custom view when the repository or the file system changes"
+                },
                 "gitlens.gitExplorer.commitFormat": {
                     "type": "string",
                     "default": "${message} \u00a0\u2022\u00a0 ${authorAgo} \u00a0 (${id})",
@@ -1123,6 +1128,16 @@
                 "title": "Reset Suppressed Warnings",
                 "category": "GitLens"
             },
+            {
+                "command": "gitlens.gitExplorer.setAutoRefreshToOn",
+                "title": "Enable Automatic Refresh",
+                "category": "GitLens"
+            },
+            {
+                "command": "gitlens.gitExplorer.setAutoRefreshToOff",
+                "title": "Disable Automatic Refresh",
+                "category": "GitLens"
+            },
             {
                 "command": "gitlens.gitExplorer.refresh",
                 "title": "Refresh",
@@ -1132,6 +1147,21 @@
                     "light": "images/light/icon-refresh.svg"
                 }
             },
+            {
+                "command": "gitlens.gitExplorer.setFilesLayoutToAuto",
+                "title": "Show Files in Automatic View",
+                "category": "GitLens"
+            },
+            {
+                "command": "gitlens.gitExplorer.setFilesLayoutToList",
+                "title": "Show Files in List View",
+                "category": "GitLens"
+            },
+            {
+                "command": "gitlens.gitExplorer.setFilesLayoutToTree",
+                "title": "Show Files in Tree View",
+                "category": "GitLens"
+            },
             {
                 "command": "gitlens.gitExplorer.switchToHistoryView",
                 "title": "Switch to History View",
@@ -1355,6 +1385,26 @@
                     "command": "gitlens.resetSuppressedWarnings",
                     "when": "gitlens:enabled"
                 },
+                {
+                    "command": "gitlens.gitExplorer.setAutoRefreshToOn",
+                    "when": "false"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setAutoRefreshToOff",
+                    "when": "false"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setFilesLayoutToAuto",
+                    "when": "false"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setFilesLayoutToList",
+                    "when": "false"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setFilesLayoutToTree",
+                    "when": "false"
+                },
                 {
                     "command": "gitlens.gitExplorer.refresh",
                     "when": "false"
@@ -1636,6 +1686,31 @@
                     "command": "gitlens.gitExplorer.refresh",
                     "when": "view == gitlens.gitExplorer",
                     "group": "navigation@4"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setFilesLayoutToAuto",
+                    "when": "view == gitlens.gitExplorer && gitlens:gitExplorer:view == repository",
+                    "group": "1_gitlens"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setFilesLayoutToList",
+                    "when": "view == gitlens.gitExplorer && gitlens:gitExplorer:view == repository",
+                    "group": "1_gitlens"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setFilesLayoutToTree",
+                    "when": "view == gitlens.gitExplorer && gitlens:gitExplorer:view == repository",
+                    "group": "1_gitlens"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setAutoRefreshToOn",
+                    "when": "view == gitlens.gitExplorer && gitlens:gitExplorer:view == repository && config.gitlens.gitExplorer.autoRefresh && !gitlens:gitExplorer:autoRefresh",
+                    "group": "2_gitlens"
+                },
+                {
+                    "command": "gitlens.gitExplorer.setAutoRefreshToOff",
+                    "when": "view == gitlens.gitExplorer && gitlens:gitExplorer:view == repository && config.gitlens.gitExplorer.autoRefresh && gitlens:gitExplorer:autoRefresh",
+                    "group": "2_gitlens"
                 }
             ],
             "view/item/context": [
diff --git a/src/configuration.ts b/src/configuration.ts
@@ -103,6 +103,7 @@ export interface ICodeLensLanguageLocation {
 
 export interface IGitExplorerConfig {
     enabled: boolean;
+    autoRefresh: boolean;
     view: GitExplorerView;
     files: {
         layout: GitExplorerFilesLayout;
diff --git a/src/constants.ts b/src/constants.ts
@@ -28,6 +28,8 @@ export enum CommandContext {
     AnnotationStatus = 'gitlens:annotationStatus',
     CanToggleCodeLens = 'gitlens:canToggleCodeLens',
     Enabled = 'gitlens:enabled',
+    GitExplorerAutoRefresh = 'gitlens:gitExplorer:autoRefresh',
+    GitExplorerFilesLayout = 'gitlens:gitExplorer:files:layout',
     GitExplorerView = 'gitlens:gitExplorer:view',
     HasRemotes = 'gitlens:hasRemotes',
     IsBlameable = 'gitlens:isBlameable',
@@ -76,5 +78,6 @@ export enum GlobalState {
 }
 
 export enum WorkspaceState {
+    GitExplorerAutoRefresh = 'gitlens:gitExplorer:autoRefresh',
     GitExplorerView = 'gitlens:gitExplorer:view'
 }
diff --git a/src/views/gitExplorer.ts b/src/views/gitExplorer.ts
@@ -1,9 +1,9 @@
 'use strict';
 import { Functions, Objects } from '../system';
-import { commands, Event, EventEmitter, ExtensionContext, TextDocumentShowOptions, TextEditor, TreeDataProvider, TreeItem, Uri, window, workspace } from 'vscode';
+import { commands, Disposable, Event, EventEmitter, ExtensionContext, TextDocumentShowOptions, TextEditor, TreeDataProvider, TreeItem, Uri, window, workspace } from 'vscode';
 import { Commands, DiffWithCommandArgs, DiffWithCommandArgsRevision, DiffWithPreviousCommandArgs, DiffWithWorkingCommandArgs, openEditor, OpenFileInRemoteCommandArgs } from '../commands';
 import { UriComparer } from '../comparers';
-import { ExtensionKey, IConfig } from '../configuration';
+import { ExtensionKey, GitExplorerFilesLayout, IConfig } from '../configuration';
 import { CommandContext, setCommandContext, WorkspaceState } from '../constants';
 import { BranchHistoryNode, CommitFileNode, CommitNode, ExplorerNode, HistoryNode, MessageNode, RepositoryNode, StashNode } from './explorerNodes';
 import { GitService, GitUri, RepoChangedReasons } from '../gitService';
@@ -37,6 +37,11 @@ export class GitExplorer implements TreeDataProvider<ExplorerNode> {
     }
 
     constructor(private readonly context: ExtensionContext, private readonly git: GitService) {
+        commands.registerCommand('gitlens.gitExplorer.setAutoRefreshToOn', () => this.setAutoRefresh(this.git.config.gitExplorer.autoRefresh, true), this);
+        commands.registerCommand('gitlens.gitExplorer.setAutoRefreshToOff', () => this.setAutoRefresh(this.git.config.gitExplorer.autoRefresh, true), this);
+        commands.registerCommand('gitlens.gitExplorer.setFilesLayoutToAuto', () => this.setFilesLayout(GitExplorerFilesLayout.Auto), this);
+        commands.registerCommand('gitlens.gitExplorer.setFilesLayoutToList', () => this.setFilesLayout(GitExplorerFilesLayout.List), this);
+        commands.registerCommand('gitlens.gitExplorer.setFilesLayoutToTree', () => this.setFilesLayout(GitExplorerFilesLayout.Tree), this);
         commands.registerCommand('gitlens.gitExplorer.switchToHistoryView', () => this.switchTo(GitExplorerView.History), this);
         commands.registerCommand('gitlens.gitExplorer.switchToRepositoryView', () => this.switchTo(GitExplorerView.Repository), this);
         commands.registerCommand('gitlens.gitExplorer.refresh', this.refresh, this);
@@ -52,9 +57,6 @@ export class GitExplorer implements TreeDataProvider<ExplorerNode> {
         commands.registerCommand('gitlens.gitExplorer.openChangedFileRevisions', this.openChangedFileRevisions, this);
         commands.registerCommand('gitlens.gitExplorer.applyChanges', this.applyChanges, this);
 
-        const repoChangedFn = Functions.debounce(this.onRepoChanged, 250);
-        context.subscriptions.push(this.git.onDidChangeRepo(repoChangedFn, this));
-
         const editorChangedFn = Functions.debounce(this.onActiveEditorChanged, 500);
         context.subscriptions.push(window.onDidChangeActiveTextEditor(editorChangedFn, this));
         context.subscriptions.push(workspace.onDidChangeConfiguration(this.onConfigurationChanged, this));
@@ -112,6 +114,14 @@ export class GitExplorer implements TreeDataProvider<ExplorerNode> {
 
         const changed = !Objects.areEquivalent(cfg.gitExplorer, this._config && this._config.gitExplorer);
 
+        if (cfg.gitExplorer.autoRefresh !== (this._config && this._config.gitExplorer.autoRefresh)) {
+            this.setAutoRefresh(cfg.gitExplorer.autoRefresh);
+        }
+
+        if (cfg.gitExplorer.files.layout !== (this._config && this._config.gitExplorer.files.layout)) {
+            setCommandContext(CommandContext.GitExplorerFilesLayout, cfg.gitExplorer.files.layout);
+        }
+
         this._config = cfg;
 
         if (changed) {
@@ -259,4 +269,38 @@ export class GitExplorer implements TreeDataProvider<ExplorerNode> {
     private async openFileRevisionInRemote(node: CommitNode | StashNode) {
         return commands.executeCommand(Commands.OpenFileInRemote, new GitUri(node.commit.uri, node.commit), { range: false } as OpenFileInRemoteCommandArgs);
     }
+
+    private _autoRefreshDisposable: Disposable | undefined;
+
+    private async setAutoRefresh(enabled: boolean, userToggle: boolean = false) {
+        if (this._autoRefreshDisposable !== undefined) {
+            this._autoRefreshDisposable.dispose();
+            this._autoRefreshDisposable = undefined;
+        }
+
+        if (enabled) {
+            enabled = this.context.workspaceState.get<boolean>(WorkspaceState.GitExplorerAutoRefresh, true);
+
+            if (userToggle) {
+                enabled = !enabled;
+                await this.context.workspaceState.update(WorkspaceState.GitExplorerAutoRefresh, enabled);
+            }
+
+            if (enabled) {
+                const repoChangedFn = Functions.debounce(this.onRepoChanged, 250);
+                this._autoRefreshDisposable = this.git.onDidChangeRepo(repoChangedFn, this);
+                this.context.subscriptions.push(this._autoRefreshDisposable);
+            }
+        }
+
+        setCommandContext(CommandContext.GitExplorerAutoRefresh, enabled);
+
+        if (userToggle) {
+            this.refresh();
+        }
+    }
+
+    private async setFilesLayout(layout: GitExplorerFilesLayout) {
+        await workspace.getConfiguration(ExtensionKey).update('gitExplorer.files.layout', layout, true);
+    }
 }
diff --git a/src/views/statusNode.ts b/src/views/statusNode.ts
@@ -1,4 +1,5 @@
 import { commands, Disposable, ExtensionContext, TreeItem, TreeItemCollapsibleState, Uri } from 'vscode';
+import { WorkspaceState } from '../constants';
 import { ExplorerNode, ResourceType } from './explorerNode';
 import { GitService, GitStatus, GitUri } from '../gitService';
 import { StatusFilesNode } from './statusFilesNode';
@@ -56,8 +57,12 @@ export class StatusNode extends ExplorerNode {
         if (this.includeWorkingTree) {
             this._status = status;
 
-            _eventDisposable = this.git.onDidChangeFileSystem(this.onFileSystemChanged, this);
-            this.git.startWatchingFileSystem();
+            if (this.git.config.gitExplorer.autoRefresh && this.context.workspaceState.get<boolean>(WorkspaceState.GitExplorerAutoRefresh, true)) {
+                _eventDisposable = this.git.onDidChangeFileSystem(this.onFileSystemChanged, this);
+                this.context.subscriptions.push(_eventDisposable);
+
+                this.git.startWatchingFileSystem();
+            }
         }
 
         let hasChildren = false;

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ export enum CommandContext {`
`28`	`28`	`AnnotationStatus = 'gitlens:annotationStatus',`
`29`	`29`	`CanToggleCodeLens = 'gitlens:canToggleCodeLens',`
`30`	`30`	`Enabled = 'gitlens:enabled',`
	`31`	`+ GitExplorerAutoRefresh = 'gitlens:gitExplorer:autoRefresh',`
	`32`	`+ GitExplorerFilesLayout = 'gitlens:gitExplorer:files:layout',`
`31`	`33`	`GitExplorerView = 'gitlens:gitExplorer:view',`
`32`	`34`	`HasRemotes = 'gitlens:hasRemotes',`
`33`	`35`	`IsBlameable = 'gitlens:isBlameable',`
`@@ -76,5 +78,6 @@ export enum GlobalState {`
`76`	`78`	`}`
`77`	`79`
`78`	`80`	`export enum WorkspaceState {`
	`81`	`+ GitExplorerAutoRefresh = 'gitlens:gitExplorer:autoRefresh',`
`79`	`82`	`GitExplorerView = 'gitlens:gitExplorer:view'`
`80`	`83`	`}`