fix: Adds noconsole rule to guard against casual console.log msgs #625

* Uses eslint-disable-next-line to keep those instances where it makes sense to use console.[log|error] issue #625
hawtio · Oct 19, 2023 · 921e9d2 · 921e9d2
1 parent fd12d90
commit 921e9d2
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 3 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -38,6 +38,7 @@ module.exports = {
         },
       },
     ],
+    'no-console': 'error',
   },
   root: true,
 }
diff --git a/packages/hawtio/scripts/generate-camel-svg-index.js b/packages/hawtio/scripts/generate-camel-svg-index.js
@@ -100,6 +100,7 @@ async function writeToIndex(svgpath, idx) {
 }
 
 if (!fs.existsSync(svgdir)) {
+  // eslint-disable-next-line no-console
   console.error(`${svgdir} does not exist. Exiting`)
   process.exit(1)
 }
@@ -109,4 +110,5 @@ if (fs.existsSync(index)) {
   fs.unlinkSync(index)
 }
 
+// eslint-disable-next-line no-console
 writeToIndex(svgdir, index).catch(console.error)
diff --git a/packages/hawtio/src/core/logging.ts b/packages/hawtio/src/core/logging.ts
@@ -79,13 +79,15 @@ class LocalStorageHawtioLogger implements HawtioLogger {
       const logLevel = this.loadLogLevel()
       jsLogger.setLevel(logLevel)
     } catch (e) {
+      // eslint-disable-next-line no-console
       console.error('Failed to load log level from local storage:', e)
     }
 
     try {
       const childLoggers = this.loadChildLoggers()
       childLoggers.forEach(logger => this.get(logger.name).setLevel(logger.filterLevel))
     } catch (e) {
+      // eslint-disable-next-line no-console
       console.error('Failed to load child loggers from local storage:', e)
     }
 
@@ -99,6 +101,7 @@ class LocalStorageHawtioLogger implements HawtioLogger {
 
     const logLevel = this.LOG_LEVEL_MAP[level]
     if (!logLevel) {
+      // eslint-disable-next-line no-console
       console.error('Unknown log level:', level)
       return this.INFO
     }
@@ -136,6 +139,7 @@ class LocalStorageHawtioLogger implements HawtioLogger {
       if (is(logger, type({ context: object() }))) {
         allLoggers.push(logger.context as unknown as ChildLogger)
       } else {
+        // eslint-disable-next-line no-console
         console.error('Logger does not have context:', logger)
       }
     })

diff --git a/packages/hawtio/src/plugins/camel/endpoints/endpoints-service.ts b/packages/hawtio/src/plugins/camel/endpoints/endpoints-service.ts
@@ -128,9 +128,9 @@ export function createEndpointFromData(
   endPointPath: string,
   parameters: Record<string, string>,
 ) {
-  if (!componentName) console.error('createEndpointFromData: component name must be defined')
+  if (!componentName) log.error('createEndpointFromData: component name must be defined')
 
-  if (!endPointPath) console.error('createEndpointFromData: endpoint path must be defined')
+  if (!endPointPath) log.error('createEndpointFromData: endpoint path must be defined')
 
   log.debug('Have endpoint data ' + JSON.stringify(parameters))
 

diff --git a/packages/hawtio/src/plugins/camel/exchanges/InflightExchanges.test.tsx b/packages/hawtio/src/plugins/camel/exchanges/InflightExchanges.test.tsx
@@ -37,7 +37,6 @@ let canDisplayInflightExchanges = false
 jest.mock('./exchanges-service', () => {
   return {
     getInflightExchanges: jest.fn(async () => {
-      console.log('using mocked getInflightExchanges()')
       return Promise.resolve(xchgs)
     }),
     canBrowseInflightExchanges: jest.fn(async (node: MBeanNode): Promise<boolean> => {

diff --git a/packages/hawtio/src/plugins/shared/__mocks__/connect-service.ts b/packages/hawtio/src/plugins/shared/__mocks__/connect-service.ts
@@ -2,6 +2,7 @@ import { Connection, ConnectionTestResult, Connections, IConnectService } from '
 
 class MockConnectService implements IConnectService {
   constructor() {
+    // eslint-disable-next-line no-console
     console.log('Using mock connect service')
   }
 

diff --git a/packages/hawtio/src/plugins/shared/__mocks__/jolokia-service.ts b/packages/hawtio/src/plugins/shared/__mocks__/jolokia-service.ts
@@ -4,6 +4,7 @@ import jmxCamelResponse from './jmx-camel-tree.json'
 
 class MockJolokiaService implements IJolokiaService {
   constructor() {
+    // eslint-disable-next-line no-console
     console.log('Using mock jolokia service')
   }
 

diff --git a/packages/hawtio/src/setupTests.ts b/packages/hawtio/src/setupTests.ts
@@ -10,6 +10,7 @@ fetchMock.enableMocks()
 
 // Default mock response for every usage of fetch
 fetchMock.mockResponse(req => {
+  // eslint-disable-next-line no-console
   console.log('Mock fetch:', req.url)
   let res = '{}'
   switch (req.url) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -38,6 +38,7 @@ module.exports = { @@
             },
           },
         ],
+        'no-console': 'error',
       },
       root: true,
     }