feat: add rule disallow usage of cypress-xpath

Author: duranbe

docs/rules/no-xpath.md

@@ -0,0 +1,27 @@
+# Disallow usage of cypress xpath (`no-xpath`)
+
+This rule disallow the usage of cypress-xpath for selecting elements.
+
+
+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
+
+`cypress-xpath` package has been deprecated since Oct 13, 2022.
+
+
+See [the Cypress Best Practices guide](https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements).

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'),

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'),
   },
 }
 

lib/rules/no-xpath.js

@@ -0,0 +1,35 @@
+'use strict'
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: "disallow usage of xpath in selector",
+      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 cypress xpath',
+    }, 
+  },
+
+  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'
+}

tests/lib/rules/no-xpath.js

@@ -0,0 +1,31 @@
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/no-xpath"),
+  RuleTester = require("eslint").RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester();
+ruleTester.run("no-xpath", rule, {
+  valid: [
+    { code: 'cy.wait("@someRequest")' },
+    { code: 'cy.get("button").click({force: true})' },
+  ],
+
+  invalid: [
+    {
+      code: "cy.xpath('//div[@class=\"container\"]/p[1]').click()",
+      errors: [{ messageId: "unexpected" }],
+    },
+    {
+      code: "cy.xpath('//p[1]').should('exist')",
+      errors: [{ messageId: "unexpected" }]
+    }
+  ],
+});