chore: extend linting to cypress examples (#1373)

* chore: add examples linting * remove unused setupnodeevents or parameters * selective disable cypress/no-unnecessary-waiting
cypress-io · Feb 26, 2025 · 013dd06 · 013dd06
1 parent d9accb7
commit 013dd06
Show file tree

Hide file tree

Showing 29 changed files with 42 additions and 24 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -1,11 +1,16 @@
 import globals from 'globals'
 import pluginJs from '@eslint/js'
+import pluginCypress from 'eslint-plugin-cypress/flat'
 
 export default [
   pluginJs.configs.recommended,
-  { name: 'global-ignores', ignores: ['dist/', 'examples/'] },
+  pluginCypress.configs.recommended,
   {
-    name: `all-js`,
+    name: 'global-ignores',
+    ignores: ['dist/', 'examples/nextjs/src/app/']
+  },
+  {
+    name: 'all-js',
     languageOptions: {
       globals: {
         ...globals.browser,

diff --git a/examples/basic-pnpm/cypress.config.js b/examples/basic-pnpm/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
   },
 })
diff --git a/examples/basic/cypress.config.js b/examples/basic/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
   },
 })
diff --git a/examples/browser/cypress.config.js b/examples/browser/cypress.config.js
@@ -4,7 +4,7 @@ const os = require('os')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {
+    setupNodeEvents(on) {
       on('before:browser:launch', (browser, launchOptions) => {
         console.log('before launching browser')
         console.log(browser)

diff --git a/examples/config/cypress.config-alternate.js b/examples/config/cypress.config-alternate.js
@@ -4,7 +4,7 @@ module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
     baseUrl: 'http://localhost:3333',
-    setupNodeEvents(on, config) {
+    setupNodeEvents() {
       console.log('\nUsing cypress.config-alternate.js config-file')
     },
     supportFile: false

diff --git a/examples/config/cypress.config.js b/examples/config/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
   },
 })
diff --git a/examples/custom-command/cypress.config.js b/examples/custom-command/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
   },
 })
diff --git a/examples/install-command/cypress.config.js b/examples/install-command/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'https://example.cypress.io/',
   },

diff --git a/examples/install-only/cypress.config.js b/examples/install-only/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'https://example.cypress.io/',
   },

diff --git a/examples/node-versions/cypress.config.js b/examples/node-versions/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
   },
 })
diff --git a/examples/quiet/cypress.config.js b/examples/quiet/cypress.config.js
@@ -3,7 +3,7 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {
+    setupNodeEvents(on) {
       on('task', {
         log(message) {
           console.log(message)

diff --git a/examples/recording/cypress.config.js b/examples/recording/cypress.config.js
@@ -4,7 +4,6 @@ module.exports = defineConfig({
   fixturesFolder: false,
   projectId: '3tb7jn',
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
   },
 })
diff --git a/examples/recording/cypress/e2e/spec-a.cy.js b/examples/recording/cypress/e2e/spec-a.cy.js
@@ -1,4 +1,5 @@
 it('spec-A works', () => {
   expect(42).to.equal(21 + 21)
+  // eslint-disable-next-line cypress/no-unnecessary-waiting
   cy.visit('https://example.cypress.io').wait(2000)
 })
diff --git a/examples/recording/cypress/e2e/spec-b.cy.js b/examples/recording/cypress/e2e/spec-b.cy.js
@@ -1,4 +1,5 @@
 it('spec-B works', () => {
   expect(42).to.equal(21 + 21)
+  // eslint-disable-next-line cypress/no-unnecessary-waiting
   cy.visit('https://example.cypress.io').wait(5000)
 })
diff --git a/examples/recording/cypress/e2e/spec-c.cy.js b/examples/recording/cypress/e2e/spec-c.cy.js
@@ -1,4 +1,5 @@
 it('spec-C works', () => {
   expect(42).to.equal(21 + 21)
+  // eslint-disable-next-line cypress/no-unnecessary-waiting
   cy.visit('https://example.cypress.io').wait(4000)
 })
diff --git a/examples/recording/cypress/e2e/spec-d.cy.js b/examples/recording/cypress/e2e/spec-d.cy.js
@@ -1,4 +1,5 @@
 it('spec-D works', () => {
   expect(42).to.equal(21 + 21)
+  // eslint-disable-next-line cypress/no-unnecessary-waiting
   cy.visit('https://example.cypress.io').wait(3600)
 })
diff --git a/examples/start-and-pnpm-workspaces/packages/workspace-1/cypress.config.js b/examples/start-and-pnpm-workspaces/packages/workspace-1/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:5000',
   },

diff --git a/examples/start-and-pnpm-workspaces/packages/workspace-2/cypress.config.js b/examples/start-and-pnpm-workspaces/packages/workspace-2/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:5000',
   },

diff --git a/examples/start-and-yarn-workspaces/workspace-1/cypress.config.js b/examples/start-and-yarn-workspaces/workspace-1/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:5000',
   },

diff --git a/examples/start-and-yarn-workspaces/workspace-2/cypress.config.js b/examples/start-and-yarn-workspaces/workspace-2/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:5000',
   },

diff --git a/examples/start/cypress.config.js b/examples/start/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:3000',
   },

diff --git a/examples/wait-on-vite/cypress.config.js b/examples/wait-on-vite/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:5173',
   },

diff --git a/examples/wait-on/cypress.config.js b/examples/wait-on/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:3050',
   },

diff --git a/examples/webpack/cypress.config.js b/examples/webpack/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'http://localhost:8080',
   },

diff --git a/examples/yarn-classic/cypress.config.js b/examples/yarn-classic/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'https://example.cypress.io/',
   },

diff --git a/examples/yarn-modern-pnp/cypress.config.js b/examples/yarn-modern-pnp/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'https://example.cypress.io/',
   },

diff --git a/examples/yarn-modern/cypress.config.js b/examples/yarn-modern/cypress.config.js
@@ -3,7 +3,6 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
-    setupNodeEvents(on, config) {},
     supportFile: false,
     baseUrl: 'https://example.cypress.io/',
   },

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -51,6 +51,7 @@
     "@types/node": "22.13.5",
     "@vercel/ncc": "0.38.1",
     "eslint": "9.21.0",
+    "eslint-plugin-cypress": "4.1.0",
     "globals": "16.0.0",
     "husky": "9.1.7",
     "markdown-link-check": "3.13.6",