test: extend cypress examples linting to javascript styles (#1385)

Author: MikeMcC399

.prettierignore

@@ -1 +1,4 @@
 /LICENSE.md
+
+examples/**/*.js
+examples/**/*.?js

eslint.config.mjs

@@ -1,6 +1,7 @@
 import globals from 'globals'
 import pluginJs from '@eslint/js'
 import pluginCypress from 'eslint-plugin-cypress/flat'
+import stylistic from '@stylistic/eslint-plugin'
 
 export default [
   pluginJs.configs.recommended,
@@ -17,5 +18,16 @@ export default [
         ...globals.node
       }
     }
+  },
+  {
+    name: 'examples-style',
+    files: ['examples/**/*.js'],
+    ...stylistic.configs.recommended,
+    rules: {
+      '@stylistic/indent': ['error', 2],
+      '@stylistic/comma-dangle': ['error', 'always-multiline'],
+      '@stylistic/quotes': ['error', 'single'],
+      '@stylistic/semi': ['error', 'never'],
+    }
   }
 ]

examples/browser/cypress.config.js

@@ -23,7 +23,7 @@ module.exports = defineConfig({
         log(message) {
           console.log(message)
           return null
-        }
+        },
       })
     },
     supportFile: false,

examples/browser/cypress/e2e/spec.cy.js

@@ -13,10 +13,10 @@ it('works', () => {
   // log the top window's dimensions
   const resolution = Cypress._.pick(top, [
     'innerWidth',
-    'innerHeight'
+    'innerHeight',
   ])
   cy.task(
     'log',
-    `top window inner w, h is ${resolution.innerWidth}x${resolution.innerHeight}`
+    `top window inner w, h is ${resolution.innerWidth}x${resolution.innerHeight}`,
   )
 })

examples/component-tests/cypress.config.js

@@ -1,10 +1,10 @@
-import { defineConfig } from "cypress";
+import { defineConfig } from 'cypress'
 
 export default defineConfig({
   component: {
     devServer: {
-      framework: "react",
-      bundler: "vite",
+      framework: 'react',
+      bundler: 'vite',
     },
   },
-});
+})

examples/config/cypress.config-alternate.js

@@ -7,6 +7,6 @@ module.exports = defineConfig({
     setupNodeEvents() {
       console.log('\nUsing cypress.config-alternate.js config-file')
     },
-    supportFile: false
+    supportFile: false,
   },
 })

examples/config/cypress/e2e/spec-a.cy.js

@@ -2,7 +2,7 @@
 describe('Example config A', () => {
   it('has baseUrl', () => {
     expect(Cypress.config('baseUrl')).to.equal(
-      'http://localhost:3333'
+      'http://localhost:3333',
     )
   })
 

examples/config/cypress/e2e/spec-b.cy.js

@@ -2,7 +2,7 @@
 describe('Example config B', () => {
   it('has baseUrl', () => {
     expect(Cypress.config('baseUrl')).to.equal(
-      'http://localhost:3333'
+      'http://localhost:3333',
     )
   })
 

examples/custom-command/index.js

@@ -6,13 +6,13 @@ const fs = require('fs')
 
 cypress.run().then(results => {
   const summary = _.pickBy(results, (value, key) =>
-    key.startsWith('total')
+    key.startsWith('total'),
   )
   console.log(summary)
   fs.writeFileSync(
     'results.json',
     JSON.stringify(summary, null, 2) + '\n',
-    'utf8'
+    'utf8',
   )
   console.log('saved file results.json')
 })

examples/env/cypress.config.js

@@ -7,7 +7,7 @@ module.exports = defineConfig({
       console.log('logging from cypress.config.js')
       console.log(
         'process.env.CYPRESS_environmentName',
-        process.env.CYPRESS_environmentName
+        process.env.CYPRESS_environmentName,
       )
       console.log('entire config.env', config.env)
     },