fix: output module

Author: kobenguyent

bin/codecept.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
 import { version } from '../lib/codecept.js';
-import { print, error } from '../lib/output.js';
+import * as outputLib from '../lib/output.js';
 import { printError } from '../lib/command/utils.js';
 import * as init from '../lib/command/init.js';
 import * as configMigrate from '../lib/command/configMigrate.js';
@@ -31,10 +31,10 @@ const errorHandler = (fn) => async (...args) => {
 };
 
 if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 12) {
-  error('NodeJS >= 12 is required to run.');
-  print();
-  print('Please upgrade your NodeJS engine');
-  print(`Current NodeJS version: ${process.version}`);
+  outputLib.output.error('NodeJS >= 12 is required to run.');
+  outputLib.print();
+  outputLib.print('Please upgrade your NodeJS engine');
+  outputLib.print(`Current NodeJS version: ${process.version}`);
   process.exit(1);
 }
 

lib/assert/include.js

@@ -29,8 +29,8 @@ class InclusionAssertion extends Assertion {
     }
     err.cliMessage = function () {
       const msg = this.template
-        .replace('{{jar}}', output.colors.bold('{{jar}}'))
-        .replace('{{needle}}', output.colors.bold('{{needle}}'));
+        .replace('{{jar}}', output.output.colors.bold('{{jar}}'))
+        .replace('{{needle}}', output.output.colors.bold('{{needle}}'));
       return template(msg, this.params);
     };
     return err;
@@ -52,7 +52,7 @@ class InclusionAssertion extends Assertion {
     const pattern = new RegExp(`^.*?\n?^.*?\n?^.*?${escapeRegExp(this.params.needle)}.*?$\n?.*$\n?.*$`, 'm');
     const matched = this.params.haystack.match(pattern);
     if (!matched) return err;
-    err.actual = matched[0].replace(this.params.needle, output.colors.bold(this.params.needle));
+    err.actual = matched[0].replace(this.params.needle, output.output.colors.bold(this.params.needle));
     err.actual = `------\n${err.actual}\n------`;
     return err;
   }

lib/cli.js

@@ -5,7 +5,6 @@ import * as output from './output.js';
 import AssertionFailedError from './assert/error.js';
 import * as Codecept from './codecept.js';
 import container from './container.js';
-import {stepShift} from "./output.js";
 
 const { reporters: { Base } } = mocha;
 
@@ -22,35 +21,35 @@ class Cli extends Base {
     if (opts.steps) level = 1;
     if (opts.debug) level = 2;
     if (opts.verbose) level = 3;
-    output.level(level);
+    output.output.level(level);
     const version = Codecept.version();
-    output.print(`CodeceptJS v${version} ${output.standWithUkraine()}`);
-    output.print(`Using test root "${global.codecept_dir}"`);
+    output.output.print(`CodeceptJS v${version} ${output.output.standWithUkraine()}`);
+    output.output.print(`Using test root "${global.codecept_dir}"`);
 
     const showSteps = level >= 1;
 
     if (level >= 2) {
-      output.print(output.styles.debug(`Helpers: ${Object.keys(container.helpers()).join(', ')}`));
-      output.print(output.styles.debug(`Plugins: ${Object.keys(container.plugins()).join(', ')}`));
+      output.output.print(output.output.styles.debug(`Helpers: ${Object.keys(container.helpers()).join(', ')}`));
+      output.output.print(output.output.styles.debug(`Plugins: ${Object.keys(container.plugins()).join(', ')}`));
     }
 
     runner.on('start', () => {
       console.log();
     });
 
     runner.on('suite', (suite) => {
-      output.suite.started(suite);
+      output.output.suite.started(suite);
     });
 
     runner.on('fail', (test) => {
       if (test.ctx.currentTest) {
         this.loadedTests.push(test.ctx.currentTest.uid);
       }
       if (showSteps && test.steps) {
-        return output.scenario.failed(test);
+        return output.output.scenario.failed(test);
       }
       cursor.CR();
-      output.test.failed(test);
+      output.output.test.failed(test);
     });
 
     runner.on('pending', (test) => {
@@ -63,31 +62,31 @@ class Cli extends Base {
       }
       this.loadedTests.push(test.uid);
       cursor.CR();
-      output.test.skipped(test);
+      output.output.test.skipped(test);
     });
 
     runner.on('pass', (test) => {
       if (showSteps && test.steps) {
-        return output.scenario.passed(test);
+        return output.output.scenario.passed(test);
       }
       cursor.CR();
-      output.test.passed(test);
+      output.output.test.passed(test);
     });
 
     if (showSteps) {
       runner.on('test', (test) => {
         currentMetaStep = [];
         if (test.steps) {
-          output.test.started(test);
+          output.output.test.started(test);
         }
       });
 
       if (!codeceptjsEventDispatchersRegistered) {
         codeceptjsEventDispatchersRegistered = true;
 
         event.dispatcher.on(event.bddStep.started, (step) => {
-         // output.stepShift = 2;
-          output.step(step);
+         // output.output.stepShift = 2;
+          output.output.step(step);
         });
 
         event.dispatcher.on(event.step.started, (step) => {
@@ -101,22 +100,22 @@ class Cli extends Base {
 
           for (let i = 0; i < Math.max(currentMetaStep.length, metaSteps.length); i++) {
             if (currentMetaStep[i] !== metaSteps[i]) {
-              output.stepShift = 3 + 2 * i;
+              output.output.stepShift = 3 + 2 * i;
               if (!metaSteps[i]) continue;
               // bdd steps are handled by bddStep.started
               if (metaSteps[i].isBDD()) continue;
-              output.step(metaSteps[i]);
+              output.output.step(metaSteps[i]);
             }
           }
           currentMetaStep = metaSteps;
-          output.stepShift = 3 + 2 * shift;
+          output.output.stepShift = 3 + 2 * shift;
           if (step.helper.constructor.name !== 'ExpectHelper') {
-            output.step(step);
+            output.output.step(step);
           }
         });
 
         event.dispatcher.on(event.step.finished, () => {
-          output.stepShift = 0;
+          output.output.stepShift = 0;
         });
       }
     }
@@ -134,7 +133,7 @@ class Cli extends Base {
               test.opts.skipInfo = {};
             }
             skipTestConfig(test, 'Skipped due to failure in \'before\' hook');
-            output.test.skipped(test);
+            output.output.test.skipped(test);
             skippedCount += 1;
           }
         }
@@ -153,7 +152,7 @@ class Cli extends Base {
 
     // passes
     if (stats.failures) {
-      output.print(output.styles.bold('-- FAILURES:'));
+      output.output.print(output.output.styles.bold('-- FAILURES:'));
     }
 
     const failuresLog = [];
@@ -178,12 +177,12 @@ class Cli extends Base {
             // if (step.status === 'failed') line = '' + line;
             scenarioTrace += `\n${line}`;
           });
-          log += `${output.styles.bold('Scenario Steps')}:${scenarioTrace}\n`;
+          log += `${output.output.styles.bold('Scenario Steps')}:${scenarioTrace}\n`;
         }
 
         // display artifacts in debug mode
         if (test?.artifacts && Object.keys(test.artifacts).length) {
-          log += `\n${output.styles.bold('Artifacts:')}`;
+          log += `\n${output.output.styles.bold('Artifacts:')}`;
           for (const artifact of Object.keys(test.artifacts)) {
             log += `\n- ${artifact}: ${test.artifacts[artifact]}`;
           }
@@ -194,11 +193,11 @@ class Cli extends Base {
           stack.shift();
         }
 
-        if (output.level() < 3) {
+        if (output.output.level() < 3) {
           stack = stack.slice(0, 3);
         }
 
-        err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`;
+        err.stack = `${stack.join('\n')}\n\n${output.output.colors.blue(log)}`;
 
         // clone err object so stack trace adjustments won't affect test other reports
         test.err = err;
@@ -216,10 +215,10 @@ class Cli extends Base {
     }
 
     event.emit(event.all.failures, { failuresLog, stats });
-    output.result(stats.passes, stats.failures, stats.pending, ms(stats.duration));
+    output.output.result(stats.passes, stats.failures, stats.pending, ms(stats.duration));
 
-    if (stats.failures && output.level() < 3) {
-      output.print(output.styles.debug('Run with --verbose flag to see complete NodeJS stacktrace'));
+    if (stats.failures && output.output.level() < 3) {
+      output.output.print(output.output.styles.debug('Run with --verbose flag to see complete NodeJS stacktrace'));
     }
   }
 }

lib/codecept.js

@@ -97,7 +97,9 @@ export default class Codecept {
    * @param {string} dir
    */
   initGlobals(dir) {
+    // @ts-ignore
     global.codecept_dir = dir;
+    // @ts-ignore
     global.output_dir = fsPath.resolve(dir, this.config.output);
 
     if (this.config.emptyOutputFolder) emptyFolder(global.output_dir);
@@ -231,7 +233,7 @@ export default class Codecept {
         event.emit(event.all.before, this);
         mocha.run(() => done());
       } catch (e) {
-        output.error(e.stack);
+        output.output.error(e.stack);
         reject(e);
       }
     });

lib/command/configMigrate.js

@@ -4,34 +4,34 @@ import inquirer from 'inquirer';
 import mkdirp from 'mkdirp';
 import path from 'path';
 import util from 'util';
-import { print, success, error } from '../output.js';
+import * as outputLib from '../output.js';
 import { fileExists } from '../utils.js';
 import { getTestRoot } from './utils.js';
 
 export default function (initPath) {
   const testsPath = getTestRoot(initPath);
 
-  print();
-  print(`  Welcome to ${colors.magenta.bold('CodeceptJS')} configuration migration tool`);
-  print(`  It will help you switch from ${colors.cyan.bold('.json')} to ${colors.magenta.bold('.js')} config format at ease`);
-  print();
+  outputLib.print();
+  outputLib.print(`  Welcome to ${colors.magenta.bold('CodeceptJS')} configuration migration tool`);
+  outputLib.print(`  It will help you switch from ${colors.cyan.bold('.json')} to ${colors.magenta.bold('.js')} config format at ease`);
+  outputLib.print();
 
   if (!path) {
-    print('No config file is specified.');
-    print(`Test root is assumed to be ${colors.yellow.bold(testsPath)}`);
-    print('----------------------------------');
+    outputLib.print('No config file is specified.');
+    outputLib.print(`Test root is assumed to be ${colors.yellow.bold(testsPath)}`);
+    outputLib.print('----------------------------------');
   } else {
-    print(`Migrating ${colors.magenta.bold('.js')} config to ${colors.bold(testsPath)}`);
+    outputLib.print(`Migrating ${colors.magenta.bold('.js')} config to ${colors.bold(testsPath)}`);
   }
 
   if (!fileExists(testsPath)) {
-    print(`Directory ${testsPath} does not exist, creating...`);
+    outputLib.print(`Directory ${testsPath} does not exist, creating...`);
     mkdirp.sync(testsPath);
   }
 
   const configFile = path.join(testsPath, 'codecept.conf.js');
   if (fileExists(configFile)) {
-    error(`Config is already created at ${configFile}`);
+    outputLib.output.error(`Config is already created at ${configFile}`);
     return;
   }
 
@@ -55,12 +55,12 @@ export default function (initPath) {
 
       const finish = () => {
         fs.writeFileSync(configFile, `exports.config = ${util.inspect(config, false, 4, false)}`, 'utf-8');
-        success(`Config is successfully migrated at ${configFile}`);
+        outputLib.output.success(`Config is successfully migrated at ${configFile}`);
 
         if (result.delete) {
           if (fileExists(jsonConfigFile)) {
             fs.unlinkSync(jsonConfigFile);
-            success('JSON config file is deleted!');
+            outputLib.output.success('JSON config file is deleted!');
           }
         }
       };

lib/command/init.js

@@ -5,7 +5,7 @@ import mkdirp from 'mkdirp';
 import path from 'path';
 import { inspect } from 'util';
 import spawn from 'cross-spawn';
-import { print, success, error } from '../output.js';
+import * as output from '../output.js';
 import { fileExists, beautify, installedLocally } from '../utils.js';
 import { getTestRoot } from './utils.js';
 import generateDefinitions from './definitions.js';

lib/command/utils.js

@@ -19,7 +19,7 @@ export const readConfig = function (configFile) {
     const data = fs.readFileSync(configFile, 'utf8');
     return data;
   } catch (err) {
-    output.error(err);
+    output.output.error(err);
   }
 };
 
@@ -32,7 +32,7 @@ function getTestRoot(currentPath) {
 export { getTestRoot };
 
 function fail(msg) {
-  output.error(msg);
+  output.output.error(msg);
   process.exit(1);
 }
 
@@ -43,22 +43,22 @@ function updateConfig(testsPath, config, key, extension = 'js') {
   if (!fileExists(configFile)) {
     console.log();
     const msg = `codecept.conf.${extension} config can\'t be updated automatically`;
-    console.log(`${output.colors.bold.red(msg)}`);
+    console.log(`${output.output.colors.bold.red(msg)}`);
     console.log('Please update it manually:');
     console.log();
     console.log(`${key}: ${config[key]}`);
     console.log();
     return;
   }
-  console.log(`${output.colors.yellow('Updating configuration file...')}`);
+  console.log(`${output.output.colors.yellow('Updating configuration file...')}`);
   return fs.writeFileSync(configFile, beautify(`exports.config = ${util.inspect(config, false, 4, false)}`), 'utf-8');
 }
 
 export { updateConfig };
 
 function safeFileWrite(file, contents) {
   if (fileExists(file)) {
-    output.error(`File ${file} already exist, skipping...`);
+    output.output.error(`File ${file} already exist, skipping...`);
     return false;
   }
   fs.writeFileSync(file, contents);
@@ -86,9 +86,9 @@ export const captureStream = (stream) => {
 
 export const printError = (err) => {
   output.print('');
-  output.error(err.message);
+  output.output.error(err.message);
   output.print('');
-  output.print(output.colors.grey(err.stack.replace(err.message, '')));
+  output.print(output.output.colors.grey(err.stack.replace(err.message, '')));
 };
 
 export const createOutputDir = (config, testRoot) => {

lib/event.js

@@ -1,7 +1,7 @@
 import debug from 'debug';
 
 import events from 'events';
-import { error } from './output.js';
+import * as output from './output.js';
 
 debug('codeceptjs:event');
 
@@ -170,7 +170,7 @@ export function emit(event, param) {
   try {
     dispatcher.emit.apply(dispatcher, arguments);
   } catch (err) {
-    error(`Error processing ${event} event:`);
-    error(err.stack);
+    output.output.error(`Error processing ${event} event:`);
+    output.output.error(err.stack);
   }
 }