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

fix: typings of ctx.skip() as never #7608

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Conversation

sirlancelot
Copy link
Contributor

Since skip throws an error, its return type should be set to never so that TypeScript & linters can determine that this code path ends.

Description

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

Copy link

netlify bot commented Mar 4, 2025

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 55b7ef0
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/67c763d557860b0008c87cfb
😎 Deploy Preview https://deploy-preview-7608--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.

Since `skip` throws an error, its return type should be set to `never` so that TypeScript & linters can determine that this code path ends.
Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this change come up in practice when writing test cases?

@sirlancelot
Copy link
Contributor Author

When I was writing a test that used skip() I didn't realize that it would terminate that code path, so I instead wrote return skip() to indicate that the code path is done. With a type signature of never I (as well TypeScript) would've known this already.

@AriPerkkio AriPerkkio changed the title Mark skip as never returning fix: typings of ctx.skip() as never Mar 7, 2025
@AriPerkkio AriPerkkio merged commit 09f3530 into vitest-dev:main Mar 7, 2025
13 checks passed
@sirlancelot sirlancelot deleted the patch-1 branch March 7, 2025 17:11
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.

2 participants