W3cubDocs

/Vitest

sequence

Type: { sequencer?, shuffle?, seed?, hooks?, setupFiles?, groupOrder }

Options for how tests should be sorted.

You can provide sequence options to CLI with dot notation:

npx vitest --sequence.shuffle --sequence.seed=1000

sequence.sequencer

Type: TestSequencerConstructor
Default: BaseSequencer

A custom class that defines methods for sharding and sorting. You can extend BaseSequencer from vitest/node, if you only need to redefine one of the sort and shard methods, but both should exist.

Sharding is happening before sorting, and only if --shard option is provided.

If sequencer.groupOrder is specified, the sequencer will be called once for each group and pool.

sequence.groupOrder

Type: number
Default: 0

Controls the order in which this project runs its tests when using multiple projects.

Projects with the same group order number will run together, and groups are run from lowest to highest.
If you don't set this option, all projects run in parallel.
If several projects use the same group order, they will run at the same time.

This setting only affects the order in which projects run, not the order of tests within a project. To control test isolation or the order of tests inside a project, use the isolate and sequence.sequencer options.

Example

Consider this example:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    projects: [
      {
        test: {
          name: 'slow',
          sequence: {
            groupOrder: 0,
          },
        },
      },
      {
        test: {
          name: 'fast',
          sequence: {
            groupOrder: 0,
          },
        },
      },
      {
        test: {
          name: 'flaky',
          sequence: {
            groupOrder: 1,
          },
        },
      },
    ],
  },
})

Tests in these projects will run in this order:

0. slow  |
          |> running together
 0. fast  |

 1. flaky |> runs after slow and fast alone

sequence.shuffle

Type: boolean | { files?, tests? }
Default: false
CLI: --sequence.shuffle, --sequence.shuffle=false

If you want files and tests to run randomly, you can enable it with this option, or CLI argument --sequence.shuffle.

Vitest usually uses cache to sort tests, so long-running tests start earlier, which makes tests run faster. If your files and tests run in random order, you will lose this performance improvement, but it may be useful to track tests that accidentally depend on another test run previously.

sequence.shuffle.files

Type: boolean
Default: false
CLI: --sequence.shuffle.files, --sequence.shuffle.files=false

Whether to randomize files, be aware that long running tests will not start earlier if you enable this option.

sequence.shuffle.tests

Type: boolean
Default: false
CLI: --sequence.shuffle.tests, --sequence.shuffle.tests=false

Whether to randomize tests.

sequence.concurrent

Type: boolean
Default: false
CLI: --sequence.concurrent, --sequence.concurrent=false

If you want tests to run in parallel, you can enable it with this option, or CLI argument --sequence.concurrent.

WARNING

When you run tests with sequence.concurrent and expect.requireAssertions set to true, you should use local expect instead of the global one. Otherwise, this may cause false negatives in some situations (#8469).

sequence.seed

Type: number
Default: Date.now()
CLI: --sequence.seed=1000

Sets the randomization seed, if tests are running in random order.

sequence.hooks

Type: 'stack' | 'list' | 'parallel'
Default: 'stack'
CLI: --sequence.hooks=<value>

Changes the order in which hooks are executed.

stack will order "after" hooks in reverse order, "before" hooks will run in the order they were defined
list will order all hooks in the order they are defined
parallel will run hooks in a single group in parallel (hooks in parent suites will still run before the current suite's hooks)

TIP

This option doesn't affect onTestFinished. It is always called in reverse order.

sequence.setupFiles

Type: 'list' | 'parallel'
Default: 'parallel'
CLI: --sequence.setupFiles=<value>

Changes the order in which setup files are executed.

list will run setup files in the order they are defined
parallel will run setup files in parallel