ci: cause skipped tests linting error

MikeMcC399 commented 5 months ago

Issue

eslint-plugin-mocha is configured inconsistently in this repo regarding the rules:

mocha/no-exclusive-tests to warn about the use of describe.only, it.only, etc. - configured to error
mocha/no-skipped-tests to warn about the use of describe.skip, it.skip, etc. - configured per plugin:mocha/recommended for warn only (see Rules table) for this plugin.

Since it is undesirable to have .only or .skip in the example test specs, both should be configured to error on linting.

Change

Add mocha/no-skipped-tests error to the configuration in .eslintrc.

 "rules": {
    ...
    "mocha/no-skipped-tests": "error",
    ...
  }

Verification

Temporarily modify the file cypress/e2e/2-advanced-examples/actions.cy.js to add an exclusive test and a skipped test:

Change context to context.only
Change the first occurence of it to it.skip

and execute:

npm ci
npx eslint cypress

confirm that linting errors (no warnings) are reported:

$ npx eslint cypress

   3:9  error  Unexpected exclusive mocha test  mocha/no-exclusive-tests
  10:6  error  Unexpected skipped mocha test    mocha/no-skipped-tests

✖ 2 problems (2 errors, 0 warnings)

cypress-app-bot commented 5 months ago

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

cypress-app-bot commented 5 months ago

:tada: This PR is included in version 2.0.7 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

cypress-io / cypress-example-kitchensink