Add TM_FULLNAME and TM_EMAIL snippet variables by Copilot · Pull Request #315156 · microsoft/vscode

Copilot · 2026-05-08T01:52:04Z

Description

This adds first-class snippet variables for per-user identity so shared snippets can stamp author info without hardcoding names. It introduces user name/email expansion with cross-platform env fallbacks and keeps behavior deterministic with resolver ordering.

What’s added
- New snippet variables:
  - TM_FULLNAME
  - TM_EMAIL
- Registered in known snippet variable names so they are recognized as built-ins.
Resolution behavior
- TM_FULLNAME resolves in priority order:
  1. GIT_AUTHOR_NAME
  2. GIT_COMMITTER_NAME
  3. USER
  4. USERNAME
  5. LOGNAME
- TM_EMAIL resolves in priority order:
  1. GIT_AUTHOR_EMAIL
  2. GIT_COMMITTER_EMAIL
  3. EMAIL
- Environment lookup checks exact key first, then lowercase key, and ignores empty/whitespace values.
- Values are computed once per resolver instance (no extra static cache layer).
Editor integration
- Wired UserBasedVariableResolver into snippet expansion paths used by snippet session insertion.
Docs and coverage
- Updated snippet variable documentation to include both new variables.
- Added focused unit tests covering precedence, key-casing variants, and empty-value behavior.
Follow-up from review feedback
- Refactored UserBasedVariableResolver.resolve to use switch with default.
- Inlined env lookup helper logic into _resolveFromEnv.
- Removed placeholder constructor comment/body noise.
- Renamed variables from CURRENT_USER / CURRENT_USER_EMAIL to TM_FULLNAME / TM_EMAIL for TextMate naming consistency.
- Removed redundant toUpperCase() env lookup.
- Removed static _cached resolver fields so only one caching level remains.
- Reverted changes to extensions/json/syntaxes/snippets.tmLanguage.json per review feedback.

{
  "Comment todo": {
    "prefix": "//",
    "body": [
      "// TODO (${TM_FULLNAME}) [${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}]: $1",
      "// Contact: ${TM_EMAIL}"
    ]
  }
}

Testing

✅ npm run compile-check-ts-native
✅ npm run transpile-client
✅ node test/unit/browser/index.js --run src/vs/editor/contrib/snippet/test/browser/snippetVariables.test.ts --browser chromium
✅ npm run test-node -- --grep "Snippet Variables Resolver"

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/0295e588-92b2-4cca-be2c-beca6ec13536 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

dmitrivMS

See comments.
What happens on MacOS?

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/c29703c3-6f3a-4d9e-936f-5acb88f5b0aa Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot · 2026-05-08T02:09:17Z

See comments.
What happens on MacOS?

On macOS this resolves via the same fallback chain: GIT_AUTHOR_NAME → GIT_COMMITTER_NAME → USER → USERNAME → LOGNAME (and similarly for email via git vars then EMAIL). In practice macOS shells usually provide USER and LOGNAME, so it resolves correctly there as well. (Current implementation in 525ad4f.)

dmitrivMS · 2026-05-08T03:37:02Z

@copilot There are other places variables need to be registered - find and update them all.

Copilot

Pull request overview

This PR adds two new built-in snippet variables (CURRENT_USER, CURRENT_USER_EMAIL) that resolve from environment variables, and wires the new resolver into snippet insertion so snippets can stamp per-user identity information.

Changes:

Added UserBasedVariableResolver and registered CURRENT_USER / CURRENT_USER_EMAIL as known built-in snippet variables.
Integrated the new resolver into SnippetSession variable resolution so the variables expand during snippet insertion.
Updated snippet documentation and added unit tests for precedence, casing, and empty/whitespace handling.

Show a summary per file

File	Description
src/vs/editor/contrib/snippet/test/browser/snippetVariables.test.ts	Adds tests validating resolution behavior for the new user-based snippet variables.
src/vs/editor/contrib/snippet/browser/snippetVariables.ts	Introduces `UserBasedVariableResolver` and registers the new built-in variable names.
src/vs/editor/contrib/snippet/browser/snippetSession.ts	Wires `UserBasedVariableResolver` into the composite resolver used by snippet insertion paths.
src/vs/editor/contrib/snippet/browser/snippet.md	Documents the new snippet variables and their environment-variable fallbacks.

Copilot's findings

Files reviewed: 4/4 changed files
Comments generated: 2

+	private _resolveFromEnv(...keys: string[]): string | undefined {
+		for (const key of keys) {
+			const value = this._env[key] ?? this._env[key.toLowerCase()] ?? this._env[key.toUpperCase()];
+			if (!isFalsyOrWhitespace(value)) {
+				return value;
+			}


Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/01dab724-095e-4685-bee4-11787a1d2b27 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot · 2026-05-08T03:42:06Z

@copilot There are other places variables need to be registered - find and update them all.

Fixed in 7f4852d — I audited the registrations and updated all hard-coded snippet variable regex lists in extensions/json/syntaxes/snippets.tmLanguage.json to include CURRENT_USER and CURRENT_USER_EMAIL everywhere.

dmitrivMS · 2026-05-08T03:43:42Z

@copilot

Rename to TM_FULLNAME and TM_EMAIL to stay consistent with TM
How hard would it be to get TM_ORGANIZATION_NAME added? E.g. from auth service or something? Could be env:ORGANIZATION but it's probably unset most of the time. Is there Git equivalent?

dmitrivMS · 2026-05-08T03:44:11Z

@copilot Remove the redundant toUpperCase() in the env lookup.

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/7fe10c09-c687-4745-9d8c-be53d974033d Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot · 2026-05-08T03:48:32Z

@copilot

Rename to TM_FULLNAME and TM_EMAIL to stay consistent with TM

How hard would it be to get TM_ORGANIZATION_NAME added? E.g. from auth service or something? Could be env:ORGANIZATION ...

Done in e448a9b — renamed to TM_FULLNAME and TM_EMAIL across resolver/known vars/docs/tests/grammar.

For TM_ORGANIZATION_NAME: there isn’t a reliable git equivalent (git standard identity is name/email, not org). Pulling from auth service would be significantly heavier because snippet variable resolution is local/synchronous and currently env/git-based. The practical low-friction option would be best-effort env lookup (e.g. ORGANIZATION) as a separate follow-up, with expectation it’s often unset.

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/783657f3-89e8-4bfb-9d30-b25de02ef995 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot · 2026-05-08T03:56:10Z

@copilot Remove the redundant toUpperCase() in the env lookup.

Done in 8639604 — removed the redundant toUpperCase() lookup from env resolution. No UI changes in this PR, so no screenshot applies.

dmitrivMS · 2026-05-08T04:00:10Z

+				return this._email;
+		}
+
+		return undefined;


@copilot this can go into default:

Done in 58c183e — moved the fallback into the default branch of the switch in resolve. No UI changes in this PR, so no screenshot applies.

dmitrivMS · 2026-05-08T04:01:15Z

+
+	private static readonly _userNameEnvVariables = ['GIT_AUTHOR_NAME', 'GIT_COMMITTER_NAME', 'USER', 'USERNAME', 'LOGNAME'];
+	private static readonly _userEmailEnvVariables = ['GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', 'EMAIL'];
+	private static _cachedFullName: string | undefined;


@copilot remove these _cached variables - one level of caching is enough

Done in aef7942 — removed the static _cached variables and kept only the resolver-level computed values. No UI changes in this PR, so no screenshot applies.

dmitrivMS · 2026-05-08T04:02:58Z

@copilot revert changes to extensions/json/syntaxes/snippets.tmLanguage.json file

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/28dcb2a4-5a1e-4c4f-9a25-c2c03b8c25d8 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

RedCMD · 2026-05-08T04:04:28Z

also https://github.com/microsoft/vscode-docs @copilot

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/5548b474-3130-4b4c-99f0-453eb17214fb Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot · 2026-05-08T04:08:06Z

@copilot revert changes to extensions/json/syntaxes/snippets.tmLanguage.json file

Done in aef7942 — reverted extensions/json/syntaxes/snippets.tmLanguage.json to the pre-change version. No UI changes in this PR, so no screenshot applies.

Initial plan

6eb9cc4

Copilot AI assigned Copilot and dmitrivMS May 8, 2026

Copilot AI requested review from Copilot and removed request for Copilot May 8, 2026 01:52

Copilot started work on behalf of dmitrivMS May 8, 2026 01:52 View session

Copilot AI linked an issue May 8, 2026 that may be closed by this pull request

Using OS user name / git user name inside code snippets #64599

Open

Add snippet variables for current user name and email

b8d8f44

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/0295e588-92b2-4cca-be2c-beca6ec13536 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot AI requested review from Copilot and removed request for Copilot May 8, 2026 01:58

Copilot AI changed the title ~~[WIP] Add variable for OS or git user name in code snippets~~ Add snippet variables for current user name and email May 8, 2026

Copilot AI requested a review from dmitrivMS May 8, 2026 01:59

Copilot finished work on behalf of dmitrivMS May 8, 2026 01:59

dmitrivMS requested changes May 8, 2026

View reviewed changes

Comment thread src/vs/editor/contrib/snippet/browser/snippetVariables.ts Outdated

Comment thread src/vs/editor/contrib/snippet/browser/snippetVariables.ts Outdated

Comment thread src/vs/editor/contrib/snippet/browser/snippetVariables.ts Outdated

Copilot started work on behalf of dmitrivMS May 8, 2026 02:04 View session

Address PR feedback on user snippet resolver style

525ad4f

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/c29703c3-6f3a-4d9e-936f-5acb88f5b0aa Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot AI requested review from Copilot and removed request for Copilot May 8, 2026 02:08

Copilot finished work on behalf of dmitrivMS May 8, 2026 02:10

Copilot AI requested a review from dmitrivMS May 8, 2026 02:10

Merge branch 'main' into copilot/add-my-name-variable-snippet

ace7c65

Copilot AI review requested due to automatic review settings May 8, 2026 03:37

Copilot started work on behalf of dmitrivMS May 8, 2026 03:37 View session

Copilot started reviewing on behalf of dmitrivMS May 8, 2026 03:38 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

Register user snippet variables across JSON snippet grammar

7f4852d

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/01dab724-095e-4685-bee4-11787a1d2b27 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot AI changed the title ~~Add snippet variables for current user name and email~~ Add snippet variables for current user name and email and register them across snippet grammar May 8, 2026

Copilot started work on behalf of dmitrivMS May 8, 2026 03:43 View session

dmitrivMS reviewed May 8, 2026

View reviewed changes

Comment thread src/vs/editor/contrib/snippet/browser/snippetVariables.ts Outdated

Rename user snippet vars to TM_FULLNAME and TM_EMAIL

e448a9b

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/7fe10c09-c687-4745-9d8c-be53d974033d Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

dmitrivMS reviewed May 8, 2026

View reviewed changes

Comment thread extensions/json/syntaxes/snippets.tmLanguage.json Outdated

Copilot AI changed the title ~~Add snippet variables for current user name and email and register them across snippet grammar~~ Add TM_FULLNAME and TM_EMAIL snippet variables and register them across snippet grammar May 8, 2026

Copilot finished work on behalf of dmitrivMS May 8, 2026 03:49

Copilot AI requested a review from dmitrivMS May 8, 2026 03:49

Copilot started work on behalf of dmitrivMS May 8, 2026 03:49 View session

Copilot AI and others added 2 commits May 8, 2026 03:53

Refine TM env lookup and reorder TM variable registration

97927b7

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/783657f3-89e8-4bfb-9d30-b25de02ef995 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Polish TM variable resolver caching and env lookup

8639604

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/783657f3-89e8-4bfb-9d30-b25de02ef995 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot finished work on behalf of dmitrivMS May 8, 2026 03:57

dmitrivMS reviewed May 8, 2026

View reviewed changes

Copilot started work on behalf of dmitrivMS May 8, 2026 04:00 View session

dmitrivMS reviewed May 8, 2026

View reviewed changes

Use switch default in user snippet variable resolver

58c183e

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/28dcb2a4-5a1e-4c4f-9a25-c2c03b8c25d8 Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot finished work on behalf of dmitrivMS May 8, 2026 04:04

Copilot AI requested a review from dmitrivMS May 8, 2026 04:04

Copilot started work on behalf of dmitrivMS May 8, 2026 04:04 View session

Remove static cache and revert snippet grammar edits

aef7942

Agent-Logs-Url: https://github.com/microsoft/vscode/sessions/5548b474-3130-4b4c-99f0-453eb17214fb Co-authored-by: dmitrivMS <9581278+dmitrivMS@users.noreply.github.com>

Copilot AI changed the title ~~Add TM_FULLNAME and TM_EMAIL snippet variables and register them across snippet grammar~~ Add TM_FULLNAME and TM_EMAIL snippet variables May 8, 2026

Copilot finished work on behalf of dmitrivMS May 8, 2026 04:09

dmitrivMS added the snippets label May 9, 2026

dmitrivMS mentioned this pull request May 19, 2026

Using OS user name / git user name inside code snippets #64599

Open

Conversation

Copilot AI commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Uh oh!

dmitrivMS left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented May 8, 2026

Uh oh!

dmitrivMS commented May 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Uh oh!

Copilot AI commented May 8, 2026

Uh oh!

dmitrivMS commented May 8, 2026

Uh oh!

dmitrivMS commented May 8, 2026

Uh oh!

Uh oh!

Copilot AI commented May 8, 2026

Uh oh!

Uh oh!

Copilot AI commented May 8, 2026

Uh oh!

dmitrivMS May 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 8, 2026

Choose a reason for hiding this comment

Uh oh!

dmitrivMS May 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 8, 2026

Choose a reason for hiding this comment

Uh oh!

dmitrivMS commented May 8, 2026

Uh oh!

RedCMD commented May 8, 2026

Uh oh!

Copilot AI commented May 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented May 8, 2026 •

edited

Loading