Expose a button to hide files marked on the checkbox (#141)

Author: marcelomendoncasoares

package.json

@@ -148,6 +148,18 @@
                 "icon": "$(list-tree)",
                 "category": "Git Tree Compare"
             },
+            {
+                "command": "gitTreeCompare.hideCheckedInTree",
+                "title": "Hide checked files",
+                "icon": "$(eye)",
+                "category": "Git Tree Compare"
+            },
+            {
+                "command": "gitTreeCompare.showCheckedInTree",
+                "title": "Show checked files",
+                "icon": "$(eye-closed)",
+                "category": "Git Tree Compare"
+            },
             {
                 "command": "gitTreeCompare.searchChanges",
                 "title": "Search Changes",
@@ -315,6 +327,16 @@
                     "when": "view == gitTreeCompare && config.gitTreeCompare.showCheckboxes",
                     "group": "3_options"
                 },
+                {
+                    "command": "gitTreeCompare.hideCheckedInTree",
+                    "when": "view == gitTreeCompare && config.gitTreeCompare.showCheckboxes && !gitTreeCompare.hideCheckedFiles",
+                    "group": "navigation@0"
+                },
+                {
+                    "command": "gitTreeCompare.showCheckedInTree",
+                    "when": "view == gitTreeCompare && config.gitTreeCompare.showCheckboxes && gitTreeCompare.hideCheckedFiles",
+                    "group": "navigation@0"
+                },
                 {
                     "command": "gitTreeCompare.viewAsList",
                     "when": "view == gitTreeCompare && !gitTreeCompare.viewAsList",

src/extension.ts

@@ -94,6 +94,12 @@ export function activate(context: ExtensionContext) {
     commands.registerCommand(NAMESPACE + '.viewAsTree', () => {
         runAfterInit(() => provider!.viewAsTree(true));
     });
+    commands.registerCommand(NAMESPACE + '.hideCheckedInTree', () => {
+        runAfterInit(() => provider!.setHideCheckedFiles(true));
+    });
+    commands.registerCommand(NAMESPACE + '.showCheckedInTree', () => {
+        runAfterInit(() => provider!.setHideCheckedFiles(false));
+    });
     commands.registerCommand(NAMESPACE + '.searchChanges', () => {
         runAfterInit(() => provider!.searchChanges());
     });
@@ -133,6 +139,7 @@ export function activate(context: ExtensionContext) {
 
         // Set initial context for menu enablement (starts in tree view mode)
         commands.executeCommand('setContext', NAMESPACE + '.viewAsList', false);
+        commands.executeCommand('setContext', NAMESPACE + '.hideCheckedFiles', false);
         commands.executeCommand('setContext', NAMESPACE + '.isFiltered', false);
 
         provider = new GitTreeCompareProvider(git, gitApi, outputChannel, context.globalState, context.asAbsolutePath);

src/treeProvider.ts

@@ -146,6 +146,7 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
     private repository: Repository | undefined;
     private baseRef: string;
     private viewAsList = false;
+    private hideCheckedFiles = false;
     private searchFilter: string | undefined;
 
     // Static state of repository
@@ -368,6 +369,9 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
                 });
             }
         }
+        if (this.hideCheckedFiles) {
+            this._onDidChangeTreeData.fire();
+        }
     }
 
     private handleActiveEditorChange(editor: TextEditor | undefined) {
@@ -889,6 +893,10 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
         const oldSortOrder = this.sortOrder;
         const oldShowDiffStats = this.showDiffStats;
         this.readConfig();
+        if (oldshowCheckboxes && !this.showCheckboxes && this.hideCheckedFiles) {
+            this.hideCheckedFiles = false;
+            commands.executeCommand('setContext', NAMESPACE + '.hideCheckedFiles', false);
+        }
         if (oldTreeRootIsRepo != this.treeRootIsRepo ||
             oldInclude != this.includeFilesOutsideWorkspaceFolderRoot ||
             oldOpenChangesOnSelect != this.openChangesOnSelect ||
@@ -950,8 +958,24 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
                relativePath.toLowerCase().includes(searchLower);
     }
 
+    private isFileCheckboxChecked(dstAbsPath: string): boolean {
+        const stateInfo = this.checkboxStates.get(dstAbsPath);
+        return stateInfo?.state === TreeItemCheckboxState.Checked;
+    }
+
+    /** Whether this file row should appear in the tree (search + optional hide-checked). */
+    private fileVisibleInTree(dstAbsPath: string, relPathBase: string): boolean {
+        if (!this.matchesFilter(dstAbsPath, relPathBase)) {
+            return false;
+        }
+        if (this.hideCheckedFiles && this.isFileCheckboxChecked(dstAbsPath)) {
+            return false;
+        }
+        return true;
+    }
+
     private folderHasMatchingFiles(folder: string, useFilesOutsideTreeRoot: boolean): boolean {
-        if (!this.searchFilter) {
+        if (!this.searchFilter && !this.hideCheckedFiles) {
             return true;
         }
         const files = useFilesOutsideTreeRoot ? this.filesOutsideTreeRoot : this.filesInsideTreeRoot;
@@ -960,7 +984,7 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
         for (const [folderPath, fileEntries] of files.entries()) {
             if (folderPath === folder || folderPath.startsWith(folder + path.sep)) {
                 for (const file of fileEntries) {
-                    if (this.matchesFilter(file.dstAbsPath, relPathBase)) {
+                    if (this.fileVisibleInTree(file.dstAbsPath, relPathBase)) {
                         return true;
                     }
                 }
@@ -987,7 +1011,7 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
             for (const folder2 of folders) {
                 const fileEntries = files.get(folder2)!;
                 for (const file of fileEntries) {
-                    if (this.matchesFilter(file.dstAbsPath, relPathBase)) {
+                    if (this.fileVisibleInTree(file.dstAbsPath, relPathBase)) {
                         const dstRelPath = path.relative(relPathBase, file.dstAbsPath);
                         entries.push(new FileElement(file.srcAbsPath, file.dstAbsPath, dstRelPath, file.status, file.isSubmodule, file.stats));
                     }
@@ -1050,7 +1074,7 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
         // there are no files within treeRoot, therefore, this is guarded
         if (fileEntries) {
             for (const file of fileEntries) {
-                if (this.matchesFilter(file.dstAbsPath, relPathBase)) {
+                if (this.fileVisibleInTree(file.dstAbsPath, relPathBase)) {
                     const dstRelPath = path.relative(relPathBase, file.dstAbsPath);
                     entries.push(new FileElement(file.srcAbsPath, file.dstAbsPath, dstRelPath, file.status, file.isSubmodule, file.stats));
                 }
@@ -1628,6 +1652,16 @@ export class GitTreeCompareProvider implements TreeDataProvider<Element>, Dispos
         this.viewAsList = viewAsList;
         commands.executeCommand('setContext', NAMESPACE + '.viewAsList', viewAsList);
         this.log('Refreshing tree');
+        this._onDidChangeTreeData.fire();
+    }
+
+    setHideCheckedFiles(hide: boolean) {
+        if (hide === this.hideCheckedFiles) {
+            return;
+        }
+        this.hideCheckedFiles = hide;
+        commands.executeCommand('setContext', NAMESPACE + '.hideCheckedFiles', hide);
+        this.log('Refreshing tree');
         this.fireTreeDataChange();
     }