eslint-plugin-cypress 4.2.0 → 4.2.1

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/eslint.config.mjs

@@ -7,6 +7,7 @@ export default [
   pluginJs.configs.recommended,
   eslintPlugin.configs['flat/recommended'],
   mochaPlugin.configs.flat.recommended,
+  {ignores: ['test-project/']},
   {
     languageOptions: {
       globals: globals.node

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "4.2.0",
+  "version": "4.2.1",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "legacy.js",
   "exports": {
@@ -26,15 +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",
-    "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')
+    })
+  })
+})

package/test-project/cypress/e2e/2-advanced-examples/actions.cy.js

@@ -0,0 +1,321 @@
+/// <reference types="cypress" />
+
+context('Actions', () => {
+  beforeEach(() => {
+    cy.visit('https://example.cypress.io/commands/actions')
+  })
+
+  // https://on.cypress.io/interacting-with-elements
+
+  it('.type() - type into a DOM element', () => {
+    // https://on.cypress.io/type
+    cy.get('.action-email').type('fake@email.com')
+    cy.get('.action-email').should('have.value', 'fake@email.com')
+
+    // .type() with special character sequences
+    cy.get('.action-email').type('{leftarrow}{rightarrow}{uparrow}{downarrow}')
+    cy.get('.action-email').type('{del}{selectall}{backspace}')
+
+    // .type() with key modifiers
+    cy.get('.action-email').type('{alt}{option}') //these are equivalent
+    cy.get('.action-email').type('{ctrl}{control}') //these are equivalent
+    cy.get('.action-email').type('{meta}{command}{cmd}') //these are equivalent
+    cy.get('.action-email').type('{shift}')
+
+    // Delay each keypress by 0.1 sec
+    cy.get('.action-email').type('slow.typing@email.com', { delay: 100 })
+    cy.get('.action-email').should('have.value', 'slow.typing@email.com')
+
+    cy.get('.action-disabled')
+      // Ignore error checking prior to type
+      // like whether the input is visible or disabled
+      .type('disabled error checking', { force: true })
+    cy.get('.action-disabled').should('have.value', 'disabled error checking')
+  })
+
+  it('.focus() - focus on a DOM element', () => {
+    // https://on.cypress.io/focus
+    cy.get('.action-focus').focus()
+    cy.get('.action-focus').should('have.class', 'focus')
+      .prev().should('have.attr', 'style', 'color: orange;')
+  })
+
+  it('.blur() - blur off a DOM element', () => {
+    // https://on.cypress.io/blur
+    cy.get('.action-blur').type('About to blur')
+    cy.get('.action-blur').blur()
+    cy.get('.action-blur').should('have.class', 'error')
+      .prev().should('have.attr', 'style', 'color: red;')
+  })
+
+  it('.clear() - clears an input or textarea element', () => {
+    // https://on.cypress.io/clear
+    cy.get('.action-clear').type('Clear this text')
+    cy.get('.action-clear').should('have.value', 'Clear this text')
+    cy.get('.action-clear').clear()
+    cy.get('.action-clear').should('have.value', '')
+  })
+
+  it('.submit() - submit a form', () => {
+    // https://on.cypress.io/submit
+    cy.get('.action-form')
+      .find('[type="text"]').type('HALFOFF')
+
+    cy.get('.action-form').submit()
+    cy.get('.action-form').next().should('contain', 'Your form has been submitted!')
+  })
+
+  it('.click() - click on a DOM element', () => {
+    // https://on.cypress.io/click
+    cy.get('.action-btn').click()
+
+    // You can click on 9 specific positions of an element:
+    //  -----------------------------------
+    // | topLeft        top       topRight |
+    // |                                   |
+    // |                                   |
+    // |                                   |
+    // | left          center        right |
+    // |                                   |
+    // |                                   |
+    // |                                   |
+    // | bottomLeft   bottom   bottomRight |
+    //  -----------------------------------
+
+    // clicking in the center of the element is the default
+    cy.get('#action-canvas').click()
+
+    cy.get('#action-canvas').click('topLeft')
+    cy.get('#action-canvas').click('top')
+    cy.get('#action-canvas').click('topRight')
+    cy.get('#action-canvas').click('left')
+    cy.get('#action-canvas').click('right')
+    cy.get('#action-canvas').click('bottomLeft')
+    cy.get('#action-canvas').click('bottom')
+    cy.get('#action-canvas').click('bottomRight')
+
+    // .click() accepts an x and y coordinate
+    // that controls where the click occurs :)
+
+    cy.get('#action-canvas')
+    cy.get('#action-canvas').click(80, 75) // click 80px on x coord and 75px on y coord
+    cy.get('#action-canvas').click(170, 75)
+    cy.get('#action-canvas').click(80, 165)
+    cy.get('#action-canvas').click(100, 185)
+    cy.get('#action-canvas').click(125, 190)
+    cy.get('#action-canvas').click(150, 185)
+    cy.get('#action-canvas').click(170, 165)
+
+    // click multiple elements by passing multiple: true
+    cy.get('.action-labels>.label').click({ multiple: true })
+
+    // Ignore error checking prior to clicking
+    cy.get('.action-opacity>.btn').click({ force: true })
+  })
+
+  it('.dblclick() - double click on a DOM element', () => {
+    // https://on.cypress.io/dblclick
+
+    // Our app has a listener on 'dblclick' event in our 'scripts.js'
+    // that hides the div and shows an input on double click
+    cy.get('.action-div').dblclick()
+    cy.get('.action-div').should('not.be.visible')
+    cy.get('.action-input-hidden').should('be.visible')
+  })
+
+  it('.rightclick() - right click on a DOM element', () => {
+    // https://on.cypress.io/rightclick
+
+    // Our app has a listener on 'contextmenu' event in our 'scripts.js'
+    // that hides the div and shows an input on right click
+    cy.get('.rightclick-action-div').rightclick()
+    cy.get('.rightclick-action-div').should('not.be.visible')
+    cy.get('.rightclick-action-input-hidden').should('be.visible')
+  })
+
+  it('.check() - check a checkbox or radio element', () => {
+    // https://on.cypress.io/check
+
+    // By default, .check() will check all
+    // matching checkbox or radio elements in succession, one after another
+    cy.get('.action-checkboxes [type="checkbox"]').not('[disabled]').check()
+    cy.get('.action-checkboxes [type="checkbox"]').not('[disabled]').should('be.checked')
+
+    cy.get('.action-radios [type="radio"]').not('[disabled]').check()
+    cy.get('.action-radios [type="radio"]').not('[disabled]').should('be.checked')
+
+    // .check() accepts a value argument
+    cy.get('.action-radios [type="radio"]').check('radio1')
+    cy.get('.action-radios [type="radio"]').should('be.checked')
+
+    // .check() accepts an array of values
+    cy.get('.action-multiple-checkboxes [type="checkbox"]').check(['checkbox1', 'checkbox2'])
+    cy.get('.action-multiple-checkboxes [type="checkbox"]').should('be.checked')
+
+    // Ignore error checking prior to checking
+    cy.get('.action-checkboxes [disabled]').check({ force: true })
+    cy.get('.action-checkboxes [disabled]').should('be.checked')
+
+    cy.get('.action-radios [type="radio"]').check('radio3', { force: true })
+    cy.get('.action-radios [type="radio"]').should('be.checked')
+  })
+
+  it('.uncheck() - uncheck a checkbox element', () => {
+    // https://on.cypress.io/uncheck
+
+    // By default, .uncheck() will uncheck all matching
+    // checkbox elements in succession, one after another
+    cy.get('.action-check [type="checkbox"]')
+      .not('[disabled]')
+      .uncheck()
+    cy.get('.action-check [type="checkbox"]')
+      .not('[disabled]')
+      .should('not.be.checked')
+
+    // .uncheck() accepts a value argument
+    cy.get('.action-check [type="checkbox"]')
+      .check('checkbox1')
+    cy.get('.action-check [type="checkbox"]')
+      .uncheck('checkbox1')
+    cy.get('.action-check [type="checkbox"][value="checkbox1"]')
+      .should('not.be.checked')
+
+    // .uncheck() accepts an array of values
+    cy.get('.action-check [type="checkbox"]')
+      .check(['checkbox1', 'checkbox3'])
+    cy.get('.action-check [type="checkbox"]')
+      .uncheck(['checkbox1', 'checkbox3'])
+    cy.get('.action-check [type="checkbox"][value="checkbox1"]')
+      .should('not.be.checked')
+    cy.get('.action-check [type="checkbox"][value="checkbox3"]')
+      .should('not.be.checked')
+
+    // Ignore error checking prior to unchecking
+    cy.get('.action-check [disabled]').uncheck({ force: true })
+    cy.get('.action-check [disabled]').should('not.be.checked')
+  })
+
+  it('.select() - select an option in a <select> element', () => {
+    // https://on.cypress.io/select
+
+    // at first, no option should be selected
+    cy.get('.action-select')
+      .should('have.value', '--Select a fruit--')
+
+    // Select option(s) with matching text content
+    cy.get('.action-select').select('apples')
+    // confirm the apples were selected
+    // note that each value starts with "fr-" in our HTML
+    cy.get('.action-select').should('have.value', 'fr-apples')
+
+    cy.get('.action-select-multiple')
+      .select(['apples', 'oranges', 'bananas'])
+    cy.get('.action-select-multiple')
+      // when getting multiple values, invoke "val" method first
+      .invoke('val')
+      .should('deep.equal', ['fr-apples', 'fr-oranges', 'fr-bananas'])
+
+    // Select option(s) with matching value
+    cy.get('.action-select').select('fr-bananas')
+    cy.get('.action-select')
+      // can attach an assertion right away to the element
+      .should('have.value', 'fr-bananas')
+
+    cy.get('.action-select-multiple')
+      .select(['fr-apples', 'fr-oranges', 'fr-bananas'])
+    cy.get('.action-select-multiple')
+      .invoke('val')
+      .should('deep.equal', ['fr-apples', 'fr-oranges', 'fr-bananas'])
+
+    // assert the selected values include oranges
+    cy.get('.action-select-multiple')
+      .invoke('val').should('include', 'fr-oranges')
+  })
+
+  it('.scrollIntoView() - scroll an element into view', () => {
+    // https://on.cypress.io/scrollintoview
+
+    // normally all of these buttons are hidden,
+    // because they're not within
+    // the viewable area of their parent
+    // (we need to scroll to see them)
+    cy.get('#scroll-horizontal button')
+      .should('not.be.visible')
+
+    // scroll the button into view, as if the user had scrolled
+    cy.get('#scroll-horizontal button').scrollIntoView()
+    cy.get('#scroll-horizontal button')
+      .should('be.visible')
+
+    cy.get('#scroll-vertical button')
+      .should('not.be.visible')
+
+    // Cypress handles the scroll direction needed
+    cy.get('#scroll-vertical button').scrollIntoView()
+    cy.get('#scroll-vertical button')
+      .should('be.visible')
+
+    cy.get('#scroll-both button')
+      .should('not.be.visible')
+
+    // Cypress knows to scroll to the right and down
+    cy.get('#scroll-both button').scrollIntoView()
+    cy.get('#scroll-both button')
+      .should('be.visible')
+  })
+
+  it('.trigger() - trigger an event on a DOM element', () => {
+    // https://on.cypress.io/trigger
+
+    // To interact with a range input (slider)
+    // we need to set its value & trigger the
+    // event to signal it changed
+
+    // Here, we invoke jQuery's val() method to set
+    // the value and trigger the 'change' event
+    cy.get('.trigger-input-range')
+      .invoke('val', 25)
+    cy.get('.trigger-input-range')
+      .trigger('change')
+    cy.get('.trigger-input-range')
+      .get('input[type=range]').siblings('p')
+      .should('have.text', '25')
+  })
+
+  it('cy.scrollTo() - scroll the window or element to a position', () => {
+    // https://on.cypress.io/scrollto
+
+    // You can scroll to 9 specific positions of an element:
+    //  -----------------------------------
+    // | topLeft        top       topRight |
+    // |                                   |
+    // |                                   |
+    // |                                   |
+    // | left          center        right |
+    // |                                   |
+    // |                                   |
+    // |                                   |
+    // | bottomLeft   bottom   bottomRight |
+    //  -----------------------------------
+
+    // if you chain .scrollTo() off of cy, we will
+    // scroll the entire window
+    cy.scrollTo('bottom')
+
+    cy.get('#scrollable-horizontal').scrollTo('right')
+
+    // or you can scroll to a specific coordinate:
+    // (x axis, y axis) in pixels
+    cy.get('#scrollable-vertical').scrollTo(250, 250)
+
+    // or you can scroll to a specific percentage
+    // of the (width, height) of the element
+    cy.get('#scrollable-both').scrollTo('75%', '25%')
+
+    // control the easing of the scroll (default is 'swing')
+    cy.get('#scrollable-vertical').scrollTo('center', { easing: 'linear' })
+
+    // control the duration of the scroll (in ms)
+    cy.get('#scrollable-both').scrollTo('center', { duration: 2000 })
+  })
+})