eslint-plugin-cypress 4.1.0 → 4.2.1

package/.node-version

@@ -1 +1 @@
-20.12.2
+22.11.0

package/.nvmrc

@@ -1 +1 @@
-20.12.2
+22.11.0

package/README.md

@@ -54,6 +54,7 @@ These rules enforce some of the [best practices recommended for using Cypress](h
 | [no-force](docs/rules/no-force.md)                                       | disallow using `force: true` with action commands          |    |
 | [no-pause](docs/rules/no-pause.md)                                       | disallow using `cy.pause()` calls                          |    |
 | [no-unnecessary-waiting](docs/rules/no-unnecessary-waiting.md)           | disallow waiting for arbitrary time periods                | ✅  |
+| [no-xpath](docs/rules/no-xpath.md)                                       | disallow using `cy.xpath()` calls                          |    |
 | [require-data-selectors](docs/rules/require-data-selectors.md)           | require `data-*` attribute selectors                       |    |
 | [unsafe-to-chain-command](docs/rules/unsafe-to-chain-command.md)         | disallow actions within chains                             | ✅  |
 

package/circle.yml

@@ -1,17 +1,37 @@
 version: 2.1
 
+executors:
+  docker-executor:
+    docker:
+      - image: cimg/node:22.14.0
+    resource_class: medium
+
 workflows:
-  version: 2.1
   main:
     jobs:
       - lint
       - test-v8
       - test-v9
+
+      - build-test-project
+      - test-test-project:
+          matrix:
+            parameters:
+              eslint-version: ['9']
+              config-file: [
+                  # configurations correspond to examples in README
+                  'default',
+                  'recommended',
+                  'globals',
+                ]
+          requires:
+            - build-test-project
       - release:
           requires:
             - lint
             - test-v8
             - test-v9
+            - test-test-project
           filters:
             branches:
               only:
@@ -19,8 +39,7 @@ workflows:
 
 jobs:
   lint:
-    docker:
-      - image: cimg/node:22.11.0
+    executor: docker-executor
     steps:
       - checkout
       - run:
@@ -34,8 +53,7 @@ jobs:
           command: npm run lint
 
   test-v8:
-    docker:
-      - image: cimg/node:22.11.0
+    executor: docker-executor
     steps:
       - checkout
       - run:
@@ -52,8 +70,7 @@ jobs:
           command: npm run test:legacy
 
   test-v9:
-    docker:
-      - image: cimg/node:22.11.0
+    executor: docker-executor
     steps:
       - checkout
       - run:
@@ -69,9 +86,65 @@ jobs:
           name: Test ESLint 9
           command: npm test
 
+  build-test-project:
+    executor: docker-executor
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: npm ci
+      - run:
+          name: Build tarball
+          command: npm pack
+      - run:
+          name: Get version
+          command: |
+            echo "PLUGIN_VERSION=$(jq -r '.version' package.json)" >> $BASH_ENV
+            cp $BASH_ENV bash.env
+      - persist_to_workspace:
+          root: .
+          paths:
+            - eslint-plugin-cypress-*.tgz
+            - bash.env
+
+  test-test-project:
+    description: Run ESLint with different configurations
+    parameters:
+      eslint-version:
+        description: Version of ESLint to use
+        default: 'latest'
+        type: string
+      config-file:
+        description: Configuration file
+        default: 'default'
+        type: string
+    executor: docker-executor
+    working_directory: ./test-project
+    steps:
+      - checkout:
+          path: ../
+      - attach_workspace:
+          at: .
+      - run:
+          name: Get plugin version
+          command: |
+            cat bash.env >> $BASH_ENV
+      - run:
+          name: Install dependencies
+          command: |
+            npm install eslint@<< parameters.eslint-version>> ./eslint-plugin-cypress-$PLUGIN_VERSION.tgz -D
+      - run:
+          name: Display ESLint version
+          command: |
+            npx eslint --version
+      - run: echo Testing a << parameters.config-file >> configuration
+      - run:
+          name: Lint with example configuration
+          command: |
+            npx eslint --config ./eslint-configs/eslint.<< parameters.config-file >>.mjs .
+
   release:
-    docker:
-      - image: cimg/node:22.11.0
+    executor: docker-executor
     steps:
       - checkout
       - run:

package/docs/rules/no-xpath.md

@@ -0,0 +1,25 @@
+# Disallow using `cy.xpath()` calls (`cypress/no-xpath`)
+
+<!-- end auto-generated rule header -->
+
+This rule disallows the usage of `cy.xpath()` for selecting elements.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```js
+cy.xpath('//div[@class=\"container\"]').click()
+```
+
+Examples of **correct** code for this rule:
+
+```js
+cy.get('[data-cy="container"]').click();
+```
+
+## Further Reading
+
+Both `@cypress/xpath` and `cypress-xpath` are deprecated.
+
+See [the Cypress Best Practices guide](https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements).

package/eslint.config.mjs

@@ -1,14 +1,13 @@
 import globals from 'globals'
 import pluginJs from '@eslint/js'
 import eslintPlugin from 'eslint-plugin-eslint-plugin'
-import nodePlugin from 'eslint-plugin-n'
 import mochaPlugin from 'eslint-plugin-mocha'
 
 export default [
   pluginJs.configs.recommended,
   eslintPlugin.configs['flat/recommended'],
-  nodePlugin.configs['flat/recommended-script'],
   mochaPlugin.configs.flat.recommended,
+  {ignores: ['test-project/']},
   {
     languageOptions: {
       globals: globals.node
@@ -20,8 +19,6 @@ export default [
       'eslint-plugin/require-meta-docs-description': 'error',
       'eslint-plugin/meta-property-ordering': 'error',
       'eslint-plugin/test-case-property-ordering': 'error',
-      'n/no-extraneous-require':
-        ['error', { 'allowModules': ['jest-config'] }],
       'mocha/no-mocha-arrows': 'off',
       'mocha/no-setup-in-describe': 'off'
     }

package/legacy.js

@@ -12,6 +12,7 @@ module.exports = {
     'no-force': require('./lib/rules/no-force'),
     'no-pause': require('./lib/rules/no-pause'),
     'no-debug': require('./lib/rules/no-debug'),
+    'no-xpath': require('./lib/rules/no-xpath'),
   },
   configs: {
     recommended: require('./lib/config/recommended'),

package/lib/flat.js

@@ -15,6 +15,7 @@ const plugin = {
     'no-force': require('./rules/no-force'),
     'no-pause': require('./rules/no-pause'),
     'no-debug': require('./rules/no-debug'),
+    'no-xpath': require('./rules/no-xpath'),
   },
 }
 

package/lib/rules/no-xpath.js

@@ -0,0 +1,35 @@
+'use strict'
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'disallow using `cy.xpath()` calls',
+      recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-xpath.md'
+    },
+    fixable: null, // Or `code` or `whitespace`
+    schema: [], // Add a schema if the rule has options
+    messages: {
+      unexpected: 'Avoid using cy.xpath command',
+    },
+  },
+
+  create (context) {
+    return {
+      CallExpression (node) {
+        if (isCallingCyXpath(node)) {
+          context.report({ node, messageId: 'unexpected' })
+        }
+      },
+    }
+  },
+};
+
+function isCallingCyXpath (node) {
+  return node.callee.type === 'MemberExpression' &&
+         node.callee.object.type === 'Identifier' &&
+         node.callee.object.name === 'cy' &&
+         node.callee.property.type === 'Identifier' &&
+         node.callee.property.name === 'xpath'
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "4.1.0",
+  "version": "4.2.1",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "legacy.js",
   "exports": {
@@ -26,16 +26,15 @@
     "eslint": ">=9"
   },
   "dependencies": {
-    "globals": "^15.11.0"
+    "globals": "^15.15.0"
   },
   "devDependencies": {
-    "eslint": "^9.13.0",
-    "eslint-plugin-eslint-plugin": "^6.3.1",
+    "eslint": "^9.24.0",
+    "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-plugin-mocha": "^10.5.0",
-    "eslint-plugin-n": "^17.11.1",
-    "husky": "^9.1.6",
+    "husky": "^9.1.7",
     "jest": "^29.7.0",
-    "semantic-release": "24.2.0"
+    "semantic-release": "24.2.3"
   },
   "scripts": {
     "lint": "eslint \"*.js\" \"**/**/*.js\"",

package/test-project/README.md

@@ -0,0 +1,48 @@
+# Test-project
+
+This test project was generated via the Cypress App.
+
+This project can be updated to the latest Cypress default scaffolded E2E test specs by carrying out the following steps in the directory `/test-project`:
+
+```shell
+rm -rf cypress cypress.config.js
+npm install cypress@latest --no-package-lock
+npx cypress open
+```
+
+- Select "Continue" for "What's New in Cypress" if displayed
+- Select "E2E Testing"
+- Select "Continue" in "Configuration files"
+- Select "Electron" browser
+- Select "Start E2E Testing in Electron"
+- Select "Scaffold example specs"
+- Close all Cypress windows
+
+Test that scaffolded specs run:
+
+```shell
+npm test
+```
+
+Remove Cypress from `package.json`:
+
+```shell
+npm uninstall cypress --no-package-lock
+```
+
+## Tests
+
+Tests are run via [circle.yml](../circle.yml).
+
+To test the project locally:
+
+```shell
+cd test-project
+npm install eslint@latest eslint-plugin-cypress@latest cypress@latest -D
+npx cypress run
+npx eslint
+```
+
+Do not commit the changes from installing the above dependencies.
+The CircleCI pipeline dynamically installs the latest `eslint*` dependencies.
+Cypress is not needed for the CircleCI tests.

package/test-project/cypress/e2e/1-getting-started/todo.cy.js

@@ -0,0 +1,143 @@
+/// <reference types="cypress" />
+
+// Welcome to Cypress!
+//
+// This spec file contains a variety of sample tests
+// for a todo list app that are designed to demonstrate
+// the power of writing tests in Cypress.
+//
+// To learn more about how Cypress works and
+// what makes it such an awesome testing tool,
+// please read our getting started guide:
+// https://on.cypress.io/introduction-to-cypress
+
+describe('example to-do app', () => {
+  beforeEach(() => {
+    // Cypress starts out with a blank slate for each test
+    // so we must tell it to visit our website with the `cy.visit()` command.
+    // Since we want to visit the same URL at the start of all our tests,
+    // we include it in our beforeEach function so that it runs before each test
+    cy.visit('https://example.cypress.io/todo')
+  })
+
+  it('displays two todo items by default', () => {
+    // We use the `cy.get()` command to get all elements that match the selector.
+    // Then, we use `should` to assert that there are two matched items,
+    // which are the two default items.
+    cy.get('.todo-list li').should('have.length', 2)
+
+    // We can go even further and check that the default todos each contain
+    // the correct text. We use the `first` and `last` functions
+    // to get just the first and last matched elements individually,
+    // and then perform an assertion with `should`.
+    cy.get('.todo-list li').first().should('have.text', 'Pay electric bill')
+    cy.get('.todo-list li').last().should('have.text', 'Walk the dog')
+  })
+
+  it('can add new todo items', () => {
+    // We'll store our item text in a variable so we can reuse it
+    const newItem = 'Feed the cat'
+
+    // Let's get the input element and use the `type` command to
+    // input our new list item. After typing the content of our item,
+    // we need to type the enter key as well in order to submit the input.
+    // This input has a data-test attribute so we'll use that to select the
+    // element in accordance with best practices:
+    // https://on.cypress.io/selecting-elements
+    cy.get('[data-test=new-todo]').type(`${newItem}{enter}`)
+
+    // Now that we've typed our new item, let's check that it actually was added to the list.
+    // Since it's the newest item, it should exist as the last element in the list.
+    // In addition, with the two default items, we should have a total of 3 elements in the list.
+    // Since assertions yield the element that was asserted on,
+    // we can chain both of these assertions together into a single statement.
+    cy.get('.todo-list li')
+      .should('have.length', 3)
+      .last()
+      .should('have.text', newItem)
+  })
+
+  it('can check off an item as completed', () => {
+    // In addition to using the `get` command to get an element by selector,
+    // we can also use the `contains` command to get an element by its contents.
+    // However, this will yield the <label>, which is lowest-level element that contains the text.
+    // In order to check the item, we'll find the <input> element for this <label>
+    // by traversing up the dom to the parent element. From there, we can `find`
+    // the child checkbox <input> element and use the `check` command to check it.
+    cy.contains('Pay electric bill')
+      .parent()
+      .find('input[type=checkbox]')
+      .check()
+
+    // Now that we've checked the button, we can go ahead and make sure
+    // that the list element is now marked as completed.
+    // Again we'll use `contains` to find the <label> element and then use the `parents` command
+    // to traverse multiple levels up the dom until we find the corresponding <li> element.
+    // Once we get that element, we can assert that it has the completed class.
+    cy.contains('Pay electric bill')
+      .parents('li')
+      .should('have.class', 'completed')
+  })
+
+  context('with a checked task', () => {
+    beforeEach(() => {
+      // We'll take the command we used above to check off an element
+      // Since we want to perform multiple tests that start with checking
+      // one element, we put it in the beforeEach hook
+      // so that it runs at the start of every test.
+      cy.contains('Pay electric bill')
+        .parent()
+        .find('input[type=checkbox]')
+        .check()
+    })
+
+    it('can filter for uncompleted tasks', () => {
+      // We'll click on the "active" button in order to
+      // display only incomplete items
+      cy.contains('Active').click()
+
+      // After filtering, we can assert that there is only the one
+      // incomplete item in the list.
+      cy.get('.todo-list li')
+        .should('have.length', 1)
+        .first()
+        .should('have.text', 'Walk the dog')
+
+      // For good measure, let's also assert that the task we checked off
+      // does not exist on the page.
+      cy.contains('Pay electric bill').should('not.exist')
+    })
+
+    it('can filter for completed tasks', () => {
+      // We can perform similar steps as the test above to ensure
+      // that only completed tasks are shown
+      cy.contains('Completed').click()
+
+      cy.get('.todo-list li')
+        .should('have.length', 1)
+        .first()
+        .should('have.text', 'Pay electric bill')
+
+      cy.contains('Walk the dog').should('not.exist')
+    })
+
+    it('can delete all completed tasks', () => {
+      // First, let's click the "Clear completed" button
+      // `contains` is actually serving two purposes here.
+      // First, it's ensuring that the button exists within the dom.
+      // This button only appears when at least one task is checked
+      // so this command is implicitly verifying that it does exist.
+      // Second, it selects the button so we can click it.
+      cy.contains('Clear completed').click()
+
+      // Then we can make sure that there is only one element
+      // in the list and our element does not exist
+      cy.get('.todo-list li')
+        .should('have.length', 1)
+        .should('not.have.text', 'Pay electric bill')
+
+      // Finally, make sure that the clear button no longer exists.
+      cy.contains('Clear completed').should('not.exist')
+    })
+  })
+})