chore: add eslint linting for JavaScript (#1323)

Co-authored-by: Jennifer Shehane <[email protected]>

Author: MikeMcC399

.prettierignore

@@ -4,3 +4,5 @@
 /browsers
 /included
 /factory/test-project
+
+**/*.js

circle.yml

@@ -50,6 +50,13 @@ commands:
                       fi
 
 jobs:
+    lint:
+        machine:
+            image: ubuntu-2204:2024.11.1
+        steps:
+            - checkout
+            - run: npm ci
+            - run: npm run lint
     check-factory-versions:
         machine:
             image: ubuntu-2204:2024.11.1
@@ -238,6 +245,7 @@ jobs:
 workflows:
     test:
         jobs:
+            - lint
             - check-factory-versions
             - check-node-override-version
             - test-image:

eslint.config.mjs

@@ -0,0 +1,20 @@
+import globals from 'globals'
+import pluginJs from '@eslint/js'
+import pluginCypress from 'eslint-plugin-cypress/flat'
+import stylistic from '@stylistic/eslint-plugin'
+
+export default [
+  { languageOptions: { globals: globals.node } },
+  pluginJs.configs.recommended,
+  pluginCypress.configs.recommended,
+  stylistic.configs.recommended,
+  { ignores: ['factory/test-project/**/*.js'] },
+  {
+    rules: {
+      '@stylistic/indent': ['error', 2],
+      '@stylistic/comma-dangle': ['error', 'always-multiline'],
+      '@stylistic/quotes': ['error', 'single'],
+      '@stylistic/semi': ['error', 'never'],
+    },
+  },
+]

examples/included-as-non-root/cypress.config.js

@@ -1,4 +1,4 @@
-const { defineConfig } = require('cypress');
+const { defineConfig } = require('cypress')
 
 module.exports = defineConfig({
   downloadsFolder: '/tmp/cypress/downloads',
@@ -8,4 +8,4 @@ module.exports = defineConfig({
   e2e: {
     supportFile: false,
   },
-});
+})

factory/installScripts/chrome/install-chrome-version.js

@@ -1,29 +1,29 @@
 #!/usr/bin/node
-const { spawn } = require('child_process');
+const { spawn } = require('child_process')
 
 const chromeVersion = process.argv.slice(2)[0]
 
 if (!chromeVersion) {
   console.log('No Chrome version provided, skipping Chrome install')
-  return
+  process.exit(0)
 }
 
 if (process.arch !== 'x64') {
   console.log('Not downloading Chrome since we are not on x64. For arm64 status see https://crbug.com/677140')
-  return;
+  process.exit(0)
 }
 
 console.log('Installing Chrome version: ', chromeVersion)
 
 // Insert logic here if needed to run a different install script based on chrome version.
-const install = spawn(`${__dirname}/default.sh`, [chromeVersion], {stdio: 'inherit'})
+const install = spawn(`${__dirname}/default.sh`, [chromeVersion], { stdio: 'inherit' })
 
 install.on('error', function (error) {
   console.log('child process errored with ' + error.toString())
   process.exit(1)
-});
+})
 
 install.on('exit', function (code) {
   console.log('child process exited with code ' + code.toString())
   process.exit(code)
-});
+})

factory/installScripts/cypress/install-cypress-version.js

@@ -1,24 +1,24 @@
 #!/usr/bin/node
-const { spawn } = require('child_process');
+const { spawn } = require('child_process')
 
 const cypressVersion = process.argv.slice(2)[0]
 
 if (!cypressVersion) {
   console.log('No Cypress version provided, skipping Cypress install')
-  return
+  process.exit(0)
 }
 
 console.log('Installing Cypress version ', cypressVersion)
 
 // Insert logic here if needed to run a different install script based on cypress version.
-const install = spawn(`${__dirname}/default.sh`, [cypressVersion], {stdio: 'inherit'})
+const install = spawn(`${__dirname}/default.sh`, [cypressVersion], { stdio: 'inherit' })
 
 install.on('error', function (error) {
   console.log('child process errored with ' + error.toString())
   process.exit(1)
-});
+})
 
 install.on('exit', function (code) {
   console.log('child process exited with code ' + code.toString())
   process.exit(code)
-});
+})

factory/installScripts/edge/install-edge-version.js

@@ -1,29 +1,29 @@
 #!/usr/bin/node
-const { spawn } = require('child_process');
+const { spawn } = require('child_process')
 
 const edgeVersion = process.argv.slice(2)[0]
 
 if (!edgeVersion) {
   console.log('No Edge version provided, skipping Edge install')
-  return
+  process.exit(0)
 }
 
 if (process.arch !== 'x64') {
   console.log('Not downloading Edge since we are not on x64. For arm64 status see https://techcommunity.microsoft.com/t5/discussions/edge-for-linux-arm64/m-p/1532272')
-  return;
+  process.exit(0)
 }
 
 console.log('Installing Edge version: ', edgeVersion)
 
 // Insert logic here if needed to run a different install script based on edge version.
-const install = spawn(`${__dirname}/default.sh`, [edgeVersion], {stdio: 'inherit'})
+const install = spawn(`${__dirname}/default.sh`, [edgeVersion], { stdio: 'inherit' })
 
 install.on('error', function (error) {
   console.log('child process errored with ' + error.toString())
   process.exit(1)
-});
+})
 
 install.on('exit', function (code) {
   console.log('child process exited with code ' + code.toString())
   process.exit(code)
-});
+})

factory/installScripts/firefox/install-firefox-version.js

@@ -1,11 +1,11 @@
 #!/usr/bin/node
-const { spawn } = require('child_process');
+const { spawn } = require('child_process')
 
 const firefoxVersion = process.argv.slice(2)[0]
 
 if (!firefoxVersion) {
   console.log('No Firefox version provided, skipping Firefox install')
-  return
+  process.exit(0)
 }
 
 const architecture = process.arch
@@ -22,22 +22,23 @@ switch (architecture) {
     }
     else {
       console.log(`Firefox ${firefoxVersion} not available for arm64, minimum 136.0 required, skipping download`)
-      return
+      process.exit(0)
     }
+  // eslint-disable-next-line no-fallthrough
   default:
     console.log(`Unsupported architecture ${architecture} for Firefox, skipping download`)
-    return
+    process.exit(0)
 }
 
 console.log(`Installing Firefox version ${firefoxVersion} for ${architecture}`)
 
 // Change in compression from bz2 to xz in Firefox 135.0
 // See https://www.mozilla.org/en-US/firefox/135.0/releasenotes/
 
-let compression = `bz2`
+let compression = 'bz2'
 
 if (firefoxVersion >= '135.0') {
-  compression = `xz`
+  compression = 'xz'
 }
 
 // Insert logic here if needed to run a different install script based on chrome version.
@@ -46,9 +47,9 @@ const install = spawn(`${__dirname}/default.sh`, [firefoxVersion, compression, p
 install.on('error', function (error) {
   console.log('child process errored with ' + error.toString())
   process.exit(1)
-});
+})
 
 install.on('exit', function (code) {
   console.log('child process exited with code ' + code.toString())
   process.exit(code)
-});
+})

factory/installScripts/webkit/install-webkit-version.js

@@ -1,29 +1,29 @@
 #!/usr/bin/node
-const { spawn } = require('child_process');
+const { spawn } = require('child_process')
 
 const webkitVersion = process.argv.slice(2)[0]
 
 if (!webkitVersion) {
   console.log('No Webkit version provided, skipping Webkit install')
-  return
+  process.exit(0)
 }
 
 if (!['arm64', 'x64'].includes(process.arch)) {
   console.log(`Not downloading Webkit since we are on ${process.arch}`)
-  return;
+  process.exit(0)
 }
 
 console.log('Installing Webkit version: ', webkitVersion)
 
 // Insert logic here if needed to run a different install script based on webkit version.
-const install = spawn(`${__dirname}/default.sh`, [webkitVersion], {stdio: 'inherit'})
+const install = spawn(`${__dirname}/default.sh`, [webkitVersion], { stdio: 'inherit' })
 
 install.on('error', function (error) {
   console.log('child process errored with ' + error.toString())
   process.exit(1)
-});
+})
 
 install.on('exit', function (code) {
   console.log('child process exited with code ' + code.toString())
   process.exit(code)
-});
+})

factory/installScripts/yarn/install-yarn-version.js

@@ -1,11 +1,11 @@
 #!/usr/bin/node
-const { spawn } = require('child_process');
+const { spawn } = require('child_process')
 
 const yarnVersion = process.argv.slice(2)[0]
 
 if (!yarnVersion) {
   console.log('No Yarn version provided, skipping Yarn install')
-  return
+  process.exit(0)
 }
 
 if (yarnVersion >= '2') {
@@ -16,14 +16,14 @@ if (yarnVersion >= '2') {
 console.log('Installing Yarn version: ', yarnVersion)
 
 // Insert logic here if needed to run a different install script based on version.
-const install = spawn(`${__dirname}/default.sh`, [yarnVersion], {stdio: 'inherit'})
+const install = spawn(`${__dirname}/default.sh`, [yarnVersion], { stdio: 'inherit' })
 
 install.on('error', function (error) {
   console.log('child process errored with ' + error.toString())
   process.exit(1)
-});
+})
 
 install.on('exit', function (code) {
   console.log('child process exited with code ' + code.toString())
   process.exit(code)
-});
+})