tape-six 1.4.5 → 1.5.0

package/README.md

@@ -380,6 +380,7 @@ Test output can be controlled by flags. See [Supported flags](https://github.com
 
 The most recent releases:
 
+- 1.5.0 _Internal refactoring (moved state to reporters), added type identification of values in the DOM and TTY reporters, multiple minor fixes._
 - 1.4.5 _Internal: added flags support for custom test runners._
 - 1.4.4 _Refreshed the lock file._
 - 1.4.3 _Updated dev dependencies + a minor bugfix._

package/bin/tape6-bun.js

@@ -9,7 +9,6 @@ import {
 } from '../src/utils/config.js';
 
 import {getReporter, setReporter} from '../src/test.js';
-import State, {StopTest} from '../src/State.js';
 import {selectTimer} from '../src/utils/timer.js';
 
 import TestWorker from '../src/bun/TestWorker.js';
@@ -52,7 +51,7 @@ const config = () => {
     const arg = Bun.argv[i];
     if (arg == '-f' || arg == '--flags') {
       if (++i < Bun.argv.length) {
-        flags = Bun.argv[i];
+        flags += Bun.argv[i];
       }
       continue;
     }
@@ -101,11 +100,11 @@ const init = async () => {
   if (!currentReporter) {
     const reporterType = getReporterType(),
       reporterFile = reporters[reporterType] || reporters.tty,
-      CustomReporter = (await import('../src/' + reporterFile)).default,
+      CustomReporter = (await import('../src/reporters/' + reporterFile)).default,
       customOptions =
         reporterType === 'tap' ? {useJson: true, hasColors: !options.monochrome} : options,
       customReporter = new CustomReporter(customOptions);
-    setReporter(customReporter.report.bind(customReporter));
+    setReporter(customReporter);
   }
 
   if (files.length) {
@@ -115,14 +114,6 @@ const init = async () => {
   }
 };
 
-const safeEmit = rootState => event => {
-  try {
-    rootState.emit(event);
-  } catch (error) {
-    if (!(error instanceof StopTest)) throw error;
-  }
-};
-
 const main = async () => {
   config();
   await init();
@@ -132,25 +123,25 @@ const main = async () => {
     console.error('UNHANDLED ERROR:', origin, error)
   );
 
-  const rootState = new State(null, {callback: getReporter(), failOnce: options.failOnce}),
-    worker = new TestWorker(safeEmit(rootState), parallel, options);
+  const reporter = getReporter(),
+    worker = new TestWorker(reporter, parallel, options);
 
-  rootState.emit({type: 'test', test: 0, time: rootState.timer.now()});
+  reporter.report({type: 'test', test: 0});
 
   await new Promise(resolve => {
     worker.done = () => resolve();
     worker.execute(files);
   });
 
-  rootState.emit({
+  const hasFailed = reporter.state && reporter.state.failed > 0;
+
+  reporter.report({
     type: 'end',
     test: 0,
-    time: rootState.timer.now(),
-    fail: rootState.failed > 0,
-    data: rootState
+    fail: hasFailed
   });
 
-  process.exit(rootState.failed > 0 ? 1 : 0);
+  process.exit(hasFailed ? 1 : 0);
 };
 
 main().catch(error => console.error('ERROR:', error));

package/bin/tape6-deno.js

@@ -9,7 +9,6 @@ import {
 } from '../src/utils/config.js';
 
 import {getReporter, setReporter} from '../src/test.js';
-import State, {StopTest} from '../src/State.js';
 import {selectTimer} from '../src/utils/timer.js';
 
 import TestWorker from '../src/deno/TestWorker.js';
@@ -52,7 +51,7 @@ const config = () => {
     const arg = Deno.args[i];
     if (arg == '-f' || arg == '--flags') {
       if (++i < Deno.args.length) {
-        flags = Deno.args[i];
+        flags += Deno.args[i];
       }
       continue;
     }
@@ -101,11 +100,11 @@ const init = async () => {
   if (!currentReporter) {
     const reporterType = getReporterType(),
       reporterFile = reporters[reporterType] || reporters.tty,
-      CustomReporter = (await import('../src/' + reporterFile)).default,
+      CustomReporter = (await import('../src/reporters/' + reporterFile)).default,
       customOptions =
         reporterType === 'tap' ? {useJson: true, hasColors: !options.monochrome} : options,
       customReporter = new CustomReporter(customOptions);
-    setReporter(customReporter.report.bind(customReporter));
+    setReporter(customReporter);
   }
 
   if (files.length) {
@@ -115,14 +114,6 @@ const init = async () => {
   }
 };
 
-const safeEmit = rootState => event => {
-  try {
-    rootState.emit(event);
-  } catch (error) {
-    if (!(error instanceof StopTest)) throw error;
-  }
-};
-
 const main = async () => {
   config();
   await init();
@@ -133,25 +124,25 @@ const main = async () => {
     event.preventDefault();
   });
 
-  const rootState = new State(null, {callback: getReporter(), failOnce: options.failOnce}),
-    worker = new TestWorker(safeEmit(rootState), parallel, options);
+  const reporter = getReporter(),
+    worker = new TestWorker(reporter, parallel, options);
 
-  rootState.emit({type: 'test', test: 0, time: rootState.timer.now()});
+  reporter.report({type: 'test', test: 0});
 
   await new Promise(resolve => {
     worker.done = () => resolve();
     worker.execute(files);
   });
 
-  rootState.emit({
+  const hasFailed = reporter.state && reporter.state.failed > 0;
+
+  reporter.report({
     type: 'end',
     test: 0,
-    time: rootState.timer.now(),
-    fail: rootState.failed > 0,
-    data: rootState
+    fail: hasFailed
   });
 
-  Deno.exit(rootState.failed > 0 ? 1 : 0);
+  Deno.exit(hasFailed ? 1 : 0);
 };
 
 main().catch(error => console.error('ERROR:', error));

package/bin/tape6-node.js

@@ -10,7 +10,6 @@ import {
 } from '../src/utils/config.js';
 
 import {getReporter, setReporter} from '../src/test.js';
-import State, {StopTest} from '../src/State.js';
 import {selectTimer} from '../src/utils/timer.js';
 
 import TestWorker from '../src/node/TestWorker.js';
@@ -53,7 +52,7 @@ const config = () => {
     const arg = process.argv[i];
     if (arg == '-f' || arg == '--flags') {
       if (++i < process.argv.length) {
-        flags = process.argv[i];
+        flags += process.argv[i];
       }
       continue;
     }
@@ -102,11 +101,11 @@ const init = async () => {
   if (!currentReporter) {
     const reporterType = getReporterType(),
       reporterFile = reporters[reporterType] || reporters.tty,
-      CustomReporter = (await import('../src/' + reporterFile)).default,
+      CustomReporter = (await import('../src/reporters/' + reporterFile)).default,
       customOptions =
         reporterType === 'tap' ? {useJson: true, hasColors: !options.monochrome} : options,
       customReporter = new CustomReporter(customOptions);
-    setReporter(customReporter.report.bind(customReporter));
+    setReporter(customReporter);
   }
 
   if (files.length) {
@@ -116,14 +115,6 @@ const init = async () => {
   }
 };
 
-const safeEmit = rootState => event => {
-  try {
-    rootState.emit(event);
-  } catch (error) {
-    if (!(error instanceof StopTest)) throw error;
-  }
-};
-
 const main = async () => {
   config();
   await init();
@@ -133,25 +124,25 @@ const main = async () => {
     console.error('UNHANDLED ERROR:', origin, error)
   );
 
-  const rootState = new State(null, {callback: getReporter(), failOnce: options.failOnce}),
-    worker = new TestWorker(safeEmit(rootState), parallel, options);
+  const reporter = getReporter(),
+    worker = new TestWorker(reporter, parallel, options);
 
-  rootState.emit({type: 'test', test: 0, time: rootState.timer.now()});
+  reporter.report({type: 'test', test: 0});
 
   await new Promise(resolve => {
     worker.done = () => resolve();
     worker.execute(files);
   });
 
-  rootState.emit({
+  const hasFailed = reporter.state && reporter.state.failed > 0;
+
+  reporter.report({
     type: 'end',
     test: 0,
-    time: rootState.timer.now(),
-    fail: rootState.failed > 0,
-    data: rootState
+    fail: hasFailed
   });
 
-  process.exit(rootState.failed > 0 ? 1 : 0);
+  process.exit(hasFailed ? 1 : 0);
 };
 
 main().catch(error => console.error('ERROR:', error));

package/index.js

@@ -10,9 +10,9 @@ import {
   getConfiguredFlag,
   registerNotifyCallback
 } from './src/test.js';
+import {selectTimer} from './src/utils/timer.js';
 import defer from './src/utils/defer.js';
-import State from './src/State.js';
-import TapReporter from './src/TapReporter.js';
+import TapReporter from './src/reporters/TapReporter.js';
 
 const optionNames = {
   f: 'failureOnly',
@@ -71,53 +71,47 @@ const init = async () => {
       const id =
         window.__tape6_id || new URLSearchParams(window.location.search.substring(1)).get('id');
       if (typeof window.__tape6_reporter == 'function') {
-        reporter = event => window.__tape6_reporter(id, event);
+        const reportTo = event => window.__tape6_reporter(id, event),
+          {ProxyReporter} = await import('./src/reporters/ProxyReporter.js');
+        reporter = new ProxyReporter({...options, reportTo});
       } else if (window.parent && typeof window.parent.__tape6_reporter == 'function') {
-        reporter = event => window.parent.__tape6_reporter(id, event);
+        const reportTo = event => window.parent.__tape6_reporter(id, event),
+          {ProxyReporter} = await import('./src/reporters/ProxyReporter.js');
+        reporter = new ProxyReporter({...options, reportTo});
       } else if (options.useJsonL) {
-        const {JSONLReporter} = await import('./src/JSONLReporter.js'),
-          jsonlReporter = new JSONLReporter({...options, originalConsole});
-        reporter = jsonlReporter.report.bind(jsonlReporter);
+        const {JSONLReporter} = await import('./src/reporters/JSONLReporter.js');
+        reporter = new JSONLReporter({...options, originalConsole});
       }
     } else if (isDeno) {
       if (Deno.env.get('TAPE6_JSONL')) {
-        const {JSONLReporter} = await import('./src/JSONLReporter.js'),
-          jsonlReporter = new JSONLReporter({...options, originalConsole});
-        reporter = jsonlReporter.report.bind(jsonlReporter);
+        const {JSONLReporter} = await import('./src/reporters/JSONLReporter.js');
+        reporter = new JSONLReporter({...options, originalConsole});
       } else if (!Deno.env.get('TAPE6_TAP')) {
-        const {TTYReporter} = await import('./src/TTYReporter.js'),
-          ttyReporter = new TTYReporter({...options, originalConsole});
-        reporter = ttyReporter.report.bind(ttyReporter);
+        const {TTYReporter} = await import('./src/reporters/TTYReporter.js');
+        reporter = new TTYReporter({...options, originalConsole});
       }
     } else if (isBun) {
       if (Bun.env.TAPE6_JSONL) {
-        const {JSONLReporter} = await import('./src/JSONLReporter.js'),
-          jsonlReporter = new JSONLReporter({...options, originalConsole});
-        reporter = jsonlReporter.report.bind(jsonlReporter);
+        const {JSONLReporter} = await import('./src/reporters/JSONLReporter.js');
+        reporter = new JSONLReporter({...options, originalConsole});
       } else if (!Bun.env.TAPE6_TAP) {
-        const {TTYReporter} = await import('./src/TTYReporter.js'),
-          ttyReporter = new TTYReporter({...options, originalConsole});
-        reporter = ttyReporter.report.bind(ttyReporter);
+        const {TTYReporter} = await import('./src/reporters/TTYReporter.js');
+        reporter = new TTYReporter({...options, originalConsole});
       }
     } else if (isNode) {
       if (process.env.TAPE6_JSONL) {
-        const {JSONLReporter} = await import('./src/JSONLReporter.js'),
-          jsonlReporter = new JSONLReporter({...options, originalConsole});
-        reporter = jsonlReporter.report.bind(jsonlReporter);
+        const {JSONLReporter} = await import('./src/reporters/JSONLReporter.js');
+        reporter = new JSONLReporter({...options, originalConsole});
       } else if (!process.env.TAPE6_TAP) {
-        const {TTYReporter} = await import('./src/TTYReporter.js'),
-          ttyReporter = new TTYReporter({...options, originalConsole});
-        reporter = ttyReporter.report.bind(ttyReporter);
+        const {TTYReporter} = await import('./src/reporters/TTYReporter.js');
+        reporter = new TTYReporter({...options, originalConsole});
       }
     }
-    if (!reporter) {
-      const tapReporter = new TapReporter({
-        useJson: true,
-        hasColors: !options.monochrome,
-        originalConsole
-      });
-      reporter = tapReporter.report.bind(tapReporter);
-    }
+    reporter ||= new TapReporter({
+      useJson: true,
+      hasColors: !options.monochrome,
+      originalConsole
+    });
     setReporter(reporter);
   }
 
@@ -144,44 +138,43 @@ const init = async () => {
 let settings = null;
 
 const testCallback = async () => {
+  await selectTimer();
   if (!settings) settings = await init();
 
-  const {reporter, options, testFileName} = settings,
-    rootState = new State(null, {callback: reporter, failOnce: options.failOnce});
+  const {reporter, testFileName} = settings;
 
-  rootState.emit({
+  reporter.report({
     type: 'test',
     test: 0,
-    name: testFileName ? 'FILE: /' + testFileName : '',
-    time: rootState.timer.now()
+    name: testFileName ? 'FILE: /' + testFileName : ''
   });
 
   for (;;) {
     const tests = getTests();
     if (!tests.length) break;
     clearTests();
-    const canContinue = await runTests(rootState, tests);
+    const canContinue = await runTests(tests);
     if (!canContinue) break;
     await new Promise(resolve => defer(resolve));
   }
 
-  rootState.emit({
+  const runHasFailed = reporter.state && reporter.state.failed > 0;
+
+  reporter.report({
     type: 'end',
     test: 0,
     name: testFileName ? 'FILE: /' + testFileName : '',
-    time: rootState.timer.now(),
-    fail: rootState.failed > 0,
-    data: rootState
+    fail: runHasFailed
   });
 
   if (typeof Deno == 'object') {
-    rootState.failed > 0 && Deno.exit(1);
+    runHasFailed && Deno.exit(1);
   } else if (typeof Bun == 'object') {
-    rootState.failed > 0 && process.exit(1);
+    runHasFailed && process.exit(1);
   } else if (typeof process == 'object' && process.versions?.node) {
-    rootState.failed > 0 && process.exit(1);
+    runHasFailed && process.exit(1);
   } else if (typeof __tape6_reportResults == 'function') {
-    __tape6_reportResults(rootState.failed > 0 ? 'failure' : 'success');
+    __tape6_reportResults(runHasFailed ? 'failure' : 'success');
   }
 
   registerNotifyCallback(testCallback); // register self again

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tape-six",
-  "version": "1.4.5",
+  "version": "1.5.0",
   "description": "TAP the test harness for the modern JavaScript (ES6).",
   "type": "module",
   "main": "index.js",

package/src/OK.js

@@ -6,7 +6,7 @@ const listVariables = (code, self) => {
   const vars =
     code
       .replace(
-        /(?:\b[A-Z]|\.[a-zA-Z_$])[a-zA-Z_$\d]*\b|\b[a-zA-Z_$][a-zA-Z_$\d]*:|\b(?:function|return|if|else|switch|case|while|for|do|break|continue|var|try|catch|finally|throw|with|debugger|default|this|true|false|null|undefined|typeof|instanceof|in|delete|new|void|arguments|decodeURI|decodeURIComponent|encodeURI|encodeURIComponent|escape|eval|isFinite|isNaN|parseFloat|parseInt|unescape|window|document)\b|'(?:[^'\\]|\\.)*'|"(?:[^"\\]|\\.)*"/g,
+        /(?:\b[A-Z]|\.[a-zA-Z_$])[a-zA-Z_$\d]*\b|\b[a-zA-Z_$][a-zA-Z_$\d]*:|\b(?:function|return|if|else|switch|case|while|for|do|break|continue|var|try|catch|finally|throw|with|debugger|default|this|true|false|null|undefined|typeof|instanceof|in|delete|new|void|arguments|decodeURI|decodeURIComponent|encodeURI|encodeURIComponent|escape|eval|isFinite|isNaN|parseFloat|parseInt|unescape|window|document|const|let|async|await)\b|'(?:[^'\\]|\\.)*'|"(?:[^"\\]|\\.)*"/g,
         ''
       )
       .match(/(\b[a-z_$][a-z_$\d]*\b)/gi) || [];
@@ -31,11 +31,11 @@ Tester.prototype.OK = function OK(condition, msg, options) {
     msg = undefined;
   }
   const {self = 't'} = options || {};
-  return `(${self}.state.emit({
+  return `(${self}.reporter.report({
   name: ${JSON.stringify(msg || condition)},
   test: ${self}.testNumber,
   marker: new Error(),
-  time: ${self}.state.timer.now(),
+  time: ${self}.timer.now(),
   operator: 'ok',
   fail: !(${condition}),
   data: {

package/src/State.js

@@ -4,6 +4,8 @@ export class StopTest extends Error {}
 
 export const signature = 'tape6-!@#$%^&*';
 
+export const isStopTest = error => error instanceof StopTest || error[signature] === signature;
+
 const replacer =
   (seen = new Set()) =>
   (_, value) => {
@@ -56,19 +58,20 @@ const serialize = object => {
   });
 };
 
-class State {
-  constructor(parent, {callback, skip, todo, failOnce}) {
+export class State {
+  constructor(parent, {name, test, time, skip, todo, failOnce, timer}) {
     this.parent = parent;
+    this.name = name || '';
+    this.test = test || 0;
     parent = parent || {};
-    this.callback = callback || parent.callback;
     this.skip = skip || parent.skip;
     this.todo = todo || parent.todo;
     this.failOnce = failOnce || parent.failOnce;
     this.offset = parent.asserts || 0;
-    this.timer = parent.timer || getTimer();
     this.asserts = this.skipped = this.failed = 0;
     this.stopTest = false;
-    this.startTime = this.time = this.timer.now();
+    this.timer = timer || parent.timer || getTimer();
+    this.startTime = this.time = time || this.timer.now();
   }
 
   updateParent() {
@@ -78,23 +81,27 @@ class State {
     this.parent.failed += this.failed;
   }
 
-  emit(event) {
+  preprocess(event) {
     event = {...event, skip: event.skip || this.skip, todo: event.todo || this.todo};
     !event.type && (event.type = 'assert');
 
+    if (typeof event.time !== 'number' || !event.time) {
+      event.time = this.timer.now();
+      delete event.diffTime;
+    }
+
+    if (event.type === 'test') return event;
+
     const isFailed = event.fail && !event.todo && !event.skip;
 
-    switch (event.type) {
-      case 'assert':
-        ++this.asserts;
-        event.skip && ++this.skipped;
-        isFailed && ++this.failed;
-        event.id = this.asserts + this.offset;
-        !event.hasOwnProperty('diffTime') && (event.diffTime = event.time - this.time);
-        break;
-      case 'end':
-        !event.hasOwnProperty('diffTime') && (event.diffTime = event.time - this.startTime);
-        break;
+    if (event.type === 'assert') {
+      ++this.asserts;
+      event.skip && ++this.skipped;
+      isFailed && ++this.failed;
+      event.id = this.asserts + this.offset;
+      typeof event.diffTime !== 'number' && (event.diffTime = event.time - this.time);
+    } else {
+      typeof event.diffTime !== 'number' && (event.diffTime = event.time - this.startTime);
     }
 
     if (
@@ -141,16 +148,23 @@ class State {
       event.stopTest = true;
     }
 
-    this.callback(event);
+    return event;
+  }
 
+  postprocess(event) {
     switch (event.type) {
       case 'assert':
-        if (event.stopTest && event.operator !== 'exception')
-          throw new StopTest('failOnce is activated');
+        if (event.stopTest && event.operator !== 'exception') {
+          const stopTest = new StopTest('failOnce is activated');
+          stopTest[signature] = signature;
+          throw stopTest;
+        }
         this.time = this.timer.now();
         break;
       case 'bail-out':
-        throw new StopTest('bailOut is activated');
+        const stopTest = new StopTest('bailOut is activated');
+        stopTest[signature] = signature;
+        throw stopTest;
     }
   }