fix(progress-logger): add info logLevel for ci-keep-alive messages

AriPerkkio · Dec 6, 2020 · ecacd30 · ecacd30
1 parent 6972614
commit ecacd30
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -61,7 +61,7 @@ module.exports = {
     /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
 
-    /** Optional setting for log level. Valid values are verbose, warn, error. Defaults to verbose. */
+    /** Optional setting for log level. Valid values are verbose, info, warn, error. Defaults to verbose. */
     logLevel: 'verbose',
 
     /** Optional boolean flag used to enable caching of cloned repositories. For CIs it's ideal to disable caching. Defauls to true. */

diff --git a/lib/config/config-templates.ts b/lib/config/config-templates.ts
@@ -55,7 +55,7 @@ export const CONFIGURATION_FILE_TEMPLATE =
     /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
 
-    /** Optional setting for log level. Valid values are verbose, warn, error. Defaults to verbose. */
+    /** Optional setting for log level. Valid values are verbose, info, warn, error. Defaults to verbose. */
     logLevel: 'verbose',
 
     /** Optional boolean flag used to enable caching of cloned repositories. For CIs it's ideal to disable caching. Defauls to true. */

diff --git a/lib/config/types.d.ts b/lib/config/types.d.ts
@@ -5,7 +5,7 @@ import { ResultTemplateOptions } from '@file-client/result-templates';
 export const ResultParsers: ['plaintext', 'markdown'];
 export type ResultParser = typeof ResultParsers[number];
 
-export const LogLevels: ['verbose', 'warn', 'error'];
+export const LogLevels: ['verbose', 'info', 'warn', 'error'];
 export type LogLevel = typeof LogLevels[number];
 
 /** Contents of the `eslint-remote-tester.config.js` */

diff --git a/lib/config/validator.ts b/lib/config/validator.ts
@@ -11,7 +11,7 @@ import {
 } from './types';
 
 const RESULT_PARSERS: typeof ResultParsers = ['plaintext', 'markdown'];
-const LOG_LEVELS: typeof LogLevels = ['verbose', 'warn', 'error'];
+const LOG_LEVELS: typeof LogLevels = ['verbose', 'info', 'warn', 'error'];
 
 const DEFAULT_RESULT_PARSER_CLI: ResultParser = 'markdown';
 const DEFAULT_RESULT_PARSER_CI: ResultParser = 'plaintext';

diff --git a/lib/progress-logger/progress-logger.ts b/lib/progress-logger/progress-logger.ts
@@ -25,6 +25,9 @@ function isLogVisible(log: LogMessage): boolean {
         case 'verbose':
             return true;
 
+        case 'info':
+            return ['info', 'warn', 'error'].includes(log.level);
+
         case 'warn':
             return ['warn', 'error'].includes(log.level);
 
@@ -397,13 +400,14 @@ class ProgressLogger {
      * - These are used to avoid CI timeouts
      */
     onCiStatus() {
-        const message = Templates.CI_STATUS_TEMPLATE(
-            this.scannedRepositories,
-            this.tasks
-        );
+        if (['verbose', 'info'].includes(config.logLevel)) {
+            const message = Templates.CI_STATUS_TEMPLATE(
+                this.scannedRepositories,
+                this.tasks
+            );
 
-        // Note that these are never excluded from CI - no matter what `config.logLevel` value is
-        this.listeners.ciKeepAlive.forEach(listener => listener(message));
+            this.listeners.ciKeepAlive.forEach(listener => listener(message));
+        }
     }
 }