Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow configuring expect options in the config #5729

Merged
merged 6 commits into from
May 31, 2024

Conversation

sheremet-va
Copy link
Member

@sheremet-va sheremet-va commented May 15, 2024

Description

This PR adds an expect option to the root config and CLI:

/**
 * Configuration options for expect() matches.
 */
expect?: {
  /**
   * Throw an error if tests don't have any expect() assertions.
   */
  requireAssertions?: boolean
  /**
   * Default options for expect.poll()
   */
  poll?: {
    /**
     * Timeout in milliseconds
     * @default 1000
     */
    timeout?: number
    /**
     * Polling interval in milliseconds
     * @default 50
     */
    interval?: number
  }
}

Related: #5361

TODO

  • Docs
  • Tests (including browser support)

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

  • 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:.

@sheremet-va sheremet-va merged commit fc53f56 into vitest-dev:main May 31, 2024
15 of 16 checks passed
@sheremet-va sheremet-va deleted the feat/add-expect-optons branch May 31, 2024 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant