Add custom avatar

Author: tmkx

package.json

@@ -3576,6 +3576,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

src/avatars.ts

@@ -126,13 +126,7 @@ function getAvatarUriCore(
 	const avatar = createOrUpdateAvatar(key, email, size, hash, options?.defaultStyle);
 	if (avatar.uri != null) return avatar.uri;
 
-	if (
-		!options?.cached &&
-		repoPathOrCommit != null &&
-		getContext('gitlens:repos:withHostingIntegrationsConnected')?.includes(
-			typeof repoPathOrCommit === 'string' ? repoPathOrCommit : repoPathOrCommit.repoPath,
-		)
-	) {
+	if (!options?.cached && repoPathOrCommit != null) {
 		let query = avatarQueue.get(key);
 		if (query == null && hasAvatarExpired(avatar)) {
 			query = getAvatarUriFromRemoteProvider(avatar, key, email, repoPathOrCommit, { size: size }).then(
@@ -220,6 +214,23 @@ async function getAvatarUriFromRemoteProvider(
 ) {
 	ensureAvatarCache(avatarCache);
 
+	if (
+		!getContext('gitlens:repos:withHostingIntegrationsConnected')?.includes(
+			typeof repoPathOrCommit === 'string' ? repoPathOrCommit : repoPathOrCommit.repoPath,
+		)
+	) {
+		const remote = await Container.instance.git.getBestRemoteWithProvider(
+			typeof repoPathOrCommit !== 'string' ? repoPathOrCommit.repoPath : repoPathOrCommit,
+		);
+		const avatarUrl = remote?.provider.getUrlForAvatar?.(email, size);
+		if (avatarUrl) {
+			avatar.uri = Uri.parse(avatarUrl);
+			avatar.timestamp = Date.now();
+			avatar.retries = 0;
+		}
+		return avatar.uri ?? avatar.fallback;
+	}
+
 	try {
 		let account: CommitAuthor | undefined;
 		// if (typeof repoPathOrCommit === 'string') {

src/config.ts

@@ -572,6 +572,7 @@ export interface RemotesUrlsConfig {
 	readonly fileInCommit: string;
 	readonly fileLine: string;
 	readonly fileRange: string;
+	readonly avatar?: string;
 }
 
 // NOTE: Must be kept in sync with `gitlens.advanced.messages` setting in the package.json

src/git/remotes/custom.ts

@@ -33,6 +33,19 @@ export class CustomRemote extends RemoteProvider {
 		return Promise.resolve(undefined);
 	}
 
+	override getUrlForAvatar(email: string, size: number) {
+		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/git/remotes/remoteProvider.ts

@@ -167,6 +167,8 @@ export abstract class RemoteProvider<T extends ResourceDescriptor = ResourceDesc
 
 	protected abstract getUrlForCommit(sha: string): string;
 
+	getUrlForAvatar?(email: string, size: number): string | undefined;
+
 	protected getUrlForComparison?(base: string, compare: string, notation: '..' | '...'): string | undefined;
 
 	protected getUrlForCreatePullRequest?(