eslint-plugin-cypress 3.0.1 → 3.0.2

package/.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",
       {
@@ -34,6 +35,6 @@
     "mocha/no-setup-in-describe": "off"
   },
   "parserOptions": {
-    "ecmaVersion": 2018
+    "ecmaVersion": 2020
   }
 }

package/docs/rules/no-async-before.md

@@ -1,6 +1,6 @@
 # Prevent using async/await in Cypress test cases (no-async-tests)
 
-Cypress commands that return a promise may cause side effects in before/beforeEach hooks, possibly causing unexpected behavior. 
+Cypress commands that return a promise may cause side effects in before/beforeEach hooks, possibly causing unexpected behavior.
 
 ## Rule Details
 
@@ -47,6 +47,5 @@ If there are genuine use-cases for using `async/await` in your before then you m
 
 ## Further Reading
 
-- [Commands Are Asynchronous](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)
-- [Commands Are Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Promises)
-- [Commands Are Not Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Not-Promises)
+- [Mixing Async and Sync code](https://on.cypress.io/guides/core-concepts/introduction-to-cypress#Mixing-Async-and-Sync-code)
+- [Commands Are Asynchronous](https://on.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)

package/docs/rules/no-async-tests.md

@@ -47,6 +47,5 @@ If there are genuine use-cases for using `async/await` in your test cases then y
 
 ## Further Reading
 
-- [Commands Are Asynchronous](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)
-- [Commands Are Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Promises)
-- [Commands Are Not Promises](https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Not-Promises)
+- [Mixing Async and Sync code](https://on.cypress.io/guides/core-concepts/introduction-to-cypress#Mixing-Async-and-Sync-code)
+- [Commands Are Asynchronous](https://on.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous)

package/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',

package/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',

package/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',
@@ -28,11 +28,14 @@ module.exports = {
                 && node.arguments.length >= 2
                 && node.arguments[1].async === true
     }
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
 
     return {
       Identifier (node) {
         if (node.name === 'cy' || node.name === 'Cypress') {
-          const ancestors = context.getAncestors()
+          const ancestors = sourceCode.getAncestors
+            ? sourceCode.getAncestors(node)
+            : context.getAncestors()
           const asyncTestBlocks = ancestors
           .filter((n) => n.type === 'CallExpression')
           .filter(isBeforeBlock)

package/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',
@@ -28,11 +28,14 @@ module.exports = {
                 && node.arguments.length >= 2
                 && node.arguments[1].async === true
     }
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
 
     return {
       Identifier (node) {
         if (node.name === 'cy' || node.name === 'Cypress') {
-          const ancestors = context.getAncestors()
+          const ancestors = sourceCode.getAncestors
+            ? sourceCode.getAncestors(node)
+            : context.getAncestors()
           const asyncTestBlocks = ancestors
           .filter((n) => n.type === 'CallExpression')
           .filter(isTestBlock)

package/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',

package/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',

package/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',
@@ -15,10 +15,14 @@ module.exports = {
     },
   },
   create (context) {
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
+
     return {
       CallExpression (node) {
         if (isCallingCyWait(node)) {
-          const scope = context.getScope()
+          const scope = sourceCode.getScope
+            ? sourceCode.getScope(node)
+            : context.getScope()
 
           if (isIdentifierNumberConstArgument(node, scope) || isNumberArgument(node)) {
             context.report({ node, messageId: 'unexpected' })

package/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',

package/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.'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "index.js",
   "author": "Cypress-io",