vitest icon indicating copy to clipboard operation
vitest copied to clipboard

feat(runner)!: support `describe(..., { shuffle: boolean })` and inherit from parent suite

Open hi-ogawa opened this issue 1 year ago • 1 comments

Description

  • closes https://github.com/vitest-dev/vitest/issues/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 https://github.com/vitest-dev/vitest/issues/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

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

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

  • [x] 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

  • [x] Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

hi-ogawa avatar Oct 09 '24 09:10 hi-ogawa

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
Latest commit e9acfc5f567b07eb538630252f1d3a8f00383369
Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/6707583857cccd0008ca8fc4
Deploy Preview https://deploy-preview-6670--vitest-dev.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Oct 09 '24 09:10 netlify[bot]