test: extend cypress examples linting to javascript styles

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

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

@@ -2,23 +2,23 @@ it('has all expected env variables', () => {
   // environmentName is set as workflow environment variable
   // as a precaution we can confirm the variable was set
   expect(Cypress.env('environmentName'), 'environment').to.be.a(
-    'string'
+    'string',
   )
   // and we can confirm its value
   expect(
     Cypress.env('environmentName'),
-    'environment name is staging'
+    'environment name is staging',
   ).to.equal('staging')
 
   // host and port are set via action's "with: env:" parameter
   expect(Cypress.env(), 'full env includes API info').to.deep.include(
     {
       host: 'http://api.dev.local',
-      apiPort: 4222
-    }
+      apiPort: 4222,
+    },
   )
   // we can confirm that host is an url
   expect(Cypress.env('host'), 'host is an URL').to.match(
-    /^https?:\/\//
+    /^https?:\/\//,
   )
 })

examples/env/cypress/e2e/without-env.cy.js

@@ -2,6 +2,6 @@ it('has all expected env variables', () => {
   // environmentName is set as workflow environment variable
   expect(
     Cypress.env('environmentName'),
-    'has environment name'
+    'has environment name',
   ).to.equal('staging')
 })

examples/nextjs/cypress.config.js

@@ -1,9 +1,9 @@
-const { defineConfig } = require("cypress");
+const { defineConfig } = require('cypress')
 
 module.exports = defineConfig({
   fixturesFolder: false,
   e2e: {
     supportFile: false,
     baseUrl: 'http://localhost:3000',
   },
-});
+})

examples/quiet/cypress.config.js

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

examples/quiet/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/wait-on/index.js

@@ -9,15 +9,15 @@ const arg = require('arg')
 
 const args = arg({
   '--port': Number,
-  '--delay': Number
+  '--delay': Number,
 })
 const port = args['--port'] || 3050
 const createServerAfterSeconds = args['--delay'] || 7
 
 log(
   'starting the server at port %d after %d seconds',
   port,
-  createServerAfterSeconds
+  createServerAfterSeconds,
 )
 
 setTimeout(function () {

examples/wait-on/index2.js

@@ -9,7 +9,7 @@ const arg = require('arg')
 
 const args = arg({
   '--port': Number,
-  '--delay': Number
+  '--delay': Number,
 })
 const port = args['--port'] || 3050
 const errorPeriodSeconds = args['--delay'] || 10

examples/wait-on/index3.js

@@ -9,7 +9,7 @@ const arg = require('arg')
 
 const args = arg({
   '--port': Number,
-  '--delay': Number
+  '--delay': Number,
 })
 const port = args['--port'] || 3050
 const errorPeriodSeconds = args['--delay'] || 40

examples/wait-on/index4.js

@@ -8,7 +8,7 @@ const http = require('http')
 const arg = require('arg')
 
 const args = arg({
-  '--port': Number
+  '--port': Number,
 })
 const port = args['--port'] || 3050
 

examples/webpack/webpack.config.js

@@ -3,12 +3,12 @@ module.exports = {
   entry: './src/index.js',
   output: {
     filename: 'bundle.js',
-    path: path.resolve(__dirname, 'dist')
+    path: path.resolve(__dirname, 'dist'),
   },
   devServer: {
     static: {
-      directory:  __dirname
-    }
+      directory:  __dirname,
+    },
   },
-  mode: 'development'
+  mode: 'development',
 }