feat: add option to unsafe-to-chain-command rule to allow custom Cypress command linting

[passbyval]

Context

I was recently using Cypress Real Events in one of my projects, and I realized that the unsafe-to-chain-command rule wasn't triggering errors when using the library's custom Cypress functions. I thought it would be nice to have the ability to pass in additional methods to lint for when using this rule.

Summary

• Added methods option to allow for linting on custom Cypress commands
  • Takes in either a string or regex
• Refactored isRootCypress to use recursion instead of a while loop + mutation
• Added types via JSDoc TypeScript syntax
• Added appropriate test cases
• Utilized JSON Schema via ESLint's custom rule API

Usage

Users can now pass in methods to the rule like so:

"cypress/unsafe-to-chain-command": [
  "error",
  {
    "methods": [
      "realClick",
      /customHover/
    ]
  }
]

[CLAassistant]

All committers have signed the CLA.

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

[nagash77]

🎉 This PR is included in version 2.14.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀