Search results
Plugins | Cypress Documentation. Plugins provide a way to support and extend the behavior of Cypress. Follow these instructions to submit your own plugin. Looking for the API docs? Check out our Plugins Guide or our API docs for writing a plugin. Preprocessors.
- API Docs
Plugins API . The setupNodeEvents function (or deprecated...
- Svelte Component Testing
Cypress Component Testing works out of the box with Vite,...
- React Component Testing
Cypress Component Testing works out of the box with Create...
- Plugins
Plugins enable you to tap into, modify, or extend the...
- API Docs
An ESLint plugin for projects using Cypress. Latest version: 3.4.0, last published: 19 days ago. Start using eslint-plugin-cypress in your project by running `npm i eslint-plugin-cypress`. There are 502 other projects in the npm registry using eslint-plugin-cypress.
Maintain clean and consistent code in Cypress tests. eslint-plugin-cypress provides linting rules tailored for Cypress best practices, catching potential errors and promoting code quality. This creates a framework that is more enjoyable to work in and much easier to maintain.
- Overview
- Usage
- Recommended configuration
- Disable rules
- Rules
- Chai and no-unused-expressions
- Contribution Guide
An ESLint plugin for your Cypress tests.
Note: If you installed ESLint globally then you must also install eslint-plugin-cypress globally.
Add an .eslintrc.json file to your cypress directory with the following:
You can add rules:
Use the recommended configuration and you can forego configuring plugins, rules, and env individually. See below for which rules are included.
You can disable specific rules per file, for a portion of a file, or for a single line.
Disable the cypress/no-unnecessary-waiting rule for the entire file by placing this at the start of the file:
Disable the cypress/no-unnecessary-waiting rule for only a portion of the file:
Disable the cypress/no-unnecessary-waiting rule for a specific line:
You can also disable a rule for the next line:
For more, see the ESLint rules documentation.
These rules enforce some of the best practices recommended for using Cypress.
Rules with a check mark (✅) are enabled by default while using the plugin:cypress/recommended config.
Using an assertion such as expect(value).to.be.true can fail the ESLint rule no-unused-expressions even though it's not an error in this case. To fix this, you can install and use eslint-plugin-chai-friendly.
In your .eslintrc.json:
To add a new rule:
•Fork and clone this repository
•Generate a new rule (a yeoman generator is available)
•Run yarn start or npm start
•Write test scenarios then implement logic
•Describe the rule in the generated docs file
Plugins enable you to tap into, modify, or extend the internal behavior of Cypress. Normally, as a user, all of your test code, your application, and Cypress commands are executed in the browser. But Cypress is also a Node process that plugins can use.
Nov 23, 2020 · Cypress benefits greatly from being part of the JavaScript and Node.js ecosystem. There are tons of plugins which you can just install via npm and use them within your tests. They expand functionality, add new commands, add missing features and so much more. Installing a Cypress plugin. Most Cypress plugins can be installed in 3 steps:
People also ask
How do I use Cypress (plugin-specific)?
How do I use a plugin in Cypress?
What are the best practices for using cypress?
What is ESLint-plugin-Cypress?
An ESLint plugin for your Cypress tests. Note: If you installed ESLint globally then you must also install eslint-plugin-cypress-best-practices globally.
