chore: standardize meta.url property

[MikeMcC399]

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

Issue

The eslint-plugin/require-meta-docs-url rule of eslint-plugin-eslint-plugin requires that the meta.docs.url property is populated.

Rules with no meta.docs.url property defined:

Rule document
assertion-before-screenshot
no-async-before
no-async-tests
no-force
no-pause

The following rule documents contain no detailed contents and instead refer to URLs on the Cypress documentation site:

Rule document	Links to
no-assigning-return-values	https://on.cypress.io/best-practices#Assigning-Return-Values
no-unnecessary-waiting	https://on.cypress.io/best-practices#Unnecessary-Waiting
unsafe-to-chain-command	https://docs.cypress.io/guides/core-concepts/retry-ability#Actions-should-be-at-the-end-of-chains-not-the-middle

This single rule document contains both detailed contents and a link to the corresponding Cypress documentation site best practices page:

Rule document	Links to
require-data-selectors	https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements

Documentation reference

According to the ESLint documentation Rule Structure:

• docs: (object) Properties often used for documentation generation and tooling. Required for core rules and optional for custom rules. Custom rules can include additional properties here as needed.

  • url: (string) Specifies the URL at which the full documentation can be accessed. Code editors often use this to provide a helpful link on highlighted rule violations.

Change

Implement the rule eslint-plugin/require-meta-docs-url using the pattern option to populate the meta.docs.url property consistently for all rules:

    "eslint-plugin/require-meta-docs-url": [
      "error",
      {
        "pattern": "https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/{{name}}.md"
      }
    ],

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

Checked that the links work. 👍🏻

[MikeMcC399]

@jennifer-shehane

Checked that the links work. 👍🏻

Thank you very much! It's always good to have a second pair of eyes to spot anything which slipped past my own checks!

[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 📦🚀