only show errors with --quite flag

RobAndrewHurst · Nov 12, 2024 · 84fd0cc · 84fd0cc
1 parent abd002e
commit 84fd0cc
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 38 deletions.
diff --git a/example/common.cjs b/example/common.cjs
diff --git a/example/example.mjs b/example/example.mjs
diff --git a/src/core/describe.js b/src/core/describe.js
@@ -17,7 +17,9 @@ export async function describe(description, callback) {
     };
 
     state.pushSuite(suite);
-    console.log(chalk.bold.cyan(`\n${description}`));
+    if (!state.options?.quiet) {
+        console.log(chalk.bold.cyan(`\n${description}`));
+    }
 
     try {
         await Promise.resolve(callback());

diff --git a/src/core/it.js b/src/core/it.js
@@ -25,12 +25,15 @@ export async function it(description, callback) {
         test.status = 'passed';
         test.duration = performance.now() - test.startTime;
         state.passedTests++;
-        console.log(chalk.green(` ✅ ${description} (${test.duration.toFixed(2)}ms)`));
+        if (!state.options?.quiet) {
+            console.log(chalk.green(` ✅ ${description} (${test.duration.toFixed(2)}ms)`));
+        }
     } catch (error) {
         test.status = 'failed';
         test.error = error;
         test.duration = performance.now() - test.startTime;
         state.failedTests++;
+        // Always show errors, even in quiet mode
         console.error(chalk.red(` ⛔ ${description} (${test.duration.toFixed(2)}ms)`));
         console.error(chalk.red(`   ${error.message}`));
     }

diff --git a/src/runners/nodeRunner.js b/src/runners/nodeRunner.js
@@ -34,9 +34,10 @@ async function runTestFile(testFile) {
  * @param {object} [codiConfig={}] - Configuration object
  * @returns {Promise<object|void>} Test results if returnResults is true
  */
-export async function runTests(testDirectory, returnResults = false, codiConfig = {}) {
+export async function runTests(testDirectory, returnResults = false, codiConfig = {}, options = {}) {
     state.resetCounters();
     state.startTimer();
+    state.setOptions(options);
 
     let testFiles = fs.readdirSync(testDirectory, { recursive: true })
         .filter(file => file.endsWith('.mjs'));
@@ -46,26 +47,29 @@ export async function runTests(testDirectory, returnResults = false, codiConfig
         testFiles = testFiles.filter(file => !matcher(file));
     }
 
-    console.log(chalk.bold.magenta(`\nRunning tests in directory: ${chalk.underline(testDirectory)}`));
-    console.log(chalk.bold.magenta(`Found ${testFiles.length} test file(s)\n`));
+    if (!options.quiet) {
+        console.log(chalk.bold.magenta(`\nRunning tests in directory: ${chalk.underline(testDirectory)}`));
+        console.log(chalk.bold.magenta(`Found ${testFiles.length} test file(s)\n`));
+    }
 
     for (const file of testFiles) {
         await runTestFile(path.join(testDirectory, file));
     }
 
-    const summary = {
-        passedTests: state.passedTests,
-        failedTests: state.failedTests,
-        testResults: state.testResults,
-        executionTime: state.getExecutionTime()
-    };
-
+    // Always show the final summary
     console.log(chalk.bold.cyan('\nTest Summary:'));
-    console.log(chalk.green(`  Passed: ${summary.passedTests}`));
-    console.log(chalk.red(`  Failed: ${summary.failedTests}`));
-    console.log(chalk.blue(`  Time: ${summary.executionTime}s`));
+    console.log(chalk.green(`  Passed: ${state.passedTests}`));
+    console.log(chalk.red(`  Failed: ${state.failedTests}`));
+    console.log(chalk.blue(`  Time: ${state.getExecutionTime()}s`));
 
-    if (returnResults) return summary;
+    if (returnResults) {
+        return {
+            passedTests: state.passedTests,
+            failedTests: state.failedTests,
+            testResults: state.testResults,
+            executionTime: state.getExecutionTime()
+        };
+    }
 
     if (state.failedTests > 0) {
         console.log(chalk.red('\nSome tests failed.'));

diff --git a/src/state/TestState.js b/src/state/TestState.js
@@ -24,6 +24,13 @@ class TestState {
 
         /** @type {number|null} Test start time */
         this.startTime = null;
+
+        /** @type {object} options */
+        this.options = {};
+    }
+
+    setOptions(options) {
+        this.options = options;
     }
 
     /**

diff --git a/src/testRunner.js b/src/testRunner.js
@@ -40,6 +40,7 @@ export async function runCLI() {
   const returnResults = process.argv.includes('--returnResults');
   const returnVersion = process.argv.includes('--version');
   const configPathIndex = process.argv.indexOf('--config');
+  const quiet = process.argv.includes('--quiet');
 
   let codiConfig = {};
 
@@ -64,12 +65,16 @@ export async function runCLI() {
     if (err.code !== 'ENOENT') {
       throw err;
     }
-    console.log(chalk.yellow(`No config file found at ${configPath}, proceeding with default settings`));
+    if (!quiet) {
+      console.log(chalk.yellow(`No config file found at ${configPath}, proceeding with default settings`));
+    }
   }
 
-  console.log(chalk.bold.cyan('='.repeat(40)));
-  console.log(chalk.bold.cyan('Running tests...'));
-  console.log(chalk.bold.cyan('='.repeat(40)));
+  if (!quiet) {
+    console.log(chalk.bold.cyan('='.repeat(40)));
+    console.log(chalk.bold.cyan('Running tests...'));
+    console.log(chalk.bold.cyan('='.repeat(40)));
+  }
 
-  await nodeRunTests(testDirectory, returnResults, codiConfig);
+  await nodeRunTests(testDirectory, returnResults, codiConfig, { quiet });
 }
diff --git a/tests/example.test.mjs b/tests/example.test.mjs
@@ -1,12 +1,7 @@
 import { describe, it, assertEqual, assertNotEqual, assertTrue, assertFalse, assertThrows, assertNoDuplicates, runTestFunction } from '../src/testRunner.js';
-import { helloworld } from '../example/example.mjs';
-import pkg from '../example/common.cjs';
-const { helloCommon } = pkg;
 
 // First test suite
 await describe('I am an Example Test Suite', () => {
-  helloworld();
-  helloCommon();
 
   it('should pass equality assertion', () => {
     assertEqual(1, 1, 'Expected 1 to equal 1');