Merge pull request #188 from MikeMcC399/update/meta-url

chore: standardize meta.url property
cypress-io · Apr 24, 2024 · 131d3a7 · 131d3a7
2 parents 5c1b59a + 8071dd8
commit 131d3a7
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 5 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -15,6 +15,12 @@
     "plugin:mocha/recommended"
   ],
   "rules": {
+    "eslint-plugin/require-meta-docs-url": [
+      "error",
+      {
+        "pattern": "https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/{{name}}.md"
+      }
+    ],
     "n/no-extraneous-require": [
       "error",
       {

diff --git a/lib/rules/assertion-before-screenshot.js b/lib/rules/assertion-before-screenshot.js
@@ -21,6 +21,7 @@ module.exports = {
       description: 'Assert on the page state before taking a screenshot, so the screenshot is consistent',
       category: 'Possible Errors',
       recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/assertion-before-screenshot.md',
     },
     schema: [],
     messages: {

diff --git a/lib/rules/no-assigning-return-values.js b/lib/rules/no-assigning-return-values.js
@@ -22,7 +22,7 @@ module.exports = {
       description: 'Prevent assigning return values of cy calls',
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://on.cypress.io/best-practices#Assigning-Return-Values',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-assigning-return-values.md',
     },
     schema: [],
     messages: {

diff --git a/lib/rules/no-async-before.js b/lib/rules/no-async-before.js
@@ -7,6 +7,7 @@ module.exports = {
       description: 'Prevent using async/await in Cypress before methods',
       category: 'Possible Errors',
       recommended: true,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-before.md',
     },
     schema: [],
     messages: {

diff --git a/lib/rules/no-async-tests.js b/lib/rules/no-async-tests.js
@@ -7,6 +7,7 @@ module.exports = {
       description: 'Prevent using async/await in Cypress test cases',
       category: 'Possible Errors',
       recommended: true,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-tests.md',
     },
     schema: [],
     messages: {

diff --git a/lib/rules/no-force.js b/lib/rules/no-force.js
@@ -11,6 +11,7 @@ module.exports = {
       description: 'Disallow using of \'force: true\' option for click and type calls',
       category: 'Possible Errors',
       recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-force.md',
     },
     fixable: null, // or "code" or "whitespace"
     schema: [],

diff --git a/lib/rules/no-pause.js b/lib/rules/no-pause.js
@@ -11,6 +11,7 @@ module.exports = {
       description: 'Disallow using of \'cy.pause\' calls',
       category: 'Possible Errors',
       recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-pause.md',
     },
     fixable: null, // or "code" or "whitespace"
     schema: [],

diff --git a/lib/rules/no-unnecessary-waiting.js b/lib/rules/no-unnecessary-waiting.js
@@ -7,7 +7,7 @@ module.exports = {
       description: 'Prevent waiting for arbitrary time periods',
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://on.cypress.io/best-practices#Unnecessary-Waiting',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-unnecessary-waiting.md',
     },
     schema: [],
     messages: {

diff --git a/lib/rules/require-data-selectors.js b/lib/rules/require-data-selectors.js
@@ -4,10 +4,10 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'Use data-* attributes to provide context to your selectors and insulate them from CSS or JS changes https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements',
+      description: 'Use data-* attributes to provide context to your selectors and insulate them from CSS or JS changes',
       category: 'Possible Errors',
       recommended: false,
-      url: 'https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/require-data-selectors.md',
     },
     schema: [],
     messages: {

diff --git a/lib/rules/unsafe-to-chain-command.js b/lib/rules/unsafe-to-chain-command.js
@@ -74,7 +74,7 @@ module.exports = {
       description: DESCRIPTION,
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://docs.cypress.io/guides/core-concepts/retry-ability#Actions-should-be-at-the-end-of-chains-not-the-middle',
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/unsafe-to-chain-command.md',
     },
     schema: [schema],
     messages: {