From 033de6e98deb9b90c40c6ee5acbd9ca83b74d7ba Mon Sep 17 00:00:00 2001
From: Nico Prat <nicooprat@gmail.com>
Date: Wed, 31 Jul 2024 14:10:01 +0000
Subject: [PATCH] feat: add rule no-debug

---
 docs/rules/no-debug.md      | 19 ++++++++++++
 legacy.js                   |  1 +
 lib/flat.js                 |  1 +
 lib/rules/no-debug.js       | 61 +++++++++++++++++++++++++++++++++++++
 tests/lib/rules/no-debug.js | 23 ++++++++++++++
 5 files changed, 105 insertions(+)
 create mode 100644 docs/rules/no-debug.md
 create mode 100644 lib/rules/no-debug.js
 create mode 100644 tests/lib/rules/no-debug.js

diff --git a/docs/rules/no-debug.md b/docs/rules/no-debug.md
new file mode 100644
index 00000000..5f2145b2
--- /dev/null
+++ b/docs/rules/no-debug.md
@@ -0,0 +1,19 @@
+# Disallow using `cy.debug()` calls (`cypress/no-debug`)
+
+<!-- end auto-generated rule header -->
+It is recommended to remove any [cy.debug](https://on.cypress.io/debug) commands before committing specs to avoid other developers getting unexpected results.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```js
+cy.debug();
+cy.get('selector').debug();
+```
+
+Examples of **correct** code for this rule:
+
+```js
+cy.get('selector')
+```
diff --git a/legacy.js b/legacy.js
index a615be9d..36f2b780 100644
--- a/legacy.js
+++ b/legacy.js
@@ -11,6 +11,7 @@ module.exports = {
     'require-data-selectors': require('./lib/rules/require-data-selectors'),
     'no-force': require('./lib/rules/no-force'),
     'no-pause': require('./lib/rules/no-pause'),
+    'no-debug': require('./lib/rules/no-debug'),
   },
   configs: {
     recommended: require('./lib/config/recommended'),
diff --git a/lib/flat.js b/lib/flat.js
index c596ab56..038a5805 100644
--- a/lib/flat.js
+++ b/lib/flat.js
@@ -14,6 +14,7 @@ const plugin = {
     'require-data-selectors': require('./rules/require-data-selectors'),
     'no-force': require('./rules/no-force'),
     'no-pause': require('./rules/no-pause'),
+    'no-debug': require('./rules/no-debug'),
   },
 }
 
diff --git a/lib/rules/no-debug.js b/lib/rules/no-debug.js
new file mode 100644
index 00000000..c94ebf9e
--- /dev/null
+++ b/lib/rules/no-debug.js
@@ -0,0 +1,61 @@
+'use strict'
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'disallow using `cy.debug()` calls',
+      category: 'Possible Errors',
+      recommended: false,
+      url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-debug.md',
+    },
+    fixable: null, // or "code" or "whitespace"
+    schema: [],
+    messages: {
+      unexpected: 'Do not use cy.debug command',
+    },
+  },
+
+  create (context) {
+
+    // variables should be defined here
+
+    //----------------------------------------------------------------------
+    // Helpers
+    //----------------------------------------------------------------------
+    function isCallingDebug (node) {
+      return node.callee &&
+        node.callee.property &&
+        node.callee.property.type === 'Identifier' &&
+        node.callee.property.name === 'debug'
+    }
+
+    function isCypressCall (node) {
+      if (!node.callee || node.callee.type !== 'MemberExpression') {
+        return false;
+      }
+      if (node.callee.object.type === 'Identifier' && node.callee.object.name === 'cy') {
+        return true;
+      }
+      return isCypressCall(node.callee.object);
+    }
+    
+    //----------------------------------------------------------------------
+    // Public
+    //----------------------------------------------------------------------
+
+    return {
+
+      CallExpression (node) {
+        if (isCypressCall(node) && isCallingDebug(node)) {
+          context.report({ node, messageId: 'unexpected' })
+        }
+      },
+
+    }
+  },
+}
diff --git a/tests/lib/rules/no-debug.js b/tests/lib/rules/no-debug.js
new file mode 100644
index 00000000..f48693ed
--- /dev/null
+++ b/tests/lib/rules/no-debug.js
@@ -0,0 +1,23 @@
+'use strict'
+
+const rule = require('../../../lib/rules/no-debug')
+const RuleTester = require('eslint').RuleTester
+
+const ruleTester = new RuleTester()
+
+const errors = [{ messageId: 'unexpected' }]
+
+ruleTester.run('no-debug', rule, {
+
+  valid: [
+    { code: `debug()` },
+    { code: `cy.get('button').dblclick()` },
+  ],
+
+  invalid: [
+    { code: `cy.debug()`, errors },
+    { code: `cy.debug({ log: false })`, errors },
+    { code: `cy.get('button').debug()`, errors },
+    { code: `cy.get('a').should('have.attr', 'href').and('match', /dashboard/).debug()`, errors }
+  ],
+})