@git.zone/tstest 1.0.96 → 1.2.0

package/readme.plan.md

@@ -0,0 +1,199 @@
+# Plan for improving logging and output in tstest
+
+!! FIRST: Reread /home/philkunz/.claude/CLAUDE.md to ensure following all guidelines !!
+
+## Goal - ✅ MOSTLY COMPLETED
+- ✅ Make test output cleaner and more visually appealing
+- ✅ Add structured logging capabilities
+- ✅ Support different verbosity levels
+- ✅ Improve CI/CD compatibility
+- ✅ Add progress indicators and timing summaries
+
+## Current State - UPDATED
+- ✅ Clean, modern visual design with Unicode characters
+- ✅ Structured output format (JSON support)
+- ✅ Multiple verbosity levels (quiet, normal, verbose)
+- ✅ Real-time output with cleaner formatting
+- ✅ Better error aggregation and display
+- ✅ TAP protocol support integrated with new logger
+
+## Completed Improvements
+
+### 1. ✅ Created new TsTestLogger class
+- ✅ Centralized logging with consistent formatting
+- ✅ Support for different output modes (normal, quiet, verbose)
+- ✅ Better visual hierarchy with modern Unicode characters
+- ✅ Progress indicators for multiple test files
+- ✅ Structured error collection and display
+
+### 2. ✅ Updated visual design
+- ✅ Replaced heavy separators with cleaner alternatives
+- ✅ Used better emoji and Unicode characters
+- ✅ Added indentation for hierarchical display
+- ✅ Grouped related information visually
+- ✅ Added color coding consistently
+
+### 3. ✅ Added command-line options
+- ✅ `--quiet` for minimal CI-friendly output
+- ✅ `--verbose` for detailed debugging information
+- ✅ `--no-color` for environments without color support
+- ✅ `--json` for structured JSON output
+- ⏳ `--log-file <path>` for persistent logging (TODO)
+
+### 4. ✅ Improved progress feedback
+- ⏳ Show progress bar for multiple files (TODO)
+- ✅ Display current file being executed
+- ✅ Show real-time test counts
+- ⏳ Add ETA for long test suites (TODO)
+
+### 5. ✅ Better error and summary display
+- ✅ Collect all errors and display at end
+- ✅ Show timing metrics and performance summary (in verbose mode)
+- ✅ Highlight slowest tests (in verbose mode)
+- ✅ Add test failure context
+
+### 6. ✅ Browser console integration
+- ✅ Clearly separate browser logs from test output
+- ⏳ Add browser log filtering options (TODO)
+- ✅ Format browser errors specially
+
+## Implementation Steps - COMPLETED
+
+### Phase 1: ✅ Core Logger Implementation
+1. ✅ Created `tstest.logging.ts` with TsTestLogger class
+2. ✅ Added LogOptions interface for configuration
+3. ✅ Implemented basic formatting methods
+4. ✅ Added progress and summary methods
+
+### Phase 2: ✅ Integration
+1. ✅ Updated CLI to accept new command-line options
+2. ✅ Modified TsTest class to use new logger
+3. ✅ Updated TapParser to use structured logging
+4. ✅ Updated TapCombinator for better summaries
+
+### Phase 3: ✅ Visual Improvements
+1. ✅ Replaced all existing separators
+2. ✅ Updated color scheme
+3. ✅ Added emoji and Unicode characters
+4. ✅ Implemented hierarchical output
+
+### Phase 4: ✅ Advanced Features
+1. ✅ Add JSON output format
+2. ⏳ Implement file-based logging (TODO)
+3. ✅ Add performance metrics collection
+4. ✅ Create error aggregation system
+
+### Phase 5: ✅ Browser Integration
+1. ✅ Update browser console forwarding
+2. ✅ Add browser log formatting
+3. ✅ Implement browser-specific indicators
+
+## Files modified
+- ✅ `ts/tstest.logging.ts` - New logger implementation (created)
+- ✅ `ts/index.ts` - Added CLI options parsing
+- ✅ `ts/tstest.classes.tstest.ts` - Integrated new logger
+- ✅ `ts/tstest.classes.tap.parser.ts` - Updated output formatting
+- ✅ `ts/tstest.classes.tap.combinator.ts` - Improved summary display
+- ❌ `ts/tstest.logprefixes.ts` - Still in use, can be deprecated later
+- ❌ `package.json` - No new dependencies needed
+
+## Success Criteria - ACHIEVED
+- ✅ Cleaner, more readable test output
+- ✅ Configurable verbosity levels
+- ✅ Better CI/CD integration
+- ✅ Improved error visibility
+- ✅ Performance metrics available
+- ✅ Consistent visual design
+- ✅ Maintained backward compatibility
+
+## Example Output Comparison
+
+### Current Output
+```
+☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰
+**TSTEST** FOUND 4 TESTFILE(S):
+**TSTEST** test/test.ts
+------------------------------------------------
+=> Running test/test.ts in node.js runtime.
+= = = = = = = = = = = = = = = = = = = = = = = =
+```
+
+### Actual Output (IMPLEMENTED)
+```
+🔍 Test Discovery
+   Mode: directory
+   Pattern: test
+   Found: 4 test file(s)
+
+▶️  test/test.ts (1/4)
+   Runtime: node.js
+   ✅ prepare test (0ms)
+   Summary: 1/1 PASSED
+
+▶️  test/test.single.ts (2/4)
+   Runtime: node.js
+   ✅ single file test execution (1ms)
+   Summary: 1/1 PASSED
+
+📊 Test Summary
+┌────────────────────────────────┐
+│ Total Files:                 4 │
+│ Total Tests:                 4 │
+│ Passed:                      4 │
+│ Failed:                      0 │
+│ Duration:                 5739ms │
+└────────────────────────────────┘
+
+ALL TESTS PASSED! 🎉
+```
+
+### Additional Features Implemented
+
+1. **Quiet Mode**:
+```
+Found 1 tests
+✅ single file test execution
+
+Summary: 1/1 | 1210ms | PASSED
+```
+
+2. **JSON Mode**:
+```json
+{"event":"discovery","count":1,"pattern":"test/test.single.ts","executionMode":"file"}
+{"event":"fileStart","filename":"test/test.single.ts","runtime":"node.js","index":1,"total":1}
+{"event":"testResult","testName":"single file test execution","passed":true,"duration":0}
+{"event":"summary","summary":{"totalFiles":1,"totalTests":1,"totalPassed":1,"totalFailed":0,"totalDuration":1223,"fileResults":[...]}}
+```
+
+3. **Error Display**:
+```
+❌ Failed Tests:
+
+   test/test.fail.ts
+      ❌ This test should fail
+
+SOME TESTS FAILED! ❌
+```
+
+## Summary of Implementation
+
+The logging improvement plan has been successfully implemented with the following achievements:
+
+1. **Created a new centralized TsTestLogger class** that handles all output formatting
+2. **Added multiple output modes**: quiet, normal, verbose, and JSON
+3. **Improved visual design** with modern Unicode characters and emojis
+4. **Added CLI argument parsing** for all new options
+5. **Integrated the logger throughout the codebase** (TsTest, TapParser, TapCombinator)
+6. **Better error aggregation and display** with failed tests shown at the end
+7. **Performance metrics** available in verbose mode
+8. **Clean, hierarchical output** that's much more readable
+
+### Remaining TODOs
+
+Only a few minor features remain unimplemented:
+- File-based logging (--log-file option)
+- Progress bar visualization
+- ETA for long test suites
+- Browser log filtering options
+
+The core logging improvements are complete and provide a much better user experience!

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tstest',
-  version: '1.0.96',
+  version: '1.2.0',
   description: 'a test utility to run tests that match test/**/*.ts'
 }

package/ts/index.ts

@@ -1,10 +1,72 @@
 import { TsTest } from './tstest.classes.tstest.js';
+import type { LogOptions } from './tstest.logging.js';
+
+export enum TestExecutionMode {
+  DIRECTORY = 'directory',
+  FILE = 'file',
+  GLOB = 'glob'
+}
 
 export const runCli = async () => {
-  if (!process.argv[2]) {
-    console.error('You must specify a test directory as argument. Please try again.');
+  // Parse command line arguments
+  const args = process.argv.slice(2);
+  const logOptions: LogOptions = {};
+  let testPath: string | null = null;
+  
+  // Parse options
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    
+    switch (arg) {
+      case '--quiet':
+      case '-q':
+        logOptions.quiet = true;
+        break;
+      case '--verbose':
+      case '-v':
+        logOptions.verbose = true;
+        break;
+      case '--no-color':
+        logOptions.noColor = true;
+        break;
+      case '--json':
+        logOptions.json = true;
+        break;
+      case '--log-file':
+        if (i + 1 < args.length) {
+          logOptions.logFile = args[++i];
+        }
+        break;
+      default:
+        if (!arg.startsWith('-')) {
+          testPath = arg;
+        }
+    }
+  }
+  
+  if (!testPath) {
+    console.error('You must specify a test directory/file/pattern as argument. Please try again.');
+    console.error('\nUsage: tstest <path> [options]');
+    console.error('\nOptions:');
+    console.error('  --quiet, -q     Minimal output');
+    console.error('  --verbose, -v   Verbose output');
+    console.error('  --no-color      Disable colored output');
+    console.error('  --json          Output results as JSON');
+    console.error('  --log-file      Write logs to file');
     process.exit(1);
   }
-  const tsTestInstance = new TsTest(process.cwd(), process.argv[2]);
+  
+  let executionMode: TestExecutionMode;
+  
+  // Detect execution mode based on the argument
+  if (testPath.includes('*') || testPath.includes('?') || testPath.includes('[') || testPath.includes('{')) {
+    executionMode = TestExecutionMode.GLOB;
+  } else if (testPath.endsWith('.ts')) {
+    executionMode = TestExecutionMode.FILE;
+  } else {
+    executionMode = TestExecutionMode.DIRECTORY;
+  }
+  
+  const tsTestInstance = new TsTest(process.cwd(), testPath, executionMode, logOptions);
   await tsTestInstance.run();
 };

package/ts/tstest.classes.tap.combinator.ts

@@ -6,59 +6,37 @@ import { coloredString as cs } from '@push.rocks/consolecolor';
 
 import { TapParser } from './tstest.classes.tap.parser.js';
 import * as logPrefixes from './tstest.logprefixes.js';
+import { TsTestLogger } from './tstest.logging.js';
 
 export class TapCombinator {
   tapParserStore: TapParser[] = [];
+  private logger: TsTestLogger;
+  
+  constructor(logger: TsTestLogger) {
+    this.logger = logger;
+  }
+  
   addTapParser(tapParserArg: TapParser) {
     this.tapParserStore.push(tapParserArg);
   }
 
   evaluate() {
-    console.log(
-      `${logPrefixes.TsTestPrefix} RESULTS FOR ${this.tapParserStore.length} TESTFILE(S):`
-    );
-
-    let failGlobal = false; // determine wether tstest should fail
+    // Call the logger's summary method
+    this.logger.summary();
+    
+    // Check for failures
+    let failGlobal = false;
     for (const tapParser of this.tapParserStore) {
-      if (!tapParser.expectedTests) {
-        failGlobal = true;
-        let overviewString =
-          logPrefixes.TsTestPrefix +
-          cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
-          ` ${plugins.figures.pointer} ` +
-          `does not specify tests!`;
-        console.log(overviewString);
-      } else if (tapParser.expectedTests !== tapParser.receivedTests) {
-        failGlobal = true;
-        let overviewString =
-          logPrefixes.TsTestPrefix +
-          cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
-          ` ${plugins.figures.pointer} ` +
-          tapParser.getTestOverviewAsString() +
-          `did not execute all specified tests!`;
-        console.log(overviewString);
-      } else if (tapParser.getErrorTests().length === 0) {
-        let overviewString =
-          logPrefixes.TsTestPrefix +
-          cs(` ${tapParser.fileName} ${plugins.figures.tick}`, 'green') +
-          ` ${plugins.figures.pointer} ` +
-          tapParser.getTestOverviewAsString();
-        console.log(overviewString);
-      } else {
+      if (!tapParser.expectedTests || 
+          tapParser.expectedTests !== tapParser.receivedTests || 
+          tapParser.getErrorTests().length > 0) {
         failGlobal = true;
-        let overviewString =
-          logPrefixes.TsTestPrefix +
-          cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
-          ` ${plugins.figures.pointer} ` +
-          tapParser.getTestOverviewAsString();
-        console.log(overviewString);
+        break;
       }
     }
-    console.log(cs(plugins.figures.hamburger.repeat(48), 'cyan'));
-    if (!failGlobal) {
-      console.log(cs('FINAL RESULT: SUCCESS!', 'green'));
-    } else {
-      console.log(cs('FINAL RESULT: FAIL!', 'red'));
+    
+    // Exit with error code if tests failed
+    if (failGlobal) {
       process.exit(1);
     }
   }

package/ts/tstest.classes.tap.parser.ts

@@ -7,6 +7,7 @@ import { coloredString as cs } from '@push.rocks/consolecolor';
 import * as plugins from './tstest.plugins.js';
 import { TapTestResult } from './tstest.classes.tap.testresult.js';
 import * as logPrefixes from './tstest.logprefixes.js';
+import { TsTestLogger } from './tstest.logging.js';
 
 export class TapParser {
   testStore: TapTestResult[] = [];
@@ -19,11 +20,15 @@ export class TapParser {
   activeTapTestResult: TapTestResult;
 
   pretaskRegex = /^::__PRETASK:(.*)$/;
+  
+  private logger: TsTestLogger;
 
   /**
    * the constructor for TapParser
    */
-  constructor(public fileName: string) {}
+  constructor(public fileName: string, logger?: TsTestLogger) {
+    this.logger = logger;
+  }
 
   private _getNewTapTestResult() {
     this.activeTapTestResult = new TapTestResult(this.testStore.length + 1);
@@ -45,9 +50,9 @@ export class TapParser {
         logLineIsTapProtocol = true;
         const regexResult = this.expectedTestsRegex.exec(logLine);
         this.expectedTests = parseInt(regexResult[2]);
-        console.log(
-          `${logPrefixes.TapPrefix} ${cs(`Expecting ${this.expectedTests} tests!`, 'blue')}`
-        );
+        if (this.logger) {
+          this.logger.tapOutput(`Expecting ${this.expectedTests} tests!`);
+        }
 
         // initiating first TapResult
         this._getNewTapTestResult();
@@ -55,7 +60,9 @@ export class TapParser {
         logLineIsTapProtocol = true;
         const pretaskContentMatch = this.pretaskRegex.exec(logLine);
         if (pretaskContentMatch && pretaskContentMatch[1]) {
-          console.log(`${logPrefixes.TapPretaskPrefix} Pretask ->${pretaskContentMatch[1]}: Success.`);
+          if (this.logger) {
+            this.logger.tapOutput(`Pretask -> ${pretaskContentMatch[1]}: Success.`);
+          }
         }
       } else if (this.testStatusRegex.test(logLine)) {
         logLineIsTapProtocol = true;
@@ -73,26 +80,20 @@ export class TapParser {
 
         // test for protocol error
         if (testId !== this.activeTapTestResult.id) {
-          console.log(
-            `${logPrefixes.TapErrorPrefix} Something is strange! Test Ids are not equal!`
-          );
+          if (this.logger) {
+            this.logger.error('Something is strange! Test Ids are not equal!');
+          }
         }
         this.activeTapTestResult.setTestResult(testOk);
 
         if (testOk) {
-          console.log(
-            logPrefixes.TapPrefix,
-            `${cs(`T${testId} ${plugins.figures.tick}`, 'green')} ${plugins.figures.arrowRight} ` +
-              cs(testSubject, 'blue') +
-              ` | ${cs(`${testDuration} ms`, 'orange')}`
-          );
+          if (this.logger) {
+            this.logger.testResult(testSubject, true, testDuration);
+          }
         } else {
-          console.log(
-            logPrefixes.TapPrefix,
-            `${cs(`T${testId} ${plugins.figures.cross}`, 'red')} ${plugins.figures.arrowRight} ` +
-              cs(testSubject, 'blue') +
-              ` | ${cs(`${testDuration} ms`, 'orange')}`
-          );
+          if (this.logger) {
+            this.logger.testResult(testSubject, false, testDuration);
+          }
         }
       }
 
@@ -100,7 +101,9 @@ export class TapParser {
         if (this.activeTapTestResult) {
           this.activeTapTestResult.addLogLine(logLine);
         }
-        console.log(logLine);
+        if (this.logger) {
+          this.logger.tapOutput(logLine);
+        }
       }
 
       if (this.activeTapTestResult && this.activeTapTestResult.testSettled) {
@@ -172,38 +175,32 @@ export class TapParser {
 
     // check wether all tests ran
     if (this.expectedTests === this.receivedTests) {
-      console.log(
-        `${logPrefixes.TapPrefix} ${cs(
-          `${this.receivedTests} out of ${this.expectedTests} Tests completed!`,
-          'green'
-        )}`
-      );
+      if (this.logger) {
+        this.logger.tapOutput(`${this.receivedTests} out of ${this.expectedTests} Tests completed!`);
+      }
     } else {
-      console.log(
-        `${logPrefixes.TapErrorPrefix} ${cs(
-          `Only ${this.receivedTests} out of ${this.expectedTests} completed!`,
-          'red'
-        )}`
-      );
+      if (this.logger) {
+        this.logger.error(`Only ${this.receivedTests} out of ${this.expectedTests} completed!`);
+      }
     }
     if (!this.expectedTests) {
-      console.log(cs('Error: No tests were defined. Therefore the testfile failed!', 'red'));
+      if (this.logger) {
+        this.logger.error('No tests were defined. Therefore the testfile failed!');
+      }
     } else if (this.expectedTests !== this.receivedTests) {
-      console.log(
-        cs(
-          'Error: The amount of received tests and expectedTests is unequal! Therefore the testfile failed',
-          'red'
-        )
-      );
+      if (this.logger) {
+        this.logger.error('The amount of received tests and expectedTests is unequal! Therefore the testfile failed');
+      }
     } else if (this.getErrorTests().length === 0) {
-      console.log(`${logPrefixes.TapPrefix} ${cs(`All tests are successfull!!!`, 'green')}`);
+      if (this.logger) {
+        this.logger.tapOutput('All tests are successfull!!!');
+        this.logger.testFileEnd(this.receivedTests, 0, 0);
+      }
     } else {
-      console.log(
-        `${logPrefixes.TapPrefix} ${cs(
-          `${this.getErrorTests().length} tests threw an error!!!`,
-          'red'
-        )}`
-      );
+      if (this.logger) {
+        this.logger.tapOutput(`${this.getErrorTests().length} tests threw an error!!!`, true);
+        this.logger.testFileEnd(this.receivedTests - this.getErrorTests().length, this.getErrorTests().length, 0);
+      }
     }
   }
 }

package/ts/tstest.classes.testdirectory.ts

@@ -1,6 +1,7 @@
 import * as plugins from './tstest.plugins.js';
 import * as paths from './tstest.paths.js';
 import { SmartFile } from '@push.rocks/smartfile';
+import { TestExecutionMode } from './index.js';
 
 // tap related stuff
 import { TapCombinator } from './tstest.classes.tap.combinator.js';
@@ -14,14 +15,14 @@ export class TestDirectory {
   cwd: string;
 
   /**
-   * the relative location of the test dir
+   * the test path or pattern
    */
-  relativePath: string;
+  testPath: string;
 
   /**
-   * the absolute path of the test dir
+   * the execution mode
    */
-  absolutePath: string;
+  executionMode: TestExecutionMode;
 
   /**
    * an array of Smartfiles
@@ -30,27 +31,71 @@ export class TestDirectory {
 
   /**
    * the constructor for TestDirectory
-   * tell it the path
-   * @param pathToTestDirectory
+   * @param cwdArg - the current working directory
+   * @param testPathArg - the test path/pattern
+   * @param executionModeArg - the execution mode
    */
-  constructor(cwdArg: string, relativePathToTestDirectory: string) {
+  constructor(cwdArg: string, testPathArg: string, executionModeArg: TestExecutionMode) {
     this.cwd = cwdArg;
-    this.relativePath = relativePathToTestDirectory;
+    this.testPath = testPathArg;
+    this.executionMode = executionModeArg;
   }
 
   private async _init() {
-    this.testfileArray = await plugins.smartfile.fs.fileTreeToObject(
-      plugins.path.join(this.cwd, this.relativePath),
-      'test*.ts'
-    );
+    switch (this.executionMode) {
+      case TestExecutionMode.FILE:
+        // Single file mode
+        const filePath = plugins.path.isAbsolute(this.testPath) 
+          ? this.testPath 
+          : plugins.path.join(this.cwd, this.testPath);
+        
+        if (await plugins.smartfile.fs.fileExists(filePath)) {
+          this.testfileArray = [await plugins.smartfile.SmartFile.fromFilePath(filePath)];
+        } else {
+          throw new Error(`Test file not found: ${filePath}`);
+        }
+        break;
+        
+      case TestExecutionMode.GLOB:
+        // Glob pattern mode - use listFileTree which supports glob patterns
+        const globPattern = this.testPath;
+        const matchedFiles = await plugins.smartfile.fs.listFileTree(this.cwd, globPattern);
+        
+        this.testfileArray = await Promise.all(
+          matchedFiles.map(async (filePath) => {
+            const absolutePath = plugins.path.isAbsolute(filePath) 
+              ? filePath 
+              : plugins.path.join(this.cwd, filePath);
+            return await plugins.smartfile.SmartFile.fromFilePath(absolutePath);
+          })
+        );
+        break;
+        
+      case TestExecutionMode.DIRECTORY:
+        // Directory mode - now recursive with ** pattern
+        const dirPath = plugins.path.join(this.cwd, this.testPath);
+        const testPattern = '**/test*.ts';
+        
+        const testFiles = await plugins.smartfile.fs.listFileTree(dirPath, testPattern);
+        
+        this.testfileArray = await Promise.all(
+          testFiles.map(async (filePath) => {
+            const absolutePath = plugins.path.isAbsolute(filePath)
+              ? filePath
+              : plugins.path.join(dirPath, filePath);
+            return await plugins.smartfile.SmartFile.fromFilePath(absolutePath);
+          })
+        );
+        break;
+    }
   }
 
   async getTestFilePathArray() {
     await this._init();
     const testFilePaths: string[] = [];
     for (const testFile of this.testfileArray) {
-      const filePath = plugins.path.join(this.relativePath, testFile.path);
-      testFilePaths.push(filePath);
+      // Use the path directly from the SmartFile
+      testFilePaths.push(testFile.path);
     }
     return testFilePaths;
   }