cypress-io / code-coverage

Saves the code coverage collected during Cypress tests

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Installation instructions only for legacy Cypress 9.x and lower

MikeMcC399 opened this issue ยท comments

Issue

The installation instructions in the README > Install section refer to:

Add to your cypress/support/index.js file

Register tasks in your cypress/plugins/index.js file

The above files are for Cypress legacy configurations with version 9.x and lower.

These files are also referred to in other parts of the README document.

Suggestion

  1. The installation section README > Install should be updated to cover installation on Cypress current configuration versions 10.x and later. These are already included on https://docs.cypress.io/guides/tooling/code-coverage#Install-the-plugin.

  2. If Cypress legacy configurations with version 9.x are still supported by the current version of @cypress/code-coverage then the old installation instructions could be left in, otherwise they should be removed and replaced by a note to the effect that 9.x and earlier are no longer supported.

  3. Update the remaining sections of the document accordingly.

Cypress 10.x migration guide

The Cypress 10 Migration Guide describes the relevant changes:

๐ŸŽ‰ This issue has been resolved in version 3.12.13 ๐ŸŽ‰

The release is available on:

Your semantic-release bot ๐Ÿ“ฆ๐Ÿš€