Add custom avatar

(#1636, #5155)

Author: tmkx

package.json

@@ -4102,6 +4102,10 @@
 										"fileRange": {
 											"type": "string",
 											"markdownDescription": "Specifies the format of a range in a file URL for the custom remote service\n\nAvailable tokens\\\n`${start}` — starting line\\\n`${end}` — ending line"
+										},
+										"avatar": {
+											"type": "string",
+											"markdownDescription": "Specifies the format of a avatar url for the custom remote service\n\nAvailable tokens\\\n`${email}` — contributor email\\\n`${name}` — email local-part\\\n`${domain}` — email domain\\\n`${size}` — avatar size"
 										}
 									},
 									"additionalProperties": false

packages/git/src/models/remoteProvider.ts

@@ -74,6 +74,7 @@ export interface RemotesUrlsConfig {
 	readonly fileInCommit: string;
 	readonly fileLine: string;
 	readonly fileRange: string;
+	readonly avatar?: string;
 }
 
 export abstract class RemoteProvider<T extends ResourceDescriptor = ResourceDescriptor> implements ProviderReference {

packages/git/src/remotes/custom.ts

@@ -35,6 +35,19 @@ export class CustomRemoteProvider extends RemoteProvider {
 		return [];
 	}
 
+	getUrlForAvatar(email: string, size: number): string | undefined {
+		if (this.urls.avatar != null) {
+			const [name, domain] = email.split('@');
+			return this.encodeUrl(
+				interpolate(
+					this.urls.avatar,
+					this.getContext({ name: name, domain: domain, email: email, size: String(size) }),
+				),
+			);
+		}
+		return undefined;
+	}
+
 	protected override getUrlForRepository(): string {
 		return this.getUrl(this.urls.repository, this.getContext());
 	}

src/avatars.ts

@@ -1,5 +1,6 @@
 import { EventEmitter, Uri } from 'vscode';
 import type { CommitAuthor } from '@gitlens/git/models/author.js';
+import { CustomRemoteProvider } from '@gitlens/git/remotes/custom.js';
 import { getGitHubNoReplyAddressParts } from '@gitlens/git/remotes/github.js';
 import { base64 } from '@gitlens/utils/base64.js';
 import { md5 } from '@gitlens/utils/crypto.js';
@@ -135,7 +136,7 @@ function getAvatarUriCore(
 	if (
 		!options?.cached &&
 		repoPathOrCommit != null &&
-		getContext('gitlens:repos:withHostingIntegrationsConnected')?.includes(
+		getContext('gitlens:repos:withRemotes')?.includes(
 			typeof repoPathOrCommit === 'string' ? repoPathOrCommit : repoPathOrCommit.repoPath,
 		)
 	) {
@@ -245,6 +246,23 @@ async function getAvatarUriFromRemoteProvider(
 					avatarSize: size,
 				});
 			}
+
+			if (!account) {
+				const remoteWithProvider = await Container.instance.git
+					.getRepositoryService(repoPathOrCommit.repoPath)
+					.remotes.getBestRemoteWithProvider();
+
+				if (remoteWithProvider?.provider instanceof CustomRemoteProvider) {
+					const avatarUrl = remoteWithProvider.provider.getUrlForAvatar(email, size);
+					if (avatarUrl != null) {
+						avatar.uri = Uri.parse(avatarUrl);
+						avatar.timestamp = Date.now();
+						avatar.retries = 0;
+						avatarCache.set(`${md5(email.trim().toLowerCase())}:${size}`, { ...avatar });
+						return avatar.uri;
+					}
+				}
+			}
 		}
 
 		if (account?.avatarUrl == null) {

src/config.ts

@@ -699,6 +699,7 @@ export interface RemotesUrlsConfig {
 	readonly fileInCommit: string;
 	readonly fileLine: string;
 	readonly fileRange: string;
+	readonly avatar?: string;
 }
 
 interface SigningConfig {