eslint-plugin-cypress 5.0.0 → 5.1.0

package/lib/rules/no-xpath.js

@@ -6,7 +6,7 @@ module.exports = {
     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'
+      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
@@ -15,21 +15,21 @@ module.exports = {
     },
   },
 
-  create (context) {
+  create(context) {
     return {
-      CallExpression (node) {
+      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'
+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/lib/rules/require-data-selectors.js

@@ -15,9 +15,9 @@ module.exports = {
     },
   },
 
-  create (context) {
+  create(context) {
     return {
-      CallExpression (node) {
+      CallExpression(node) {
         if (isCallingCyGet(node) && !isDataArgument(node)) {
           context.report({ node, messageId: 'unexpected' })
         }
@@ -26,23 +26,23 @@ module.exports = {
   },
 }
 
-function isCallingCyGet (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 === 'get'
+function isCallingCyGet(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 === 'get'
 }
 
-function isDataArgument (node) {
-  return node.arguments.length > 0 &&
-    (
-      (node.arguments[0].type === 'Literal' && isAliasOrDataSelector(String(node.arguments[0].value))) ||
-      (node.arguments[0].type === 'TemplateLiteral' && isAliasOrDataSelector(String(node.arguments[0].quasis[0].value.cooked)))
+function isDataArgument(node) {
+  return node.arguments.length > 0
+    && (
+      (node.arguments[0].type === 'Literal' && isAliasOrDataSelector(String(node.arguments[0].value)))
+      || (node.arguments[0].type === 'TemplateLiteral' && isAliasOrDataSelector(String(node.arguments[0].quasis[0].value.cooked)))
     )
 }
 
-function isAliasOrDataSelector (selector) {
+function isAliasOrDataSelector(selector) {
   return ['[data-', '@'].some(function (validValue) {
     return selector.startsWith(validValue)
   })

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

@@ -82,15 +82,15 @@ module.exports = {
         'It is unsafe to chain further commands that rely on the subject after this command. It is best to split the chain, chaining again from `cy.` in a next command line.',
     },
   },
-  create (context) {
+  create(context) {
     const { methods } = getDefaultOptions(context)
 
     return {
-      CallExpression (node) {
+      CallExpression(node) {
         if (
-          isRootCypress(node) &&
-          isActionUnsafeToChain(node, methods) &&
-          node.parent.type === 'MemberExpression'
+          isRootCypress(node)
+          && isActionUnsafeToChain(node, methods)
+          && node.parent.type === 'MemberExpression'
         ) {
           context.report({
             node,
@@ -108,15 +108,15 @@ module.exports = {
  */
 const isRootCypress = (node) => {
   if (
-    node.type !== 'CallExpression' ||
-    node.callee.type !== 'MemberExpression'
+    node.type !== 'CallExpression'
+    || node.callee.type !== 'MemberExpression'
   ) {
     return false
   }
 
   if (
-    node.callee.object.type === 'Identifier' &&
-    node.callee.object.name === 'cy'
+    node.callee.object.type === 'Identifier'
+    && node.callee.object.name === 'cy'
   ) {
     return true
   }
@@ -135,9 +135,9 @@ const isActionUnsafeToChain = (node, additionalMethods = []) => {
   ].join('|'))
 
   return (
-    node.callee &&
-    node.callee.property &&
-    node.callee.property.type === 'Identifier' &&
-    unsafeActionsRegex.test(node.callee.property.name)
+    node.callee
+    && node.callee.property
+    && node.callee.property.type === 'Identifier'
+    && unsafeActionsRegex.test(node.callee.property.name)
   )
 }

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "./lib/flat.js",
   "exports": {
     ".": "./lib/flat.js",
     "./flat": "./lib/flat.js"
   },
+  "files": [
+    "lib",
+    "docs",
+    "CONTRIBUTING.md"
+  ],
   "author": "Cypress-io",
   "license": "MIT",
   "keywords": [
@@ -29,20 +34,19 @@
     "globals": "^16.2.0"
   },
   "devDependencies": {
+    "@stylistic/eslint-plugin": "^4.4.0",
     "eslint": "^9.27.0",
     "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-plugin-mocha": "^11.1.0",
     "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "semantic-release": "24.2.5"
+    "semantic-release": "24.2.5",
+    "vitest": "^3.1.4"
   },
   "scripts": {
     "lint": "eslint",
     "lint-fix": "eslint --fix",
     "semantic-release": "semantic-release",
-    "start": "npm run test-watch",
-    "test": "jest",
-    "test-watch": "jest --watchAll",
+    "test": "vitest run",
     "prepare": "husky"
   }
 }

package/.github/workflows/add-issue-triage-board.yml

@@ -1,12 +0,0 @@
-name: 'Add issue/PR to Triage Board'
-on:
-  issues:
-    types:
-      - opened
-  pull_request_target:
-    types:
-      - opened
-jobs:
-  add-to-triage-project-board:
-    uses: cypress-io/cypress/.github/workflows/triage_add_to_project.yml@develop
-    secrets: inherit

package/.github/workflows/triage_closed_issue_comment.yml

@@ -1,9 +0,0 @@
-name: 'Handle Comment Workflow'
-on:
-  issue_comment:
-    types:
-      - created
-jobs:
-  closed-issue-comment:
-    uses: cypress-io/cypress/.github/workflows/triage_handle_new_comments.yml@develop
-    secrets: inherit

package/.husky/pre-commit

@@ -1 +0,0 @@
-npm run lint

package/.node-version

@@ -1 +0,0 @@
-22.16.0

package/.nvmrc

@@ -1 +0,0 @@
-22.16.0

package/ESLINTRC-CONFIG.md

@@ -1,7 +0,0 @@
-# Cypress ESLint Plugin - Legacy Config
-
-This document previously described how to use the Cypress ESLint Plugin (`eslint-plugin-cypress`) with an [ESLint legacy config environment](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated).
-
-This form of configuration was deprecated with the release of ESLint `v9` and its use with `eslint-plugin-cypress` is no longer supported.
-
-Users who were previously using a deprecated configuration environment should migrate to a [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files).

package/FLAT-CONFIG.md

@@ -1,3 +0,0 @@
-# Cypress ESLint Plugin - Flat Config
-
- Please refer to the [README](./README.md) document which describes how to use `eslint-plugin-cypress` with an ESLint `v9` (default) [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files).

package/circle.yml

@@ -1,137 +0,0 @@
-version: 2.1
-
-executors:
-  docker-executor:
-    docker:
-      - image: cimg/node:22.16.0
-    resource_class: medium
-
-workflows:
-  main:
-    jobs:
-      - lint
-      - test-v9
-
-      - build-test-project
-      - test-test-project:
-          matrix:
-            parameters:
-              eslint-version: ['9']
-              config-file: [
-                  # configurations correspond to examples in README
-                  'default',
-                  'default-deprecated', # using deprecated /flat
-                  'recommended',
-                  'globals',
-                ]
-          requires:
-            - build-test-project
-      - release:
-          requires:
-            - lint
-            - test-v9
-            - test-test-project
-          filters:
-            branches:
-              only:
-                - master
-
-jobs:
-  lint:
-    executor: docker-executor
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: npm ci
-      - run:
-          name: Show ESLint version
-          command: npx eslint --version
-      - run:
-          name: Lint code
-          command: npm run lint
-
-  test-v9:
-    executor: docker-executor
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: npm ci
-      - run:
-          name: Install ESLint 9
-          command: npm install eslint@9
-      - run:
-          name: Show ESLint version
-          command: npx eslint --version
-      - run:
-          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:
-    executor: docker-executor
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: npm ci
-      - run:
-          name: Run semantic release
-          command: npm run semantic-release

package/eslint.config.mjs

@@ -1,26 +0,0 @@
-import globals from 'globals'
-import pluginJs from '@eslint/js'
-import eslintPlugin from 'eslint-plugin-eslint-plugin'
-import mochaPlugin from 'eslint-plugin-mocha'
-
-export default [
-  pluginJs.configs.recommended,
-  eslintPlugin.configs['flat/recommended'],
-  mochaPlugin.configs.recommended,
-  {ignores: ['test-project/']},
-  {
-    languageOptions: {
-      globals: globals.node
-    },
-    rules: {
-      'no-redeclare': 'off',
-      'eslint-plugin/require-meta-docs-url':
-        ['error', { 'pattern': 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/{{name}}.md' }],
-      'eslint-plugin/require-meta-docs-description': 'error',
-      'eslint-plugin/meta-property-ordering': 'error',
-      'eslint-plugin/test-case-property-ordering': 'error',
-      'mocha/no-mocha-arrows': 'off',
-      'mocha/no-setup-in-describe': 'off'
-    }
-  },
-]

package/jest.config.js

@@ -1,6 +0,0 @@
-const { defaults } = require('jest-config')
-
-module.exports = {
-  testMatch: ['**/tests/**/*.[jt]s?(x)'],
-  testPathIgnorePatterns: [...defaults.testPathIgnorePatterns, '.history'],
-}

package/test-project/README.md

@@ -1,48 +0,0 @@
-# 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

@@ -1,143 +0,0 @@
-/// <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')
-    })
-  })
-})