feat(runner)!: support `describe(..., { shuffle: boolean })` and inherit from parent suite by hi-ogawa · Pull Request #6670 · vitest-dev/vitest (original) (raw)

Description

closes Run tests NOT in random order - unshuffle #3922

This PR adds TestOptions.shuffle to allow "unshuffling" by describe("...", { shuffle: false }).

I noticed that describe.shuffle is not inherited to inner suites now, but probably changing this behavior would make sense to align with how concurrent works, so this change will be breaking.

One thing to note, when using config.sequence.shuffle: true, it's already shuffling all tests (as complained in #3922), so this use case is unchanged. What's breaking is when using describe.shuffle and using normal describe inside like in test/core/test/random.test.ts.

todo

should we hide types for test("..", { shuffle: boolean })?
test
docs

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
Ideally, include a test that fails without this PR but passes with it.
Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

Run the tests with pnpm test:ci.

Documentation

If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets