feat: support switching to a known user

[sean-roberts]

🎉 Thanks for submitting a pull request! 🎉

Summary

When using netlify switch we should be able to pass an email to auto select if it's in the list. This allows users to quickly go into the known accounts that they have instead of the default which is an interactive selection experience.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4475d007-1636-49a1-b33a-c95b2605884e

📥 Commits

Reviewing files that changed from the base of the PR and between ecad52d and 09c6925.

📒 Files selected for processing (1)

• src/commands/switch/switch.ts

🚧 Files skipped from review as they are similar to previous changes (1)

• src/commands/switch/switch.ts

---

📝 Walkthrough

Summary by CodeRabbit

• New Features

  • Added a --email option to the switch command to auto-select an account by email, falling back to the interactive prompt if no exact match is found.

• Tests

  • Added unit tests for exact and partial email matches, prompt fallback, and triggering login when choosing a new account.

• Documentation

  • Documented the new email flag in the switch command docs.

Walkthrough

Adds a new --email <email> option to the switch command. The command now accepts options (removed the unused underscore) and, when --email is provided, attempts to match the given email (exact or partial) against stored accounts; on a match it sets userId in global config and logs confirmation, otherwise it logs that no account matched and falls back to the interactive account-selection prompt. Unit tests for exact, partial, no-match, interactive selection, and login-new flows were added. Documentation updated to document the new flag.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title 'feat: support switching to a known user' accurately reflects the main change: adding email-based account switching functionality.
Description check	✅ Passed	The PR description clearly explains the feature: allowing users to pass an email to auto-select accounts instead of using interactive selection.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch sr/switcher

📝 Coding Plan

• Generate coding plan for human review comments

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

📊 Benchmark results

Comparing with 7a1c8fa

• Dependency count: 1,063 ⬆️ 0.19% increase vs. 7a1c8fa
• Package size: 354 MB ⬆️ 0.01% increase vs. 7a1c8fa
• Number of ts-expect-error directives: 357 ⬇️ 0.84% decrease vs. 7a1c8fa

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

tests/unit/commands/switch/switch.test.ts (1)

60-68: Strengthen fallback-path assertion.

This test checks log/prompt behavior, but it should also assert that the selected account was persisted (userId set to user-2) to fully validate the fallback flow.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@tests/unit/commands/switch/switch.test.ts` around lines 60 - 68, The test
should also assert the fallback flow persisted the chosen account: after calling
switchCommand (using createCommand, mockPrompt and logMessages), add an
expectation that the persisted userId equals 'user-2' (use the same
test-accessible persistence accessor used elsewhere in tests — e.g., the
returned command/config/store from createCommand or the mock persistence helper)
to confirm the selected account was saved.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/commands/switch/switch.ts`:
- Around line 18-27: The current options.email handling auto-switches on the
first substring match and can choose the wrong account when multiple entries
match; modify the logic around matchedAccount (found from
Object.entries(availableUsersChoices)) to detect if more than one entry matches
options.email and, in that case, do not auto-switch: instead present an
ambiguity error or prompt the user to pick (or list the matching labels),
otherwise continue to set the userId via command.netlify.globalConfig.set using
the single unambiguous match; ensure you reference options.email,
availableUsersChoices, matchedAccount, and command.netlify.globalConfig.set when
updating this behavior.

In `@tests/unit/commands/switch/switch.test.ts`:
- Line 53: The tests call switchCommand with a mocked command object typed as
any, violating the no-unsafe-argument rule; update the mock to satisfy the
switchCommand signature by replacing `command as any` with a properly typed mock
of BaseCommand (either construct a mock object that implements BaseCommand or
cast a typed mock variable to BaseCommand), ensuring methods/properties used by
switchCommand (e.g., any invoked methods or properties on the mock) are present;
apply this change to all switchCommand calls in the test so linting passes
without using `any`.

---

Nitpick comments:
In `@tests/unit/commands/switch/switch.test.ts`:
- Around line 60-68: The test should also assert the fallback flow persisted the
chosen account: after calling switchCommand (using createCommand, mockPrompt and
logMessages), add an expectation that the persisted userId equals 'user-2' (use
the same test-accessible persistence accessor used elsewhere in tests — e.g.,
the returned command/config/store from createCommand or the mock persistence
helper) to confirm the selected account was saved.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a9c4e2a1-9540-4d10-9740-263946083b66

📥 Commits

Reviewing files that changed from the base of the PR and between 37b2cff and 84d36e3.

📒 Files selected for processing (3)

• src/commands/switch/index.ts
• src/commands/switch/switch.ts
• tests/unit/commands/switch/switch.test.ts

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

tests/unit/commands/switch/switch.test.ts (1)

60-68: Assert the fallback path actually updates userId.

This test confirms prompt invocation, but it doesn’t validate the final state change after selection. Add an assertion for globalConfig.set('userId', ...) so the fallback flow is fully covered.

Suggested test tightening

-  test('--email falls through to prompt when no match is found', async () => {
-    const { command } = createCommand()
+  test('--email falls through to prompt when no match is found', async () => {
+    const { command, mockSet } = createCommand()
     mockPrompt.mockResolvedValueOnce({ accountSwitchChoice: 'Bob (bob@corp.com)' })

     await switchCommand({ email: 'nobody@example.com' }, command)

     expect(logMessages.some((m) => m.includes('No account found matching'))).toBe(true)
     expect(mockPrompt).toHaveBeenCalled()
+    expect(mockSet).toHaveBeenCalledWith('userId', 'user-2')
   })

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@tests/unit/commands/switch/switch.test.ts` around lines 60 - 68, The test for
the fallback prompt path should also assert that the selected account actually
updates globalConfig; after calling switchCommand({ email: 'nobody@example.com'
}, command) and mocking the prompt (mockPrompt.mockResolvedValueOnce({
accountSwitchChoice: 'Bob (bob@corp.com)' })), add an expectation that
globalConfig.set was called to update 'userId' to the selected account's id
(e.g., expect(globalConfig.set).toHaveBeenCalledWith('userId', expectedUserId));
locate this in the same test that references switchCommand, mockPrompt and
logMessages and derive expectedUserId from the test fixtures or the mapping used
by the code under test.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/commands/switch.md`:
- Line 21: The docs claim `email` but don't state matching semantics while
src/commands/switch/switch.ts currently does substring matching with .includes
and picks the first hit; update behavior to perform exact matching instead: in
switch.ts replace the .includes check on the account email with a strict
equality comparison (===) and prefer the exact match when selecting the target
account (e.g., find(account => account.email === email)), optionally falling
back to the previous substring-first behavior only if no exact match is found;
alternatively, if you prefer to keep substring semantics, update
docs/commands/switch.md to explicitly state that `email` is matched as a
substring and the first match is selected, referencing the `email` parameter and
the matching logic in switch.ts.

In `@tests/unit/commands/switch/switch.test.ts`:
- Around line 70-77: The test " --email matches partial email strings" currently
passes a partial email ('bob@corp') to switchCommand which encourages substring
auto-selection; change the test to use a full exact email string (e.g., the
exact email used in fixtures) or change expectations to require a prompt on
ambiguity: invoke switchCommand with the exact email to assert
mockSet('userId','user-2') and mockPrompt not called, or keep the partial email
but assert that mockPrompt is called (and mockSet not called) to enforce
prompt-on-ambiguous-match behavior; update the test name accordingly and
reference switchCommand, mockSet and mockPrompt in your change.

---

Nitpick comments:
In `@tests/unit/commands/switch/switch.test.ts`:
- Around line 60-68: The test for the fallback prompt path should also assert
that the selected account actually updates globalConfig; after calling
switchCommand({ email: 'nobody@example.com' }, command) and mocking the prompt
(mockPrompt.mockResolvedValueOnce({ accountSwitchChoice: 'Bob (bob@corp.com)'
})), add an expectation that globalConfig.set was called to update 'userId' to
the selected account's id (e.g.,
expect(globalConfig.set).toHaveBeenCalledWith('userId', expectedUserId)); locate
this in the same test that references switchCommand, mockPrompt and logMessages
and derive expectedUserId from the test fixtures or the mapping used by the code
under test.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6b3f72a3-3bae-46a6-a2c9-677f782e1dcc

📥 Commits

Reviewing files that changed from the base of the PR and between 84d36e3 and 70ef776.

📒 Files selected for processing (2)

• docs/commands/switch.md
• tests/unit/commands/switch/switch.test.ts

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

src/commands/switch/switch.ts (1)

38-39: ⚠️ Potential issue | 🔴 Critical

Remove the unused @ts-expect-error directive to fix the pipeline failure.

The TypeScript compiler reports this directive is unnecessary. The choices array type is now correctly inferred.

Proposed fix

     {
       type: 'list',
       name: 'accountSwitchChoice',
       message: 'Please select the account you want to use:',
-      // `@ts-expect-error` TS(2769) FIXME: No overload matches this call.
       choices: [...Object.entries(availableUsersChoices).map(([, val]) => val), LOGIN_NEW],
     },

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/commands/switch/switch.ts` around lines 38 - 39, Remove the unnecessary
TypeScript suppression placed above the choices assignment: delete the line
containing "// `@ts-expect-error` TS(2769) FIXME: No overload matches this call."
and keep the existing choices expression as-is (choices:
[...Object.entries(availableUsersChoices).map(([, val]) => val), LOGIN_NEW]).
This removes the unused directive and lets the compiler use the now-correctly
inferred type for choices while preserving use of availableUsersChoices and
LOGIN_NEW.

🧹 Nitpick comments (1)

src/commands/switch/switch.ts (1)

46-54: Consider using a type guard to avoid the @ts-expect-error directives.

The selectedAccount lookup could theoretically return undefined. While unlikely in practice (since the choice comes from the same list), using a guard would satisfy TypeScript and remove the suppression comments.

Proposed refactor

   } else {
-    // `@ts-expect-error` TS(2769) FIXME: No overload matches this call.
     const selectedAccount = Object.entries(availableUsersChoices).find(
       ([, availableUsersChoice]) => availableUsersChoice === accountSwitchChoice,
     )
-    // `@ts-expect-error` TS(2532) FIXME: Object is possibly 'undefined'.
-    command.netlify.globalConfig.set('userId', selectedAccount[0])
-    log('')
-    // `@ts-expect-error` TS(2532) FIXME: Object is possibly 'undefined'.
-    log(`You're now using ${chalk.bold(selectedAccount[1])}.`)
+    if (selectedAccount) {
+      command.netlify.globalConfig.set('userId', selectedAccount[0])
+      log('')
+      log(`You're now using ${chalk.bold(selectedAccount[1])}.`)
+    }
   }

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/commands/switch/switch.ts` around lines 46 - 54, selectedAccount (result
of Object.entries(availableUsersChoices).find(...)) can be undefined, so remove
the `@ts-expect-error` markers and add a type guard: check if selectedAccount is
undefined before using it; if undefined, log an error and return (or throw) to
avoid calling command.netlify.globalConfig.set or accessing
selectedAccount[0]/[1]; otherwise proceed to set('userId', selectedAccount[0])
and log the success message with chalk.bold(selectedAccount[1]). Ensure the
guard is placed immediately after computing selectedAccount so TypeScript can
narrow its type for subsequent uses.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@src/commands/switch/switch.ts`:
- Around line 38-39: Remove the unnecessary TypeScript suppression placed above
the choices assignment: delete the line containing "// `@ts-expect-error` TS(2769)
FIXME: No overload matches this call." and keep the existing choices expression
as-is (choices: [...Object.entries(availableUsersChoices).map(([, val]) => val),
LOGIN_NEW]). This removes the unused directive and lets the compiler use the
now-correctly inferred type for choices while preserving use of
availableUsersChoices and LOGIN_NEW.

---

Nitpick comments:
In `@src/commands/switch/switch.ts`:
- Around line 46-54: selectedAccount (result of
Object.entries(availableUsersChoices).find(...)) can be undefined, so remove the
`@ts-expect-error` markers and add a type guard: check if selectedAccount is
undefined before using it; if undefined, log an error and return (or throw) to
avoid calling command.netlify.globalConfig.set or accessing
selectedAccount[0]/[1]; otherwise proceed to set('userId', selectedAccount[0])
and log the success message with chalk.bold(selectedAccount[1]). Ensure the
guard is placed immediately after computing selectedAccount so TypeScript can
narrow its type for subsequent uses.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7c7cfaec-a4db-431b-9fbb-aafae9070c08

📥 Commits

Reviewing files that changed from the base of the PR and between 70ef776 and ecad52d.

📒 Files selected for processing (2)

• src/commands/switch/switch.ts
• tests/unit/commands/switch/switch.test.ts

🚧 Files skipped from review as they are similar to previous changes (1)

• tests/unit/commands/switch/switch.test.ts