https://github.com/bahmutov/cypress-catch-async-tests
Prevents accidentally passing an async function as the test callback in Cypress
https://github.com/bahmutov/cypress-catch-async-tests
cypress-plugin
Last synced: 10 months ago
JSON representation
Prevents accidentally passing an async function as the test callback in Cypress
- Host: GitHub
- URL: https://github.com/bahmutov/cypress-catch-async-tests
- Owner: bahmutov
- Created: 2022-09-09T11:04:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-09T11:51:50.000Z (almost 4 years ago)
- Last Synced: 2024-12-27T20:13:37.396Z (over 1 year ago)
- Topics: cypress-plugin
- Language: JavaScript
- Homepage:
- Size: 170 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cypress-catch-async-tests  [](https://github.com/bahmutov/cypress-catch-async-tests/actions/workflows/ci.yml)
> Prevents accidentally passing an async function as the test callback in Cypress
- 📺 [Catch Accidental Async Callbacks In Cypress Tests](https://youtu.be/3RyqCv_TlE8)
## Install
Add this plugin as a dev dependency
```shell
$ npm i -D cypress-catch-async-tests
# or if using Yarn
$ yarn add -D cypress-catch-async-tests
```
## Use
Import this plugin from your support file or spec file before any tests
```js
import 'cypress-catch-async-tests'
it('works', () => { ... })
// this test will generate an error right away
it('async callback', async () => { ... })
```
## See also
- example repo [cypress-catch-async-tests-example](https://github.com/bahmutov/cypress-catch-async-tests-example)
- Cypress issue [#4742](https://github.com/cypress-io/cypress/issues/4742)
- [Visualize Cypress Command Queue](https://glebbahmutov.com/blog/visualize-cypress-command-queue/) blog post
## Small print
Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2022
- [@bahmutov](https://twitter.com/bahmutov)
- [glebbahmutov.com](https://glebbahmutov.com)
- [blog](https://glebbahmutov.com/blog)
- [videos](https://www.youtube.com/glebbahmutov)
- [presentations](https://slides.com/bahmutov)
- [cypress.tips](https://cypress.tips)
- [Cypress Tips & Tricks Newsletter](https://cypresstips.substack.com/)
- [my Cypress courses](https://cypress.tips/courses)
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
[open issue](https://github.com/bahmutov/cypress-catch-async-tests/issues) on Github
## MIT License
Copyright (c) 2022 Gleb Bahmutov <gleb.bahmutov@gmail.com>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.