Adds custom avatar URL for custom remotes

[sergeibbb]

Rebases and integrates #1636 (by @tmkx) on top of the current main after the @gitlens/git package split.

Summary

Adds an optional avatar URL template to gitlens.remotes[].urls, enabling corporate / self-hosted setups to resolve commit-author avatars through a custom URL.

 "gitlens.remotes": [
   {
     "domain": "gitlab.intranet.com",
     "type": "Custom",
     "urls": {
       "repository": "https://gitlab.intranet.com/${repo}",
       ...
+      "avatar": "https://avatar.intranet.com/employee?username=${emailName}&size=${size}"
     }
   }
 ]

Available tokens: ${email}, ${emailName} (email local-part), ${domain}, ${size}.

When no hosting integration resolves the commit author, getAvatarUriFromRemoteProvider now falls back to the best remote-with-provider; if that provider is a CustomRemoteProvider with avatar configured, its interpolated URL is cached and returned.

Differences vs. original PR #1636

• Rebased onto the @gitlens/git package split — CustomRemote was renamed to CustomRemoteProvider and moved to packages/git/src/remotes/custom.ts; the RemotesUrlsConfig interface in the package needed the same avatar?: string addition as src/config.ts.
• ${name} token renamed to ${emailName} — disambiguates from the commit-author display name. The schema description already labels it as "email local-part", but the variable name itself was potentially confusing.
• Hardened against email-driven URL injection. Commit emails are attacker-controllable, and the original interpolation ran through encodeUrl (= encodeURI), which leaves /, ?, #, @, and : intact — so a crafted email could bend the resulting avatar URL's path, query, or fragment. getUrlForAvatar now component-encodes ${email}, ${emailName}, and ${domain} before interpolation, splits the email on the last @ (so RFC 5322 local-parts containing @ aren't truncated), and drops the now-redundant outer encodeUrl.
• CHANGELOG entry added — credits @tmkx for the original PR.
• Grammar fix in the markdownDescription for the avatar field ("a avatar url" → "an avatar URL").
• Scope of closed issues narrowed. The original PR description had close #302 and close #1036. This PR closes Get GitLab avatar by email #302 only. Issue Get avatar from user #1036 asks for a standalone gitlens.avatars setting (map of email → file URI, or a folder of images) so that users without a custom remote — e.g., regular github.com users who just want local employee photos — can configure avatars. That specific mechanism is not delivered here: this PR requires a gitlens.remotes entry with "type": "Custom" and an avatar template, so Get avatar from user #1036 should remain open.

Refs #1036 · Closes #302

Test plan

• With a gitlens.remotes entry of "type": "Custom" and an avatar template, commit-author avatars in the blame hover, commit details, and views resolve to the templated URL.
• Without an avatar template, behavior is unchanged (Gravatar / hosting-integration path).
• No regression on repos with only standard remotes (github/gitlab.com).
• Verify ${emailName}, ${email}, ${domain}, ${size} tokens all interpolate.
• Settings IntelliSense shows the avatar field with the correct description.
• Email with URL-structural characters (e.g., a/b@host) produces a URL that preserves the email verbatim via component-encoding, without bending the template's path/query.

[augmentcode]

🤖 Augment PR Summary

Summary: Adds support for resolving commit-author avatars via a user-configured URL template for “Custom” remotes.

Changes:

• Adds an optional avatar template under gitlens.remotes[].urls (schema + types) with tokens ${email}, ${emailName}, ${domain}, and ${size}
• Implements CustomRemoteProvider.getUrlForAvatar() to interpolate those tokens and component-encode email-derived values to prevent URL-structure injection
• Extends avatar resolution to fall back to the best remote provider when no hosting integration returns an avatar, using the custom template when present
• Adds a trusted-workspace + per-template approval prompt and persists approvals in global storage (sync-enabled)
• Introduces a reset command to clear approved avatar URL templates
• Adds unit tests covering interpolation, RFC-5322-style parsing, and encoding edge cases

Technical Notes: Custom avatar URLs are only honored in trusted workspaces and require explicit user approval; resolved URIs are cached alongside existing avatar sources.

_{🤖 Was this summary useful? React with 👍 or 👎}

[augmentcode]

Review completed. 3 suggestions posted.

Comment augment review to trigger a new review at any time.

[sergeibbb]

augment review

[augmentcode]

Review completed. 1 suggestion posted.

Comment augment review to trigger a new review at any time.

[sergeibbb]

augment review

[augmentcode]

Review completed. 2 suggestions posted.

Comment augment review to trigger a new review at any time.

[augmentcode]

Review completed. 1 suggestion posted.

Comment augment review to trigger a new review at any time.

[augmentcode]

hasAvatarSource can become true for a CustomRemoteProvider even when getApprovedCustomRemoteAvatarUrl(...) returns undefined due to an untrusted workspace, missing template, or not-yet-approved template. In that case this avatar.timestamp = Infinity permanently caches “no result” and can prevent avatars from starting to resolve later in the same session if trust/config/approval changes without an explicit cache reset.

Severity: medium

_{🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.}

[gitkraken-services]

Rebase Failed

Error Details

Error: No merge base found between HEAD and REBASE_HEAD. Repository is a shallow clone — try running "git fetch --unshallow"

Summary

Metric	Value
Target	main
Source	feature/custom-avatar-gk

---

Generated by Merge Mate at 2026-06-06 06:42:56 UTC