chore: add meta.type to rules

[MikeMcC399]

• supports resolution of issue Provide meta prerequisites for automatic document generation #184

Issue

The plugin:eslint-plugin/recommended rules of eslint-plugin-eslint-plugin include the eslint-plugin/require-meta-type rule. This rule currently fails for all of the Cypress rules if enabled, since none of these has a meta.type defined.

Documentation reference

According to the ESLint documentation Rule Structure:

meta: (object) Contains metadata for the rule:

• type: (string) Indicates the type of rule, which is one of "problem", "suggestion", or "layout":

  • "problem": The rule is identifying code that either will cause an error or may cause a confusing behavior. Developers should consider this a high priority to resolve.
  • "suggestion": The rule is identifying something that could be done in a better way but no errors will occur if the code isn't changed.
  • "layout": The rule cares primarily about whitespace, semicolons, commas, and parentheses, all the parts of the program that determine how the code looks rather than how it executes. These rules work on parts of the code that aren't specified in the AST.

Changes

Add meta.type to all rules and enable the rule eslint-plugin/require-meta-type.

Rule ID	Description	Type
assertion-before-screenshot	Ensure screenshots are preceded by an assertion	problem
no-assigning-return-values	Prevent assigning return values of cy calls	problem
no-unnecessary-waiting	Prevent waiting for arbitrary time periods	problem
no-async-before	Prevent using async/await in Cypress test case	problem
no-async-tests	Prevent using async/await in Cypress test case	problem
unsafe-to-chain-command	Prevent chaining from unsafe to chain commands	problem
no-force	Disallow using force: true with action commands	suggestion
no-pause	Disallow cy.pause() parent command	suggestion
require-data-selectors	Only allow data-* attribute selectors (require-data-selectors)	suggestion

[cypress-app-bot]

• 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.

[jennifer-shehane]

Looks good. Thanks for adding this.

[cypress-app-bot]

🎉 This PR is included in version 3.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀