feat(cli): add @bomb.sh/tab completions

docs/guide/cli.md

@@ -121,6 +121,49 @@ tests/test1.test.ts
 tests/test2.test.ts
 ```
 
+## Shell Autocompletions
+
+Vitest provides shell autocompletions for commands, options, and option values powered by [`@bomb.sh/tab`](https://github.com/bombshell-dev/tab).
+
+### Setup
+
+For permanent setup in zsh, add this to your `~/.zshrc`:
+
+```bash
+# Add to ~/.zshrc for permanent autocompletions (same can be done for other shells)
+source <(vitest complete zsh)
+```
+
+### Package Manager Integration
+
+`@bomb.sh/tab` integrates with [package managers](https://github.com/bombshell-dev/tab?tab=readme-ov-file#package-manager-completions). Autocompletions work when running vitest directly:
+
+::: code-group
+
+```bash [npm]
+npm vitest <Tab>
+```
+
+```bash [npm]
+npm exec vitest <Tab>
+```
+
+```bash [pnpm]
+pnpm vitest <Tab>
+```
+
+```bash [yarn]
+yarn vitest <Tab>
+```
+
+```bash [bun]
+bun vitest <Tab>
+```
+
+:::
+
+For package manager autocompletions, you should install [tab's package manager completions](https://github.com/bombshell-dev/tab?tab=readme-ov-file#package-manager-completions) separately.
+
 ## Options
 
 ::: tip

packages/vitest/LICENSE.md

@@ -57,6 +57,13 @@ Repository: git+https://github.com/antfu/install-pkg.git
 
 ---------------------------------------
 
+## @bomb.sh/tab
+License: MIT
+By: Bombshell Authors
+Repository: git+https://github.com/bombshell-dev/tab.git
+
+---------------------------------------
+
 ## @jridgewell/resolve-uri
 License: MIT
 By: Justin Ridgewell

packages/vitest/package.json

@@ -192,6 +192,7 @@
   },
   "devDependencies": {
     "@antfu/install-pkg": "^1.1.0",
+    "@bomb.sh/tab": "^0.0.9",
     "@edge-runtime/vm": "^5.0.0",
     "@jridgewell/trace-mapping": "catalog:",
     "@opentelemetry/api": "^1.9.0",

packages/vitest/src/node/cli/cac.ts

@@ -8,6 +8,7 @@ import { normalize } from 'pathe'
 import c from 'tinyrainbow'
 import { version } from '../../../package.json' with { type: 'json' }
 import { benchCliOptionsConfig, cliOptionsConfig, collectCliOptionsConfig } from './cli-config'
+import { setupTabCompletions } from './completions'
 
 function addCommand(cli: CAC | Command, name: string, option: CLIOption<any>) {
   const commandName = option.alias || name
@@ -195,6 +196,7 @@ export function createCLI(options: CliParseOptions = {}): CAC {
     .command('[...filters]', undefined, options)
     .action((filters, options) => start('test', filters, options))
 
+  setupTabCompletions(cli)
   return cli
 }
 

packages/vitest/src/node/cli/completions.ts

@@ -0,0 +1,56 @@
+import type { CAC } from 'cac'
+import tab from '@bomb.sh/tab/cac'
+
+export async function setupTabCompletions(cli: CAC): Promise<void> {
+  await tab(cli, {
+    subCommands: {},
+    options: {
+      environment(complete) {
+        complete('node', 'Node.js environment')
+        complete('jsdom', 'JSDOM environment')
+        complete('happy-dom', 'Happy DOM environment')
+        complete('edge-runtime', 'Edge runtime environment')
+      },
+      pool(complete) {
+        complete('threads', 'Threads pool')
+        complete('forks', 'Forks pool')
+        complete('vmThreads', 'VM threads pool')
+        complete('vmForks', 'VM forks pool')
+      },
+      reporter(complete) {
+        complete('default', 'Default reporter')
+        complete('verbose', 'Verbose reporter')
+        complete('dot', 'Dot reporter')
+        complete('json', 'JSON reporter')
+        complete('junit', 'JUnit reporter')
+        complete('html', 'HTML reporter')
+        complete('tap', 'TAP reporter')
+        complete('tap-flat', 'TAP flat reporter')
+        complete('hanging-process', 'Hanging process reporter')
+      },
+      'coverage.reporter': function (complete) {
+        complete('text', 'Text coverage reporter')
+        complete('html', 'HTML coverage reporter')
+        complete('clover', 'Clover coverage reporter')
+        complete('json', 'JSON coverage reporter')
+        complete('json-summary', 'JSON summary coverage reporter')
+        complete('lcov', 'LCOV coverage reporter')
+        complete('lcovonly', 'LCOV only coverage reporter')
+        complete('teamcity', 'TeamCity coverage reporter')
+        complete('cobertura', 'Cobertura coverage reporter')
+      },
+      'browser.name': function (complete) {
+        complete('chromium', 'Chromium')
+        complete('firefox', 'Mozilla Firefox')
+        complete('safari', 'Safari')
+        complete('chrome', 'Google Chrome')
+        complete('edge', 'Microsoft Edge')
+      },
+      silent(complete) {
+        complete('true', 'Enable silent mode')
+        complete('false', 'Disable silent mode')
+        complete('passed-only', 'Show logs from failing tests only')
+      },
+    },
+  })
+}