feat: set flag from plugins task that they were registered #180
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BREAKING CHANGE: the task sets an environment variable and needs
to return its config. The new registration thus looks like this
```js
// your plugins file
module.exports = (on, config) => {
require('cypress/code-coverage/task')(on, config)
// IMPORTANT to return the config object
// with the any changed environment variables
return config
}
```
Support code can check variable `Cypress.env('codeCoverageTasksRegistered')`
before calling `cy.task`
|
🎉 This PR is included in version 3.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
rndmerle
pushed a commit
to rndmerle/code-coverage
that referenced
this pull request
Apr 25, 2020
…o#180) * feat: set flag from plugins task that they were registered BREAKING CHANGE: the task sets an environment variable and needs to return its config. The new registration thus looks like this ```js // your plugins file module.exports = (on, config) => { require('cypress/code-coverage/task')(on, config) // IMPORTANT to return the config object // with the any changed environment variables return config } ``` Support code can check variable `Cypress.env('codeCoverageTasksRegistered')` before calling `cy.task` * update readme * update examples * add small plugins file * update readme * add example using plugins and support * add new example to CI * no need to start server in the example
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To avoid support hooks "blindly" trying to call
cy.task('resetCoverage')and other hooks if the plugins has never registered themBREAKING CHANGE: the task sets an environment variable and needs
to return its config. The new registration thus looks like this
Support code can check variable
Cypress.env('codeCoverageTasksRegistered')before calling
cy.taskcloses #179
Related
To disable any code coverage actions, set environment variable
coverage: falseincypress.jsonor via environment variable or via CLI