feat: add --exclude CLI flag (#4279)

Namchee · sheremet-va · web-flow · commit f859efc0940f · 2023-12-19T14:53:26.000+01:00
Co-authored-by: Vladimir &lt;sleuths.slews0s@icloud.com&gt;
diff --git a/docs/guide/cli.md b/docs/guide/cli.md
@@ -100,6 +100,7 @@ Run only [benchmark](https://vitest.dev/guide/features.html#benchmarking-experim
 | `--inspect-brk` | Enables Node.js inspector with break |
 | `--bail <number>` | Stop test execution when given number of tests have failed |
 | `--retry <times>` | Retry the test specific number of times if it fails |
+| `--exclude <glob>` | Additional file globs to be excluded from test |
 | `--expand-snapshot-diff` | Show full diff when snapshot fails |
 | `--typecheck [options]` | Custom options for typecheck pool. If passed without options, enables typechecking |
 | `--typecheck.enabled` | Enable typechecking alongside tests (default: `false`) |
diff --git a/packages/vitest/src/node/cli.ts b/packages/vitest/src/node/cli.ts
@@ -57,6 +57,7 @@ cli
   .option('--bail <number>', 'Stop test execution when given number of tests have failed (default: 0)')
   .option('--retry <times>', 'Retry the test specific number of times if it fails (default: 0)')
   .option('--diff <path>', 'Path to a diff config that will be used to generate diff interface')
+  .option('--exclude <glob>', 'Additional file globs to be excluded from test')
   .option('--expand-snapshot-diff', 'Show full diff when snapshot fails')
   .option('--typecheck [options]', 'Custom options for typecheck pool')
   .option('--typecheck.enabled', 'Enable typechecking alongside tests (default: false)')
@@ -165,6 +166,11 @@ function normalizeCliOptions(argv: CliOptions): CliOptions {
   else
     delete argv.dir
 
+  if (argv.exclude) {
+    argv.cliExclude = toArray(argv.exclude)
+    delete argv.exclude
+  }
+
   if (argv.coverage) {
     const coverage = argv.coverage
     if (coverage.exclude)
diff --git a/packages/vitest/src/node/config.ts b/packages/vitest/src/node/config.ts
@@ -192,6 +192,9 @@ export function resolveConfig(
       resolved.server.deps![option] = resolved.deps[option] as any
   })
 
+  if (resolved.cliExclude)
+    resolved.exclude.push(...resolved.cliExclude)
+
   // vitenode will try to import such file with native node,
   // but then our mocker will not work properly
   if (resolved.server.deps.inline !== true) {
diff --git a/packages/vitest/src/types/config.ts b/packages/vitest/src/types/config.ts
@@ -752,9 +752,14 @@ export interface UserConfig extends InlineConfig {
    * Name of the project or projects to run.
    */
   project?: string | string[]
+
+  /**
+   * Additional exclude patterns
+   */
+  cliExclude?: string[]
 }
 
-export interface ResolvedConfig extends Omit<Required<UserConfig>, 'config' | 'filters' | 'browser' | 'coverage' | 'testNamePattern' | 'related' | 'api' | 'reporters' | 'resolveSnapshotPath' | 'benchmark' | 'shard' | 'cache' | 'sequence' | 'typecheck' | 'runner' | 'poolOptions' | 'pool'> {
+export interface ResolvedConfig extends Omit<Required<UserConfig>, 'config' | 'filters' | 'browser' | 'coverage' | 'testNamePattern' | 'related' | 'api' | 'reporters' | 'resolveSnapshotPath' | 'benchmark' | 'shard' | 'cache' | 'sequence' | 'typecheck' | 'runner' | 'poolOptions' | 'pool' | 'cliExclude'> {
   mode: VitestRunMode
 
   base?: string
@@ -776,6 +781,7 @@ export interface ResolvedConfig extends Omit<Required<UserConfig>, 'config' | 'f
   defines: Record<string, any>
 
   api?: ApiConfig
+  cliExclude?: string[]
 
   benchmark?: Required<Omit<BenchmarkUserOptions, 'outputFile'>> & Pick<BenchmarkUserOptions, 'outputFile'>
   shard?: {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/cli/fixtures/exclude/math.test.ts b/test/cli/fixtures/exclude/math.test.ts
@@ -0,0 +1,7 @@
+import { expect, test } from 'vitest'
+
+import { add } from './math'
+
+test('should add two numbers correctly', () => {
+  expect(add(1, 2)).toBe(3)
+})
diff --git a/test/cli/fixtures/exclude/math.ts b/test/cli/fixtures/exclude/math.ts
@@ -0,0 +1,3 @@
+export function add(a: number, b: number): number {
+  return a + b
+}
diff --git a/test/cli/fixtures/exclude/string.test.ts b/test/cli/fixtures/exclude/string.test.ts
@@ -0,0 +1,7 @@
+import { expect, test } from 'vitest'
+
+import { capitalize } from './string'
+
+test('should capitalize strings correctly', () => {
+  expect(capitalize('i Love Vitest')).toBe('I love vitest')
+})
diff --git a/test/cli/fixtures/exclude/string.ts b/test/cli/fixtures/exclude/string.ts
@@ -0,0 +1,3 @@
+export function capitalize(str: string): string {
+  return str.slice(0, 1).toUpperCase() + str.slice(1).toLowerCase()
+}
diff --git a/test/cli/fixtures/exclude/vitest.exclude.config.ts b/test/cli/fixtures/exclude/vitest.exclude.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    include: ['fixtures/exclude/*.test.ts'],
+  },
+})
diff --git a/test/cli/package.json b/test/cli/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "@vitest/test-cli",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "test": "vitest --exclude fixtures/exclude/**/string.test.ts"
+  },
+  "devDependencies": {
+    "vite": "latest",
+    "vitest": "workspace:*"
+  }
+}
diff --git a/test/cli/test/exclude.test.ts b/test/cli/test/exclude.test.ts
@@ -0,0 +1,17 @@
+import { expect, test } from 'vitest'
+
+import { runVitestCli } from '../../test-utils'
+
+test('should still test math.test.ts', async () => {
+  const { stderr, stdout } = await runVitestCli(
+    'run',
+    '--config',
+    'fixtures/exclude/vitest.exclude.config.ts',
+    '--exclude',
+    'fixtures/exclude/string.test.ts',
+  )
+
+  expect(stdout).toContain(`✓ fixtures/exclude/math.test.ts`)
+  expect(stdout).not.toContain(`string.test.ts`)
+  expect(stderr).toBe('')
+})
diff --git a/test/cli/vitest.config.ts b/test/cli/vitest.config.ts
@@ -0,0 +1,12 @@
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    include: ['test/**.test.ts'],
+    reporters: ['verbose'],
+    testTimeout: 60_000,
+    chaiConfig: {
+      truncateThreshold: 999,
+    },
+  },
+})

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export function add(a: number, b: number): number {`
	`2`	`+ return a + b`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export function capitalize(str: string): string {`
	`2`	`+ return str.slice(0, 1).toUpperCase() + str.slice(1).toLowerCase()`
	`3`	`+}`