eslint-plugin-cypress 6.3.0 → 6.4.0

package/README.md

@@ -139,6 +139,46 @@ export default defineConfig([
 ])
 ```
 
+### Typed Linting
+
+You can activate typed linting for increased accuracy, if you want. This is purely optional and all rules continue to work without it. It uses a TypeScript parser to parse your entire project, instead of only the file being linted, which gives the plugin more information to work with. Be aware of the [performance penalty](https://typescript-eslint.io/getting-started/typed-linting/#performance) that this brings with it.
+
+First, install the `@typescript-eslint/parser` npm package:
+
+```sh
+npm install @typescript-eslint/parser --save-dev
+```
+
+If you already have a TypeScript codebase, you can skip the next step. If not, you need a `tsconfig.json`. The following minimal `tsconfig.json` does not compile or check your code and includes all .js files.
+
+```json
+{
+  "include": ["**/*.js"],
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": false,
+    "noEmit": true
+  },
+}
+```
+
+The last step is to extend your eslint config to use the `typescript-eslint` parser.
+
+```js
+import { defineConfig } from 'eslint/config'
+import typescriptParser from '@typescript-eslint/parser'
+export default defineConfig([
+  {
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  }
+])
+```
+
 ## Disable rules
 
 You can disable specific rules per file, for a portion of a file, or for a single line. See the [ESLint rules](https://eslint.org/docs/latest/use/configure/rules#disable-rules) documentation. For example ...

package/docs/rules/unsafe-to-chain-command.md

@@ -16,6 +16,18 @@
 
 <!-- end auto-generated rule options list -->
 
+## Typed Linting
+
+If [Typed Linting](../../README.md#typed-linting) is enabled, this rule also catches unsafe chaining even when the Cypress chain was started from a helper function.
+
+```js
+function getTodo() {
+  return cy.get('.todo')
+}
+
+getTodo().type('todo A{enter}').type('todo B{enter}')
+```
+
 ## Further Reading
 
 See [retry-ability guide](https://docs.cypress.io/app/core-concepts/retry-ability#Actions-should-be-at-the-end-of-chains-not-the-middle).

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

@@ -90,7 +90,7 @@ module.exports = {
     return {
       CallExpression(node) {
         if (
-          isRootCypress(node)
+          isRootCypress(node, context)
           && isActionUnsafeToChain(node, methods)
           && node.parent.type === 'MemberExpression'
         ) {

package/lib/utils/is-root-cypress.js

@@ -3,26 +3,44 @@
 /**
  * Whether `node` is a CallExpression that belongs to a Cypress command chain
  * rooted at `cy` (walks `callee.object` through nested calls).
+ * If type information are available, additionally checks the return type of helper functions.
  *
  * @param {import('estree').Node} node
  * @returns {boolean}
  */
-function isRootCypress(node) {
-  if (
-    node.type !== 'CallExpression'
-    || node.callee.type !== 'MemberExpression'
-  ) {
+const isRootCypress = (node, context) => {
+  if (node.type !== 'CallExpression') {
     return false
   }
 
-  if (
-    node.callee.object.type === 'Identifier'
-    && node.callee.object.name === 'cy'
-  ) {
-    return true
+  const calleeType = node.callee.type
+  if (calleeType === 'MemberExpression') {
+    if (node.callee.object.type === 'Identifier' && node.callee.object.name === 'cy') {
+      return true
+    }
+
+    return isRootCypress(node.callee.object, context)
+  }
+
+  if (calleeType === 'Identifier') {
+    const services = context?.sourceCode?.parserServices
+    if (services?.program && services.esTreeNodeToTSNodeMap) {
+      const checker = services.program.getTypeChecker()
+      const tsNode = services.esTreeNodeToTSNodeMap.get(node)
+      if (tsNode) {
+        const signature = checker.getResolvedSignature(tsNode)
+        if (signature) {
+          const returnType = checker.getReturnTypeOfSignature(signature)
+          const symbol = returnType.getSymbol()
+          if (symbol) {
+            return checker.getFullyQualifiedName(symbol) === 'Cypress.Chainable'
+          }
+        }
+      }
+    }
   }
 
-  return isRootCypress(node.callee.object)
+  return false
 }
 
 module.exports = { isRootCypress }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-cypress",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "description": "An ESLint plugin for projects using Cypress",
   "main": "./lib/index.js",
   "exports": {
@@ -28,22 +28,30 @@
   },
   "homepage": "https://github.com/cypress-io/eslint-plugin-cypress#readme",
   "peerDependencies": {
+    "@typescript-eslint/parser": ">=8",
     "eslint": ">=9"
   },
+  "peerDependenciesMeta": {
+    "@typescript-eslint/parser": {
+      "optional": true
+    }
+  },
   "dependencies": {
-    "globals": "^17.4.0"
+    "globals": "^17.5.0"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@stylistic/eslint-plugin": "^5.9.0",
-    "eslint": "^10.0.2",
-    "eslint-plugin-eslint-plugin": "^7.3.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/rule-tester": "^8.59.0",
+    "cypress": "^15.14.0",
+    "eslint": "^10.2.1",
+    "eslint-plugin-eslint-plugin": "^7.3.2",
     "eslint-plugin-mocha": "^11.2.0",
     "husky": "^9.1.7",
-    "prettier": "^3.8.1",
+    "prettier": "^3.8.3",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.56.1",
-    "vitest": "^4.0.18"
+    "typescript-eslint": "^8.59.1",
+    "vitest": "^4.1.5"
   },
   "scripts": {
     "lint": "eslint",