Add eslint (#332)

add eslint, start to clean up, re-apply prettier formatting

Co-authored-by: Peter Wolanin <107691+pwolanin@users.noreply.github.com>

Author: pwolanin

.eslintignore

@@ -0,0 +1,8 @@
+node_modules/
+dist/
+build/
+public/
+data-scripts/
+*.min.js
+coverage/
+.nyc_output/

.eslintrc.js

@@ -0,0 +1,64 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'airbnb-base',
+    'plugin:cypress/recommended',
+    'prettier',
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: [
+    'vue',
+    'import',
+    'cypress',
+  ],
+  rules: {
+    // General JavaScript rules
+    'import/no-unresolved': 'off',
+    'import/extensions': 'off',
+    'no-console': 'warn',
+    'no-debugger': 'warn',
+    'prefer-const': 'error',
+    'no-var': 'error',
+    "prefer-destructuring": "off",
+
+    // Cypress specific rules
+    'cypress/no-unnecessary-waiting': 'warn',
+    'cypress/assertion-before-screenshot': 'warn',
+  },
+  overrides: [
+    {
+      files: ['cypress/**/*.js'],
+      env: {
+        'cypress/globals': true,
+      },
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+        'no-unused-expressions': 'off',
+      },
+    },
+    {
+      files: ['src/**/*.vue'],
+      extends: ['plugin:vue/vue3-essential'],
+      rules: {
+        'vue/multi-word-component-names': 'off',
+        'vue/no-v-html': 'off',
+      },
+    },
+  ],
+  ignorePatterns: [
+    'node_modules/',
+    'dist/',
+    'build/',
+    'public/',
+    'data-scripts/',
+  ],
+};

cypress.config.js

@@ -22,14 +22,14 @@ module.exports = defineConfig({
       openMode: 0,
     },
     setupNodeEvents(on, config) {
-      on("dev-server:start", (options) => {
-        return startDevServer({
+      on("dev-server:start", (options) =>
+        startDevServer({
           options,
           viteConfig: {
             configFile: "vite.config.js", // Path to your Vite config file
           },
-        });
-      });
+        }),
+      );
 
       return config;
     },

cypress/e2e/e2e_tests.cy.js

@@ -5,8 +5,8 @@ describe('E2E Tests', () => {
   let demURL;
   let repURL;
   // Set indices for Leaders used in tests
-  let demIndex = 22;
-  let repIndex = 46;
+  const demIndex = 22;
+  const repIndex = 46;
 
   describe('Ward Leaders List', () => {
     beforeEach(() => {
@@ -120,9 +120,9 @@ describe('E2E Tests', () => {
     });
 
     it('should display placeholders when information is missing', () => {
-      let missingData = Object.keys(demLeader).filter(key => demLeader[key] === null || demLeader[key] === undefined);
+      const missingData = Object.keys(demLeader).filter(key => demLeader[key] === null || demLeader[key] === undefined);
       // Look for missing data in fields besides subward and photo
-      let filteredMissingData = missingData.filter(item => !['subWard','photo'].includes(item))
+      const filteredMissingData = missingData.filter(item => !['subWard','photo'].includes(item))
       if (filteredMissingData.length > 0) {
         cy.get('.unknown').should('have.length.at.least', 1);
       }

cypress/support/e2e.js

@@ -1,9 +1,8 @@
 import { mount } from 'cypress/vue';
 import  Api  from '../../src/api';
 import { CONTENTFUL_SPACE_ID, CONTENTFUL_ACCESS_TOKEN } from '../../src/config'
+
 const api = new Api(CONTENTFUL_SPACE_ID, CONTENTFUL_ACCESS_TOKEN)
 
 Cypress.Commands.add('mount', mount);
-Cypress.Commands.add('fetchLeaders', () => {
-    return cy.wrap(api.fetchLeaders());
-});
+Cypress.Commands.add('fetchLeaders', () => cy.wrap(api.fetchLeaders()));