Add hide viewed files setting and toggle command

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

Author: Copilot

package.json

@@ -283,6 +283,11 @@
 					"default": "tree",
 					"description": "%githubPullRequests.fileListLayout.description%"
 				},
+				"githubPullRequests.hideViewedFiles": {
+					"type": "boolean",
+					"default": false,
+					"description": "%githubPullRequests.hideViewedFiles.description%"
+				},
 				"githubPullRequests.defaultDeletionMethod.selectLocalBranch": {
 					"type": "boolean",
 					"default": true,
@@ -1079,6 +1084,12 @@
 				"icon": "$(list-flat)",
 				"category": "%command.pull.request.category%"
 			},
+			{
+				"command": "pr.toggleHideViewedFiles",
+				"title": "%command.pr.toggleHideViewedFiles.title%",
+				"icon": "$(eye-closed)",
+				"category": "%command.pull.request.category%"
+			},
 			{
 				"command": "pr.refreshChanges",
 				"title": "%command.pr.refreshChanges.title%",
@@ -2635,6 +2646,11 @@
 					"when": "view == prStatus:github && !fileListLayout:flat",
 					"group": "navigation1"
 				},
+				{
+					"command": "pr.toggleHideViewedFiles",
+					"when": "view == prStatus:github",
+					"group": "navigation1"
+				},
 				{
 					"command": "pr.toggleEditorCommentingOn",
 					"when": "view == prStatus:github && !commentingEnabled",

package.nls.json

@@ -35,6 +35,7 @@
 	"githubPullRequests.defaultMergeMethod.description": "The method to use when merging pull requests.",
 	"githubPullRequests.notifications.description": "If GitHub notifications should be shown to the user.",
 	"githubPullRequests.fileListLayout.description": "The layout to use when displaying changed files list.",
+	"githubPullRequests.hideViewedFiles.description": "Hide files that have been marked as viewed in the pull request changes tree.",
 	"githubPullRequests.defaultDeletionMethod.selectLocalBranch.description": "When true, the option to delete the local branch will be selected by default when deleting a branch from a pull request.",
 	"githubPullRequests.defaultDeletionMethod.selectRemote.description": "When true, the option to delete the remote will be selected by default when deleting a branch from a pull request.",
 	"githubPullRequests.terminalLinksHandler.description": "Default handler for terminal links.",
@@ -220,6 +221,7 @@
 	"command.pr.refreshChatSessions.title": "Refresh Chat Sessions",
 	"command.pr.setFileListLayoutAsTree.title": "View as Tree",
 	"command.pr.setFileListLayoutAsFlat.title": "View as List",
+	"command.pr.toggleHideViewedFiles.title": "Toggle Hide Viewed Files",
 	"command.pr.refreshChanges.title": "Refresh",
 	"command.pr.configurePRViewlet.title": "Configure...",
 	"command.pr.deleteLocalBranch.title": "Delete Local Branch",

src/commands.ts

@@ -12,7 +12,7 @@ import { CommentReply, findActiveHandler, resolveCommentHandler } from './commen
 import { commands } from './common/executeCommands';
 import Logger from './common/logger';
 import * as PersistentState from './common/persistentState';
-import { FILE_LIST_LAYOUT, PR_SETTINGS_NAMESPACE } from './common/settingKeys';
+import { FILE_LIST_LAYOUT, HIDE_VIEWED_FILES, PR_SETTINGS_NAMESPACE } from './common/settingKeys';
 import { editQuery } from './common/settingsUtils';
 import { ITelemetry } from './common/telemetry';
 import { asTempStorageURI, fromPRUri, fromReviewUri, Schemes, toPRUri } from './common/uri';
@@ -1484,6 +1484,14 @@ ${contents}
 		}),
 	);
 
+	context.subscriptions.push(
+		vscode.commands.registerCommand('pr.toggleHideViewedFiles', _ => {
+			const config = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE);
+			const currentValue = config.get<boolean>(HIDE_VIEWED_FILES, false);
+			config.update(HIDE_VIEWED_FILES, !currentValue, true);
+		}),
+	);
+
 	context.subscriptions.push(
 		vscode.commands.registerCommand('pr.refreshPullRequest', (prNode: PRNode) => {
 			const folderManager = reposManager.getManagerForIssueModel(prNode.pullRequestModel);

src/common/settingKeys.ts

@@ -8,6 +8,7 @@ export const TERMINAL_LINK_HANDLER = 'terminalLinksHandler';
 export const BRANCH_PUBLISH = 'createOnPublishBranch';
 export const USE_REVIEW_MODE = 'useReviewMode';
 export const FILE_LIST_LAYOUT = 'fileListLayout';
+export const HIDE_VIEWED_FILES = 'hideViewedFiles';
 export const ASSIGN_TO = 'assignCreated';
 export const PUSH_BRANCH = 'pushBranch';
 export const IGNORE_PR_BRANCHES = 'ignoredPullRequestBranches';

src/extension.ts

@@ -17,7 +17,7 @@ import Logger from './common/logger';
 import * as PersistentState from './common/persistentState';
 import { parseRepositoryRemotes } from './common/remote';
 import { Resource } from './common/resources';
-import { BRANCH_PUBLISH, EXPERIMENTAL_CHAT, FILE_LIST_LAYOUT, GIT, IGNORE_SUBMODULES, OPEN_DIFF_ON_CLICK, PR_SETTINGS_NAMESPACE, SHOW_INLINE_OPEN_FILE_ACTION } from './common/settingKeys';
+import { BRANCH_PUBLISH, EXPERIMENTAL_CHAT, FILE_LIST_LAYOUT, GIT, HIDE_VIEWED_FILES, IGNORE_SUBMODULES, OPEN_DIFF_ON_CLICK, PR_SETTINGS_NAMESPACE, SHOW_INLINE_OPEN_FILE_ACTION } from './common/settingKeys';
 import { initBasedOnSettingChange } from './common/settingsUtils';
 import { TemporaryState } from './common/temporaryState';
 import { Schemes } from './common/uri';
@@ -241,6 +241,9 @@ async function init(
 	const layout = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string>(FILE_LIST_LAYOUT);
 	await vscode.commands.executeCommand('setContext', 'fileListLayout:flat', layout === 'flat');
 
+	const hideViewedFiles = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(HIDE_VIEWED_FILES, false);
+	await vscode.commands.executeCommand('setContext', 'hideViewedFiles', hideViewedFiles);
+
 	const issuesFeatures = new IssueFeatureRegistrar(git, reposManager, reviewsManager, context, telemetry, copilotRemoteAgentManager);
 	context.subscriptions.push(issuesFeatures);
 	await issuesFeatures.initialize();

src/view/prChangesTreeDataProvider.ts

@@ -8,7 +8,7 @@ import { GitApiImpl } from '../api/api1';
 import { commands, contexts } from '../common/executeCommands';
 import { Disposable } from '../common/lifecycle';
 import Logger, { PR_TREE } from '../common/logger';
-import { FILE_LIST_LAYOUT, GIT, OPEN_DIFF_ON_CLICK, PR_SETTINGS_NAMESPACE } from '../common/settingKeys';
+import { FILE_LIST_LAYOUT, GIT, HIDE_VIEWED_FILES, OPEN_DIFF_ON_CLICK, PR_SETTINGS_NAMESPACE } from '../common/settingKeys';
 import { isDescendant } from '../common/utils';
 import { FolderRepositoryManager } from '../github/folderRepositoryManager';
 import { PullRequestModel } from '../github/pullRequestModel';
@@ -50,6 +50,12 @@ export class PullRequestChangesTreeDataProvider extends Disposable implements vs
 					await vscode.commands.executeCommand('setContext', 'fileListLayout:flat', layout === 'flat');
 				} else if (e.affectsConfiguration(`${GIT}.${OPEN_DIFF_ON_CLICK}`)) {
 					this._onDidChangeTreeData.fire();
+				} else if (e.affectsConfiguration(`${PR_SETTINGS_NAMESPACE}.${HIDE_VIEWED_FILES}`)) {
+					this._onDidChangeTreeData.fire();
+					const hideViewedFiles = vscode.workspace
+						.getConfiguration(PR_SETTINGS_NAMESPACE)
+						.get<boolean>(HIDE_VIEWED_FILES, false);
+					await vscode.commands.executeCommand('setContext', 'hideViewedFiles', hideViewedFiles);
 				}
 			}),
 		);

src/view/treeNodes/filesCategoryNode.ts

@@ -4,8 +4,9 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
+import { ViewedState } from '../../common/comment';
 import Logger, { PR_TREE } from '../../common/logger';
-import { FILE_LIST_LAYOUT, PR_SETTINGS_NAMESPACE } from '../../common/settingKeys';
+import { FILE_LIST_LAYOUT, HIDE_VIEWED_FILES, PR_SETTINGS_NAMESPACE } from '../../common/settingKeys';
 import { compareIgnoreCase } from '../../common/utils';
 import { PullRequestModel } from '../../github/pullRequestModel';
 import { ReviewModel } from '../reviewModel';
@@ -39,6 +40,16 @@ export class FilesCategoryNode extends TreeNode implements vscode.TreeItem {
 				this.refresh(this);
 			}
 		}));
+		this.childrenDisposables.push(_pullRequestModel.onDidChangeFileViewedState(() => {
+			Logger.appendLine(`File viewed state has changed, refreshing Files node`, PR_TREE);
+			this.refresh(this);
+		}));
+		this.childrenDisposables.push(vscode.workspace.onDidChangeConfiguration(e => {
+			if (e.affectsConfiguration(`${PR_SETTINGS_NAMESPACE}.${HIDE_VIEWED_FILES}`)) {
+				Logger.appendLine(`Hide viewed files setting has changed, refreshing Files node`, PR_TREE);
+				this.refresh(this);
+			}
+		}));
 	}
 
 	getTreeItem(): vscode.TreeItem {
@@ -65,9 +76,19 @@ export class FilesCategoryNode extends TreeNode implements vscode.TreeItem {
 
 		let nodes: TreeNode[];
 		const layout = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string>(FILE_LIST_LAYOUT);
+		const hideViewedFiles = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(HIDE_VIEWED_FILES, false);
+
+		// Filter files based on hideViewedFiles setting
+		const filesToShow = hideViewedFiles
+			? this._reviewModel.localFileChanges.filter(f => f.changeModel.viewed !== ViewedState.VIEWED)
+			: this._reviewModel.localFileChanges;
+
+		if (filesToShow.length === 0 && hideViewedFiles) {
+			return [new LabelOnlyNode(this, vscode.l10n.t('All files viewed'))];
+		}
 
 		const dirNode = new DirectoryTreeNode(this, '');
-		this._reviewModel.localFileChanges.forEach(f => dirNode.addFile(f));
+		filesToShow.forEach(f => dirNode.addFile(f));
 		dirNode.finalize();
 		if (dirNode.label === '') {
 			// nothing on the root changed, pull children to parent
@@ -79,7 +100,7 @@ export class FilesCategoryNode extends TreeNode implements vscode.TreeItem {
 		if (layout === 'tree') {
 			nodes = this.directories;
 		} else {
-			const fileNodes = [...this._reviewModel.localFileChanges];
+			const fileNodes = [...filesToShow];
 			fileNodes.sort((a, b) => compareIgnoreCase(a.fileChangeResourceUri.toString(), b.fileChangeResourceUri.toString()));
 			nodes = fileNodes;
 		}