Merge pull request #192 from MikeMcC399/update/meta-description

chore: standardize meta.docs.description property

Author: jennifer-shehane

.eslintrc.json

@@ -21,6 +21,7 @@
         "pattern": "https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/{{name}}.md"
       }
     ],
+    "eslint-plugin/require-meta-docs-description": "error",
     "n/no-extraneous-require": [
       "error",
       {

lib/rules/assertion-before-screenshot.js

@@ -18,7 +18,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Assert on the page state before taking a screenshot, so the screenshot is consistent',
+      description: 'require screenshots to be preceded by an assertion',
       category: 'Possible Errors',
       recommended: false,
       url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/assertion-before-screenshot.md',

lib/rules/no-assigning-return-values.js

@@ -19,7 +19,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Prevent assigning return values of cy calls',
+      description: 'disallow assigning return values of `cy` calls',
       category: 'Possible Errors',
       recommended: true,
       url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-assigning-return-values.md',

lib/rules/no-async-before.js

@@ -4,7 +4,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Prevent using async/await in Cypress before methods',
+      description: 'disallow 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',

lib/rules/no-async-tests.js

@@ -4,7 +4,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Prevent using async/await in Cypress test cases',
+      description: 'disallow 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',

lib/rules/no-force.js

@@ -8,7 +8,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'Disallow using of \'force: true\' option for click and type calls',
+      description: 'disallow using `force: true` with action commands',
       category: 'Possible Errors',
       recommended: false,
       url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-force.md',

lib/rules/no-pause.js

@@ -8,7 +8,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'Disallow using of \'cy.pause\' calls',
+      description: 'disallow using `cy.pause()` calls',
       category: 'Possible Errors',
       recommended: false,
       url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-pause.md',

lib/rules/no-unnecessary-waiting.js

@@ -4,7 +4,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Prevent waiting for arbitrary time periods',
+      description: 'disallow waiting for arbitrary time periods',
       category: 'Possible Errors',
       recommended: true,
       url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-unnecessary-waiting.md',

lib/rules/require-data-selectors.js

@@ -4,7 +4,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'Use data-* attributes to provide context to your selectors and insulate them from CSS or JS changes',
+      description: 'require `data-*` attribute selectors',
       category: 'Possible Errors',
       recommended: false,
       url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/require-data-selectors.md',

lib/rules/unsafe-to-chain-command.js

@@ -3,7 +3,7 @@
 const { basename } = require('path')
 
 const NAME = basename(__dirname)
-const DESCRIPTION = 'Actions should be in the end of chains, not in the middle'
+const DESCRIPTION = 'disallow actions within chains'
 
 /**
  * Commands listed in the documentation with text: 'It is unsafe to chain further commands that rely on the subject after xxx.'