Improves commit & stash tooltips

Improves tips in labels & tooltips
 - Adds remote icons to tips rendering

Author: eamodio

CHANGELOG.md

@@ -11,6 +11,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Adds a new `counts` option to the `gitlens.launchpad.indicator.label` setting to show the status counts of items which need your attention in the _Launchpad_ status bar indicator
 - Adds _Search for Commits within Selection_ command to the editor context menu when there is a selection
 - Adds a `gitlens.launchpad.ignoredOrganizations` setting to specify an array of organizations (or users) to ignore in the _Launchpad_
+- Improves the tooltips of stashes in GitLens views
+  - Adds a `gitlens.views.formats.stashes.tooltip` setting to specify the tooltip format of the stashes in GitLens views
+- Improves the display of branch and tag tips in the _File History_ and _Line History_ and in commit tooltips in GitLens views
+  - Adds provider-specific icons to tips of remote branches
 
 ### Changed
 

package.json

@@ -650,7 +650,7 @@
 					},
 					"gitlens.views.formats.commits.tooltip": {
 						"type": "string",
-						"default": "${link}${' via 'pullRequest}${'  •  'changesDetail}${'    'tips}\n\n${avatar}  __${author}__, ${ago}   _(${date})_ \n\n${message}${\n\n---\n\nfootnotes}",
+						"default": "${link}${'  •  'changesDetail}${'    'tips} \\\n${avatar}  __${author}__, ${ago}${' via 'pullRequest}   _(${date})_ \n\n${message}${\n\n---\n\nfootnotes}",
 						"markdownDescription": "Specifies the tooltip format (in markdown) of commits in the views. See [_Commit Tokens_](https://github.com/eamodio/vscode-gitlens/wiki/Custom-Formatting#commit-tokens) in the GitLens docs",
 						"scope": "window",
 						"order": 32
@@ -690,6 +690,13 @@
 						"scope": "window",
 						"order": 51
 					},
+					"gitlens.views.formats.stashes.tooltip": {
+						"type": "string",
+						"default": "${link}${' on `'stashOnRef`}${'  •  'changesDetail} \\\n  ${ago}   _(${date})_ \n\n${message}${\n\n---\n\nfootnotes}",
+						"markdownDescription": "Specifies the tooltip format (in markdown) of stashes in the views. See [_Commit Tokens_](https://github.com/eamodio/vscode-gitlens/wiki/Custom-Formatting#commit-tokens) in the GitLens docs",
+						"scope": "window",
+						"order": 52
+					},
 					"gitlens.views.openChangesInMultiDiffEditor": {
 						"type": "boolean",
 						"default": true,

src/config.ts

@@ -596,6 +596,7 @@ export interface ViewsCommonConfig {
 		readonly stashes: {
 			readonly label: string;
 			readonly description: string;
+			readonly tooltip: string;
 		};
 	};
 	readonly openChangesInMultiDiffEditor: boolean;

src/env/node/git/localGitProvider.ts

@@ -81,7 +81,6 @@ import type { GitFile, GitFileStatus } from '../../../git/models/file';
 import { GitFileChange } from '../../../git/models/file';
 import type {
 	GitGraph,
-	GitGraphHostingServiceType,
 	GitGraphRow,
 	GitGraphRowContexts,
 	GitGraphRowHead,
@@ -2569,7 +2568,7 @@ export class LocalGitProvider implements GitProvider, Disposable {
 									avatarUrl: avatarUrl,
 									context: serializeWebviewItemContext<GraphItemRefContext>(context),
 									current: tip === headRefUpstreamName,
-									hostingServiceType: remote.provider?.id as GitGraphHostingServiceType,
+									hostingServiceType: remote.provider?.gkProviderId,
 								};
 								refRemoteHeads.push(refRemoteHead);
 

src/git/formatters/commitFormatter.ts

@@ -29,7 +29,7 @@ import { encodeHtmlWeak, escapeMarkdown, getSuperscript } from '../../system/str
 import type { ContactPresence } from '../../vsls/vsls';
 import type { PreviousLineComparisonUrisResult } from '../gitProvider';
 import type { GitCommit } from '../models/commit';
-import { isCommit } from '../models/commit';
+import { isCommit, isStash } from '../models/commit';
 import { uncommitted, uncommittedStaged } from '../models/constants';
 import { getIssueOrPullRequestMarkdownIcon } from '../models/issue';
 import type { PullRequest } from '../models/pullRequest';
@@ -585,28 +585,41 @@ export class CommitFormatter extends Formatter<GitCommit, CommitFormatOptions> {
 	}
 
 	get link(): string {
+		let icon;
+		let label;
+		if (isStash(this._item)) {
+			icon = 'archive';
+			label = this._padOrTruncate(
+				`Stash${this._item.number ? ` #${this._item.number}` : ''}`,
+				this._options.tokenOptions.link,
+			);
+		} else {
+			icon = this._item.sha != null && !this._item.isUncommitted ? 'git-commit' : '';
+			label = this._padOrTruncate(
+				shortenRevision(this._item.sha ?? '', { strings: { working: 'Working Tree' } }),
+				this._options.tokenOptions.id,
+			);
+		}
+
 		let link;
 		switch (this._options.outputFormat) {
-			case 'markdown': {
-				const sha = this._padOrTruncate(this._item.shortSha ?? '', this._options.tokenOptions.id);
-				link = `[\`$(git-commit) ${sha}\`](${InspectCommand.getMarkdownCommandArgs(
-					this._item.sha,
-					this._item.repoPath,
-				)} "Inspect Commit Details")`;
+			case 'markdown':
+				icon = icon ? `$(${icon}) ` : '';
+				link = `[\`${icon}${label}\`](${InspectCommand.getMarkdownCommandArgs({
+					ref: getReferenceFromRevision(this._item),
+				})} "Inspect Commit Details")`;
 				break;
-			}
-			case 'html': {
-				const sha = this._padOrTruncate(this._item.shortSha ?? '', this._options.tokenOptions.id);
-				link = /*html*/ `<a href="${InspectCommand.getMarkdownCommandArgs(
-					this._item.sha,
-					this._item.repoPath,
-				)}" title="Inspect Commit Details"${
+			case 'html':
+				icon = icon ? `<span class="codicon codicon-${icon}"></span>` : '';
+				link = /*html*/ `<a href="${InspectCommand.getMarkdownCommandArgs({
+					ref: getReferenceFromRevision(this._item),
+				})}" title="Inspect Commit Details"${
 					this._options.htmlFormat?.classes?.link ? ` class="${this._options.htmlFormat.classes.link}"` : ''
-				}><span class="codicon codicon-git-commit"></span>${sha}</a>`;
+				}>${icon}${label}</a>`;
 				break;
-			}
 			default:
-				return this.id;
+				link = this.id;
+				break;
 		}
 
 		return this._padOrTruncate(link, this._options.tokenOptions.link);

src/git/gitProviderService.ts

@@ -69,7 +69,7 @@ import type { GitBranchReference, GitReference } from './models/reference';
 import { createRevisionRange, isSha, isUncommitted, isUncommittedParent } from './models/reference';
 import type { GitReflog } from './models/reflog';
 import type { GitRemote } from './models/remote';
-import { getVisibilityCacheKey } from './models/remote';
+import { getRemoteThemeIconString, getVisibilityCacheKey } from './models/remote';
 import type { RepositoryChangeEvent } from './models/repository';
 import { Repository, RepositoryChange, RepositoryChangeComparisonMode } from './models/repository';
 import type { GitStash } from './models/stash';
@@ -1605,60 +1605,69 @@ export class GitProviderService implements Disposable {
 	@log()
 	async getBranchesAndTagsTipsFn(
 		repoPath: string | Uri | undefined,
-		currentName?: string,
+		suppressName?: string,
 	): Promise<
 		(sha: string, options?: { compact?: boolean | undefined; icons?: boolean | undefined }) => string | undefined
 	> {
-		const [branchesResult, tagsResult] = await Promise.allSettled([
+		if (repoPath == null) return () => undefined;
+
+		const [branchesResult, tagsResult, remotesResult] = await Promise.allSettled([
 			this.getBranches(repoPath),
 			this.getTags(repoPath),
+			this.getRemotes(repoPath),
 		]);
 
 		const branches = getSettledValue(branchesResult)?.values ?? [];
 		const tags = getSettledValue(tagsResult)?.values ?? [];
+		const remotes = getSettledValue(remotesResult) ?? [];
 
 		const branchesAndTagsBySha = groupByFilterMap(
 			(branches as (GitBranch | GitTag)[]).concat(tags as (GitBranch | GitTag)[]),
 			bt => bt.sha,
 			bt => {
-				if (currentName) {
-					if (bt.name === currentName) return undefined;
-					if (bt.refType === 'branch' && bt.getNameWithoutRemote() === currentName) {
-						return { name: bt.name, compactName: bt.getRemoteName(), type: bt.refType };
+				let icon;
+				if (bt.refType === 'branch') {
+					if (bt.remote) {
+						const remote = remotes.find(r => r.name === bt.getRemoteName());
+						icon = `$(${getRemoteThemeIconString(remote)}) `;
+					} else {
+						icon = '$(git-branch) ';
 					}
+				} else {
+					icon = '$(tag) ';
 				}
 
-				return { name: bt.name, compactName: undefined, type: bt.refType };
+				return {
+					name: bt.name,
+					icon: icon,
+					compactName:
+						suppressName && bt.refType === 'branch' && bt.getNameWithoutRemote() === suppressName
+							? bt.getRemoteName()
+							: undefined,
+					type: bt.refType,
+				};
 			},
 		);
 
 		return (sha: string, options?: { compact?: boolean; icons?: boolean }): string | undefined => {
 			const branchesAndTags = branchesAndTagsBySha.get(sha);
-			if (branchesAndTags == null || branchesAndTags.length === 0) return undefined;
+			if (!branchesAndTags?.length) return undefined;
+
+			const tips =
+				suppressName && options?.compact
+					? branchesAndTags.filter(bt => bt.name !== suppressName)
+					: branchesAndTags;
 
 			if (!options?.compact) {
-				return branchesAndTags
-					.map(
-						bt => `${options?.icons ? `${bt.type === 'tag' ? '$(tag)' : '$(git-branch)'} ` : ''}${bt.name}`,
-					)
-					.join(', ');
+				return tips.map(bt => `${options?.icons ? bt.icon : ''}${bt.name}`).join(', ');
 			}
 
-			if (branchesAndTags.length > 1) {
-				const [bt] = branchesAndTags;
-				return `${options?.icons ? `${bt.type === 'tag' ? '$(tag)' : '$(git-branch)'} ` : ''}${
-					bt.compactName ?? bt.name
-				}, ${GlyphChars.Ellipsis}`;
+			if (tips.length > 1) {
+				const [bt] = tips;
+				return `${options?.icons ? bt.icon : ''}${bt.compactName ?? bt.name}, ${GlyphChars.Ellipsis}`;
 			}
 
-			return branchesAndTags
-				.map(
-					bt =>
-						`${options?.icons ? `${bt.type === 'tag' ? '$(tag)' : '$(git-branch)'} ` : ''}${
-							bt.compactName ?? bt.name
-						}`,
-				)
-				.join(', ');
+			return tips.map(bt => `${options?.icons ? bt.icon : ''}${bt.compactName ?? bt.name}`).join(', ');
 		};
 	}
 

src/git/models/graph.ts

@@ -7,6 +7,8 @@ import type {
 	RowStats,
 	Tag,
 } from '@gitkraken/gitkraken-components';
+import type { GkProviderId } from '../../gk/models/repositoryIdentities';
+import type { Brand, Unbrand } from '../../system/brand';
 import type { GitBranch } from './branch';
 import type { GitRemote } from './remote';
 
@@ -64,3 +66,44 @@ export interface GitGraph {
 }
 
 export type GitGraphRowsStats = Map<string, GitGraphRowStats>;
+
+export function convertHostingServiceTypeToGkProviderId(type: GitGraphHostingServiceType): GkProviderId | undefined {
+	switch (type) {
+		case 'github':
+			return 'github' satisfies Unbrand<GkProviderId> as Brand<GkProviderId>;
+		case 'githubEnterprise':
+			return 'githubEnterprise' satisfies Unbrand<GkProviderId> as Brand<GkProviderId>;
+		case 'gitlab':
+			return 'gitlab' satisfies Unbrand<GkProviderId> as Brand<GkProviderId>;
+		case 'gitlabSelfHosted':
+			return 'gitlabSelfHosted' satisfies Unbrand<GkProviderId> as Brand<GkProviderId>;
+		case 'bitbucket':
+			return 'bitbucket' satisfies Unbrand<GkProviderId> as Brand<GkProviderId>;
+		case 'bitbucketServer':
+			return 'bitbucketServer' satisfies Unbrand<GkProviderId> as Brand<GkProviderId>;
+		case 'azureDevops':
+			return 'azureDevops' satisfies Unbrand<GkProviderId> as Brand<GkProviderId>;
+		default:
+			return undefined;
+	}
+}
+
+export function getGkProviderThemeIconString(
+	providerIdOrHostingType: GkProviderId | GitGraphHostingServiceType | undefined,
+): string {
+	switch (providerIdOrHostingType) {
+		case 'azureDevops':
+			return 'gitlens-provider-azdo';
+		case 'bitbucket':
+		case 'bitbucketServer':
+			return 'gitlens-provider-bitbucket';
+		case 'github':
+		case 'githubEnterprise':
+			return 'gitlens-provider-github';
+		case 'gitlab':
+		case 'gitlabSelfHosted':
+			return 'gitlens-provider-gitlab';
+		default:
+			return 'cloud';
+	}
+}

src/git/models/remote.ts

@@ -8,6 +8,7 @@ import { equalsIgnoreCase, sortCompare } from '../../system/string';
 import { isLightTheme } from '../../system/utils';
 import { parseGitRemoteUrl } from '../parsers/remoteParser';
 import type { RemoteProvider } from '../remotes/remoteProvider';
+import { getRemoteProviderThemeIconString } from '../remotes/remoteProvider';
 
 export type GitRemoteType = 'fetch' | 'push';
 
@@ -163,6 +164,10 @@ export function getRemoteIconUri(
 	return asWebviewUri != null ? asWebviewUri(uri) : uri;
 }
 
+export function getRemoteThemeIconString(remote: GitRemote | undefined): string {
+	return getRemoteProviderThemeIconString(remote?.provider);
+}
+
 export function getRemoteUpstreamDescription(remote: GitRemote): string {
 	const arrows = getRemoteArrowsGlyph(remote);
 

src/git/remotes/remoteProvider.ts

@@ -193,3 +193,7 @@ export abstract class RemoteProvider<T extends ResourceDescriptor = ResourceDesc
 		return urls;
 	}
 }
+
+export function getRemoteProviderThemeIconString(provider: RemoteProvider | undefined): string {
+	return provider != null ? `gitlens-provider-${provider.icon}` : 'cloud';
+}

src/plus/integrations/providers/github/githubGitProvider.ts

@@ -49,7 +49,6 @@ import type { GitFile } from '../../../../git/models/file';
 import { GitFileChange, GitFileIndexStatus } from '../../../../git/models/file';
 import type {
 	GitGraph,
-	GitGraphHostingServiceType,
 	GitGraphRow,
 	GitGraphRowContexts,
 	GitGraphRowHead,
@@ -1424,7 +1423,7 @@ export class GitHubGitProvider implements GitProvider, Disposable {
 							avatarUrl: avatarUrl,
 							context: serializeWebviewItemContext<GraphItemRefContext>(context),
 							current: true,
-							hostingServiceType: remote.provider?.id as GitGraphHostingServiceType,
+							hostingServiceType: remote.provider?.gkProviderId,
 						},
 					];
 
@@ -1476,7 +1475,7 @@ export class GitHubGitProvider implements GitProvider, Disposable {
 							url: remote.url,
 							avatarUrl: avatarUrl,
 							context: serializeWebviewItemContext<GraphItemRefContext>(context),
-							hostingServiceType: remote.provider?.id as GitGraphHostingServiceType,
+							hostingServiceType: remote.provider?.gkProviderId,
 						});
 					}
 				}