Merge pull request #1803 from MetRonnie/eslint-no-console

Re-enable ESLint `no-console` & move Cypress component tests to `tests/` dir

Author: oliver-sanders

.eslintrc.cjs

@@ -40,6 +40,12 @@ module.exports = {
         functions: 'only-multiline',
       },
     ],
+    'no-console': [
+      'error',
+      {
+        allow: ['warn', 'error']
+      }
+    ],
     'template-curly-spacing': [
       'off'
     ],
@@ -60,6 +66,6 @@ module.exports = {
     ],
     'cypress/unsafe-to-chain-command': [
       'off'
-    ]
+    ],
   },
 }

.gitignore

@@ -18,6 +18,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 selenium-debug.log*
+vite.config.*.timestamp*
 
 # Coverage
 .nyc_output/

README.md

@@ -69,15 +69,15 @@ There are three groups of tests:
 * Unit tests
   * Simple unit tests for individual functions and classes.
   * **Framework:** [Vitest](https://vitest.dev/)
-  * **Assertions:** [Chai](https://www.chaijs.com/)/[Jest](https://jestjs.io/docs/expect)
+  * **Assertions:** [Chai](https://www.chaijs.com/)/[Vitest](https://vitest.dev/api/expect.html)
   * **Path:** `tests/unit`
   * **Command:** `yarn run test:unit` (watches by default, only re-runs changed file)
     * (To prevent watching, use `yarn vitest run`)
 * Component tests
   * In-browser tests which mount a single Vue component standalone.
   * **Framework:** [Cypress](https://docs.cypress.io/guides/overview/why-cypress)
   * **Assertions:** Chai
-  * **Path:** `cypress/component`
+  * **Path:** `tests/component`
   * **Command:** `yarn run test:component`
     * (For "headless" mode use `yarn cypress run --component --config video=false`)
 * End to end tests

cypress.config.cjs

@@ -33,14 +33,7 @@ module.exports = defineConfig({
           mode: 'development',
         })
       )
-
-      return Object.assign({}, config, {
-        fixturesFolder: 'tests/e2e/fixtures',
-        specPattern: 'tests/e2e/specs',
-        screenshotsFolder: 'tests/e2e/screenshots',
-        videosFolder: 'tests/e2e/videos',
-        supportFile: 'tests/e2e/support/index.js'
-      })
+      return config
     },
     specPattern: 'tests/e2e/specs/**/*.cy.{js,jsx,ts,tsx}',
     supportFile: 'tests/e2e/support/index.js'
@@ -56,6 +49,9 @@ module.exports = defineConfig({
       require('@cypress/code-coverage/task')(on, config)
       return config
     },
+    specPattern: 'tests/component/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'tests/component/support/index.js',
+    indexHtmlFile: 'tests/component/support/component-index.html'
   },
 
   env: {

src/components/graphqlFormGenerator/components/vuetify.js

@@ -206,7 +206,6 @@ export function getComponentProps (gqlType, namedTypes, kinds) {
   if (ret) {
     return ret
   }
-  // eslint-disable-next-line no-console
   console.warn(`Falling back to string for type: ${name}, kind: ${kind}`)
   return namedTypes.String
 }

src/services/workflow.service.js

@@ -167,6 +167,7 @@ class WorkflowService {
       })
     } catch (err) {
       console.error(err)
+      // eslint-disable-next-line no-console
       console.log('retrying introspection query')
       await new Promise(resolve => setTimeout(resolve, 2000))
       return this.loadTypes()
@@ -242,7 +243,6 @@ class WorkflowService {
           callback.init(store, errors)
           for (const error of errors) {
             store.commit('SET_ALERT', new Alert(error[0], 'error'), { root: true })
-            // eslint-disable-next-line no-console
             console.warn(...error)
             subscription.handleViewState(ViewState.ERROR, error('Error presetting view state'))
           }
@@ -358,7 +358,6 @@ class WorkflowService {
                   new Alert(error[0], 'error'),
                   { root: true }
                 )
-                // eslint-disable-next-line no-console
                 console.warn(...error)
               }
             },
@@ -423,7 +422,6 @@ class WorkflowService {
   unsubscribe (query, uid) {
     const subscription = this.subscriptions[query.name]
     if (!subscription) {
-      // eslint-disable-next-line no-console
       console.warn(`Could not unsubscribe [${query.name}]: Not Found`)
       return
     }

src/store/options.js

@@ -49,6 +49,7 @@ const actions = {
     if (alert?.color === 'error') {
       console.error(alert.err)
     } else if (alert) {
+      // eslint-disable-next-line no-console
       console.log(alert.err)
     }
     commit('SET_ALERT', alert)

src/utils/aotf.js

@@ -908,7 +908,6 @@ function _mutateSuccess (message) {
 async function _mutateError (mutationName, err, response) {
   // log the response
   if (response) {
-    // eslint-disable-next-line no-console
     console.error('mutation response', response)
   }
 

src/views/Graph.vue

@@ -709,7 +709,6 @@ export default {
         // something went wrong, allow the layout to retry later
         this.graphID = null
         this.updating = false
-        // eslint-disable-next-line no-console
         console.error(e)
         return
       }

tests/component/.eslintrc.cjs

@@ -0,0 +1,25 @@
+/*
+ * Copyright (C) NIWA & British Crown (Met Office) & Contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+module.exports = {
+  plugins: [
+    'cypress'
+  ],
+  env: {
+    'cypress/globals': true
+  },
+}