Adds a contributors section to comparison results

Author: eamodio

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+### Added
+
+- Adds a _Contributors_ section to comparison results in the views
+
 ## [16.1.1] - 2024-12-20
 
 ### Added

contributions.json

@@ -10138,6 +10138,32 @@
 				]
 			}
 		},
+		"gitlens.views.setContributorsStatisticsOff": {
+			"label": "Hide Contributors Statistics",
+			"icon": "$(graph-line)",
+			"menus": {
+				"view/item/context": [
+					{
+						"when": "viewItem == gitlens:contributors && config.gitlens.views.showContributorsStatistics",
+						"group": "inline",
+						"order": 99
+					}
+				]
+			}
+		},
+		"gitlens.views.setContributorsStatisticsOn": {
+			"label": "Show Contributors Statistics",
+			"icon": "$(graph-line)",
+			"menus": {
+				"view/item/context": [
+					{
+						"when": "viewItem == gitlens:contributors && !config.gitlens.views.showContributorsStatistics",
+						"group": "inline",
+						"order": 99
+					}
+				]
+			}
+		},
 		"gitlens.views.setResultsCommitsFilterAuthors": {
 			"label": "Filter Commits by Author...",
 			"icon": "$(filter)",

package.json

@@ -1552,6 +1552,27 @@
 						"scope": "window",
 						"order": 5
 					},
+					"gitlens.views.showComparisonContributors": {
+						"type": "boolean",
+						"default": true,
+						"markdownDescription": "Specifies whether to show a _Contributors_ section on comparison results in the views",
+						"scope": "window",
+						"order": 6
+					},
+					"gitlens.views.showContributorsStatistics": {
+						"type": "boolean",
+						"default": false,
+						"markdownDescription": "Specifies whether to show contributor statistics in _Contributors_ sections in the views. This can take a while to compute depending on the repository size",
+						"scope": "window",
+						"order": 7
+					},
+					"gitlens.views.showRelativeDateMarkers": {
+						"type": "boolean",
+						"default": true,
+						"markdownDescription": "Specifies whether to show relative date markers (_Less than a week ago_, _Over a week ago_, _Over a month ago_, etc) on revision (commit) histories in the views",
+						"scope": "window",
+						"order": 8
+					},
 					"gitlens.views.defaultItemLimit": {
 						"type": "number",
 						"default": 10,
@@ -1566,13 +1587,6 @@
 						"scope": "window",
 						"order": 11
 					},
-					"gitlens.views.showRelativeDateMarkers": {
-						"type": "boolean",
-						"default": true,
-						"markdownDescription": "Specifies whether to show relative date markers (_Less than a week ago_, _Over a week ago_, _Over a month ago_, etc) on revision (commit) histories in the views",
-						"scope": "window",
-						"order": 20
-					},
 					"gitlens.views.formats.commits.label": {
 						"type": "string",
 						"default": "${❰ tips|11? ❱➤  }${message}",
@@ -9067,6 +9081,16 @@
 				"title": "Compare with Working Tree",
 				"icon": "$(compare-changes)"
 			},
+			{
+				"command": "gitlens.views.setContributorsStatisticsOff",
+				"title": "Hide Contributors Statistics",
+				"icon": "$(graph-line)"
+			},
+			{
+				"command": "gitlens.views.setContributorsStatisticsOn",
+				"title": "Show Contributors Statistics",
+				"icon": "$(graph-line)"
+			},
 			{
 				"command": "gitlens.views.setResultsCommitsFilterAuthors",
 				"title": "Filter Commits by Author...",
@@ -12510,6 +12534,14 @@
 					"command": "gitlens.views.setBranchComparisonToWorking",
 					"when": "false"
 				},
+				{
+					"command": "gitlens.views.setContributorsStatisticsOff",
+					"when": "false"
+				},
+				{
+					"command": "gitlens.views.setContributorsStatisticsOn",
+					"when": "false"
+				},
 				{
 					"command": "gitlens.views.setResultsCommitsFilterAuthors",
 					"when": "false"
@@ -15849,6 +15881,16 @@
 					"when": "viewItem =~ /gitlens:contributors\\b/ && !gitlens:hasVirtualFolders && !gitlens:readonly && !gitlens:untrusted",
 					"group": "inline@1"
 				},
+				{
+					"command": "gitlens.views.setContributorsStatisticsOff",
+					"when": "viewItem == gitlens:contributors && config.gitlens.views.showContributorsStatistics",
+					"group": "inline@99"
+				},
+				{
+					"command": "gitlens.views.setContributorsStatisticsOn",
+					"when": "viewItem == gitlens:contributors && !config.gitlens.views.showContributorsStatistics",
+					"group": "inline@99"
+				},
 				{
 					"command": "gitlens.views.addAuthors",
 					"when": "viewItem =~ /gitlens:contributors\\b/ && !listMultiSelection && !gitlens:hasVirtualFolders && !gitlens:readonly && !gitlens:untrusted",

src/config.ts

@@ -673,14 +673,16 @@ export interface ViewsCommonConfig {
 			readonly tooltip: string;
 		};
 	};
+	readonly openChangesInMultiDiffEditor: boolean;
+	readonly pageItemLimit: number;
 	readonly scm: {
 		grouped: {
 			readonly default: GroupableTreeViewTypes;
 			readonly views: Record<GroupableTreeViewTypes, boolean>;
 		};
 	};
-	readonly openChangesInMultiDiffEditor: boolean;
-	readonly pageItemLimit: number;
+	readonly showComparisonContributors: boolean;
+	readonly showContributorsStatistics: boolean;
 	readonly showCurrentBranchOnTop: boolean;
 	readonly showRelativeDateMarkers: boolean;
 }
@@ -689,7 +691,10 @@ export const viewsCommonConfigKeys: (keyof ViewsCommonConfig)[] = [
 	'collapseWorktreesWhenPossible',
 	'defaultItemLimit',
 	'formats',
+	'openChangesInMultiDiffEditor',
 	'pageItemLimit',
+	'showComparisonContributors',
+	'showContributorsStatistics',
 	'showCurrentBranchOnTop',
 	'showRelativeDateMarkers',
 ];

src/constants.commands.ts

@@ -662,7 +662,9 @@ export type TreeViewCommands = `gitlens.views.${
 	| 'openWorktreeInNewWindow'
 	| 'openWorktreeInNewWindow.multi'
 	| 'setResultsCommitsFilterAuthors'
-	| 'setResultsCommitsFilterOff'}`;
+	| 'setResultsCommitsFilterOff'
+	| 'setContributorsStatisticsOff'
+	| 'setContributorsStatisticsOn'}`;
 
 type ExtractSuffix<Prefix extends string, U> = U extends `${Prefix}${infer V}` ? V : never;
 type FilterCommands<Prefix extends string, U> = U extends `${Prefix}${infer V}` ? `${Prefix}${V}` : never;

src/views/nodes/compareBranchNode.ts

@@ -5,7 +5,7 @@ import { GlyphChars } from '../../constants';
 import type { StoredBranchComparison, StoredBranchComparisons, StoredNamedRef } from '../../constants.storage';
 import type { GitUri } from '../../git/gitUri';
 import type { GitBranch } from '../../git/models/branch';
-import { createRevisionRange , shortenRevision } from '../../git/models/revision.utils';
+import { createRevisionRange, shortenRevision } from '../../git/models/revision.utils';
 import type { GitUser } from '../../git/models/user';
 import type { CommitsQueryResults, FilesQueryResults } from '../../git/queryResults';
 import { getCommitsQuery, getFilesQuery } from '../../git/queryResults';
@@ -118,8 +118,11 @@ export class CompareBranchNode extends SubscribeableViewNode<
 		if (this._compareWith == null) return [];
 
 		if (this.children == null) {
-			const ahead = this.ahead;
-			const behind = this.behind;
+			const ahead = {
+				...this.ahead,
+				range: createRevisionRange(this.ahead.ref1, this.compareWithWorkingTree ? '' : this.ahead.ref2, '..'),
+			};
+			const behind = { ...this.behind, range: createRevisionRange(this.behind.ref1, this.behind.ref2, '..') };
 
 			const counts = await this.view.container.git.getLeftRightCommitCount(
 				this.branch.repoPath,
@@ -138,7 +141,7 @@ export class CompareBranchNode extends SubscribeableViewNode<
 					this.repoPath,
 					'Behind',
 					{
-						query: this.getCommitsQuery(createRevisionRange(behind.ref1, behind.ref2, '..')),
+						query: this.getCommitsQuery(behind.range),
 						comparison: behind,
 						direction: 'behind',
 						files: {
@@ -158,9 +161,7 @@ export class CompareBranchNode extends SubscribeableViewNode<
 					this.repoPath,
 					'Ahead',
 					{
-						query: this.getCommitsQuery(
-							createRevisionRange(ahead.ref1, this.compareWithWorkingTree ? '' : ahead.ref2, '..'),
-						),
+						query: this.getCommitsQuery(ahead.ref1),
 						comparison: ahead,
 						direction: 'ahead',
 						files: {

src/views/nodes/compareResultsNode.ts

@@ -4,7 +4,7 @@ import { Disposable, ThemeIcon, TreeItem, TreeItemCheckboxState, TreeItemCollaps
 import type { StoredNamedRef } from '../../constants.storage';
 import type { FilesComparison } from '../../git/actions/commit';
 import { GitUri } from '../../git/gitUri';
-import { createRevisionRange , shortenRevision } from '../../git/models/revision.utils';
+import { createRevisionRange, shortenRevision } from '../../git/models/revision.utils';
 import type { GitUser } from '../../git/models/user';
 import type { CommitsQueryResults, FilesQueryResults } from '../../git/queryResults';
 import { getAheadBehindFilesQuery, getCommitsQuery, getFilesQuery } from '../../git/queryResults';
@@ -133,8 +133,11 @@ export class CompareResultsNode extends SubscribeableViewNode<
 
 	async getChildren(): Promise<ViewNode[]> {
 		if (this.children == null) {
-			const ahead = this.ahead;
-			const behind = this.behind;
+			const ahead = {
+				...this.ahead,
+				range: createRevisionRange(this.ahead.ref1, this.ahead.ref2, '..'),
+			};
+			const behind = { ...this.behind, range: createRevisionRange(this.behind.ref1, this.behind.ref2, '..') };
 
 			const counts = await this.view.container.git.getLeftRightCommitCount(
 				this.repoPath,
@@ -154,7 +157,7 @@ export class CompareResultsNode extends SubscribeableViewNode<
 					this.repoPath,
 					'Behind',
 					{
-						query: this.getCommitsQuery(createRevisionRange(behind.ref1, behind.ref2, '..')),
+						query: this.getCommitsQuery(behind.range),
 						comparison: behind,
 						direction: 'behind',
 						files: {
@@ -174,7 +177,7 @@ export class CompareResultsNode extends SubscribeableViewNode<
 					this.repoPath,
 					'Ahead',
 					{
-						query: this.getCommitsQuery(createRevisionRange(ahead.ref1, ahead.ref2, '..')),
+						query: this.getCommitsQuery(ahead.range),
 						comparison: ahead,
 						direction: 'ahead',
 						files: {

src/views/nodes/contributorsNode.ts

@@ -24,7 +24,13 @@ export class ContributorsNode extends CacheableChildrenViewNode<
 		view: ViewsWithContributorsNode,
 		protected override readonly parent: ViewNode,
 		public readonly repo: Repository,
-		private readonly options?: { all?: boolean; showMergeCommits?: boolean; stats?: boolean },
+		private readonly options?: {
+			all?: boolean;
+			icon?: boolean;
+			ref?: string;
+			showMergeCommits?: boolean;
+			stats?: boolean;
+		},
 	) {
 		super('contributors', uri, view, parent);
 
@@ -42,11 +48,11 @@ export class ContributorsNode extends CacheableChildrenViewNode<
 
 	async getChildren(): Promise<ViewNode[]> {
 		if (this.children == null) {
-			const all = this.options?.all ?? configuration.get('views.contributors.showAllBranches');
+			let ref = this.options?.ref;
+			const all = ref == null && (this.options?.all ?? configuration.get('views.contributors.showAllBranches'));
 
-			let ref: string | undefined;
-			// If we aren't getting all branches, get the upstream of the current branch if there is one
-			if (!all) {
+			// If there is no ref and we aren't getting all branches, get the upstream of the current branch if there is one
+			if (ref == null && !all) {
 				try {
 					const branch = await this.view.container.git.getBranch(this.uri.repoPath);
 					if (branch?.upstream?.name != null && !branch.upstream.missing) {
@@ -88,7 +94,9 @@ export class ContributorsNode extends CacheableChildrenViewNode<
 		const item = new TreeItem('Contributors', TreeItemCollapsibleState.Collapsed);
 		item.id = this.id;
 		item.contextValue = ContextValues.Contributors;
-		item.iconPath = new ThemeIcon('organization');
+		if (this.options?.icon !== false) {
+			item.iconPath = new ThemeIcon('organization');
+		}
 		return item;
 	}
 

src/views/nodes/pullRequestNode.ts

@@ -177,6 +177,7 @@ export async function getPullRequestChildren(
 	const comparison = {
 		ref1: refs.base.ref,
 		ref2: refs.head.ref,
+		range: createRevisionRange(refs.base.ref, refs.head.ref, '..'),
 	};
 
 	const children = [
@@ -186,11 +187,7 @@ export async function getPullRequestChildren(
 			repoPath,
 			'Commits',
 			{
-				query: getCommitsQuery(
-					view.container,
-					repoPath,
-					createRevisionRange(comparison.ref1, comparison.ref2, '..'),
-				),
+				query: getCommitsQuery(view.container, repoPath, comparison.range),
 				comparison: comparison,
 			},
 			{

src/views/nodes/repositoryNode.ts

@@ -189,7 +189,11 @@ export class RepositoryNode extends SubscribeableViewNode<'repository', ViewsWit
 			}
 
 			if (this.view.config.showContributors) {
-				children.push(new ContributorsNode(this.uri, this.view, this, this.repo));
+				children.push(
+					new ContributorsNode(this.uri, this.view, this, this.repo, {
+						stats: this.view.config.showContributorsStatistics,
+					}),
+				);
 			}
 
 			if (this.view.config.showIncomingActivity && !this.repo.provider.virtual) {