tape-six 1.3.5 → 1.4.1

package/README.md

@@ -34,6 +34,8 @@ with existing unit test libraries:
   - It just workss: modern runtimes (Node, Deno, Bun) support running TypeScript natively without transpilation by ignoring type information and running the code directly.
 - The [DX](https://en.wikipedia.org/wiki/User_experience#Developer_experience) in browsers are usually abysmal.
   - Both console-based debugging and a UI to navigate results are properly supported.
+  - Integration with browser automation tools is supported for automated testing.
+    - Examples for such tools are [Playwright](https://playwright.dev/) and [Puppeteer](https://pptr.dev/) are provided.
 
 ## Docs
 
@@ -230,6 +232,10 @@ The following methods are available (all `msg` arguments are optional):
   - `comment(msg)` — sends a comment to the test harness. Rarely used.
   - `skipTest(...args, msg)` — skips the current test yet sends a message to the test harness.
   - `bailOut(msg)` — stops the test suite and sends a message to the test harness.
+- Evaluators:
+  - `OK(condition, msg, options)` — a high-level helper for evaluating simple expressions.
+    - _Available since 1.4.0._
+    - See [Tester](https://github.com/uhop/tape-six/wiki/Tester) for description and examples.
 
 In all cases, the `msg` message is optional. If it is not provided, some suitable generic message will be used.
 
@@ -312,6 +318,8 @@ Test output can be controlled by flags. See [Supported flags](https://github.com
 
 The most recent releases:
 
+- 1.4.1 _Added browser automation support._
+- 1.4.0 _Added a high-level helper `OK()` for evaluating simple expressions._
 - 1.3.5 _Minor improvements, better docs._
 - 1.3.4 _Minor bugfixes and improvements._
 - 1.3.3 _Added a way to hide console/streams output, better support for file tests, better TTY formatting._

package/index.d.ts

@@ -345,6 +345,25 @@ export declare interface Test {
    */
   resolves(promise: Promise<unknown>, message?: string): Promise<void>;
 
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   * @param message - Message to display if the assertion fails
+   * @param options - Optional options object. `self` is the name of the tester argument, which should be used in the code. Default: `"t"`.
+   */
+  OK(condition: string, message: string, options?: {self?: string}): string;
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   * @param options - Optional options object. `self` is the name of the tester argument, which should be used in the code. Default: `"t"`.
+   */
+  OK(condition: string, options: {self?: string}): string;
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   */
+  OK(condition: string): string;
+
   // aliases
 
   /**
@@ -601,6 +620,44 @@ export declare interface Test {
    * @param message - Optional message to display if the assertion fails
    */
   doesNotReject(promise: Promise<unknown>, message?: string): Promise<void>;
+
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   * @param message - Message to display if the assertion fails
+   * @param options - Optional options object. `self` is the name of the tester argument, which should be used in the code. Default: `"t"`.
+   */
+  TRUE(condition: string, message: string, options?: {self?: string}): string;
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   * @param options - Optional options object. `self` is the name of the tester argument, which should be used in the code. Default: `"t"`.
+   */
+  TRUE(condition: string, options: {self?: string}): string;
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   */
+  TRUE(condition: string): string;
+
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   * @param message - Message to display if the assertion fails
+   * @param options - Optional options object. `self` is the name of the tester argument, which should be used in the code. Default: `"t"`.
+   */
+  ASSERT(condition: string, message: string, options?: {self?: string}): string;
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   * @param options - Optional options object. `self` is the name of the tester argument, which should be used in the code. Default: `"t"`.
+   */
+  ASSERT(condition: string, options: {self?: string}): string;
+  /**
+   * Returns a code as a string for evaluation that checks if the condition is truthy.
+   * @param condition - The JS condition to check as a string
+   */
+  ASSERT(condition: string): string;
 }
 
 export declare interface Test {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tape-six",
-  "version": "1.3.5",
+  "version": "1.4.1",
   "description": "TAP the test harness for the modern JavaScript (ES6).",
   "type": "module",
   "main": "index.js",
@@ -28,7 +28,8 @@
     "test": "node ./bin/tape6.js --flags FO",
     "test:bun": "bun run ./bin/tape6-bun.js --flags FO",
     "test:deno": "deno run -A ./bin/tape6-deno.js --flags FO",
-    "test:chrome": "node tests/puppeteer-chrome.js",
+    "test:puppeteer": "node tests/puppeteer-chrome.js",
+    "test:playwright": "node tests/playwright-chrome.js",
     "ts-check": "tsc --noEmit",
     "ts-test": "node ./bin/tape6.js --flags FO '/ts-tests/test-*.ts'",
     "ts-test:bun": "bun run ./bin/tape6-bun.js --flags FO '/ts-tests/test-*.ts'",
@@ -61,7 +62,14 @@
   ],
   "tape6": {
     "tests": [
-      "/tests/test-*.*js"
+      "/tests/test-*.js",
+      "/tests/test-*.mjs"
+    ],
+    "cli": [
+      "/tests/test-*.cjs"
+    ],
+    "browser": [
+      "/tests/web/test-*.html"
     ],
     "importmap": {
       "imports": {
@@ -72,6 +80,7 @@
   },
   "devDependencies": {
     "@types/node": "^25.0.9",
+    "playwright": "^1.57.0",
     "puppeteer": "^24.35.0",
     "typescript": "^5.9.3"
   }

package/src/OK.js

@@ -0,0 +1,47 @@
+import {Tester, setAliases} from './Tester.js';
+
+// code mostly borrowed from https://github.com/heya/ice/blob/master/assert.js under BSD-3
+
+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,
+        ''
+      )
+      .match(/(\b[a-z_$][a-z_$\d]*\b)/gi) || [];
+  const result = [],
+    resultSet = {};
+  for (const name of vars) {
+    const key = '-' + name;
+    if (name != self && !resultSet[key]) {
+      result.push("'" + name + "':" + name);
+      resultSet[key] = 1;
+    }
+  }
+  return '{' + result.join(',') + '}';
+};
+
+Tester.prototype.OK = function OK(condition, msg, options) {
+  if (typeof condition != 'string') {
+    throw new TypeError('Condition must be a string');
+  }
+  if (typeof msg == 'object') {
+    options = msg;
+    msg = undefined;
+  }
+  const {self = 't'} = options || {};
+  return `(${self}.state.emit({
+  name: ${JSON.stringify(msg || condition)},
+  test: ${self}.testNumber,
+  marker: new Error(),
+  time: ${self}.state.timer.now(),
+  operator: 'ok',
+  fail: !(${condition}),
+  data: {
+    actual: ${listVariables(condition, self)}
+  }
+}))`;
+};
+
+setAliases('OK', 'TRUE, ASSERT');

package/src/Tester.js

@@ -9,7 +9,7 @@ const throwHelper = fn => {
   return null;
 };
 
-class Tester {
+export class Tester {
   constructor(state, testNumber) {
     this.state = state;
     this.testNumber = testNumber;
@@ -400,7 +400,7 @@ class Tester {
 }
 Tester.prototype.any = Tester.prototype._ = any;
 
-const setAliases = (source, aliases) =>
+export const setAliases = (source, aliases) =>
   aliases.split(', ').forEach(alias => (Tester.prototype[alias] = Tester.prototype[source]));
 
 setAliases('ok', 'true, assert');

package/src/test.js

@@ -1,11 +1,13 @@
 import {selectTimer} from './utils/timer.js';
 import State, {StopTest} from './State.js';
-import Tester from './Tester.js';
 import getDeferred from './utils/getDeferred.js';
 import timeout from './utils/timeout.js';
 import {formatTime} from './utils/formatters.js';
 import defer from './utils/defer.js';
 
+import Tester from './Tester.js';
+import './OK.js';
+
 let tests = [],
   reporter = null,
   testCounter = 0,

package/src/utils/config.js

@@ -37,7 +37,7 @@ export const getConfig = async (rootFolder, traceFn) => {
   }
 
   // check well-known files
-  if (!cfg) cfg = {tests: ['/tests/test-*.*js']};
+  if (!cfg) cfg = {tests: ['/tests/test-*.js', '/tests/test-*.mjs'], cli: ['/tests/test-*.cjs']};
 
   return cfg;
 };
@@ -55,6 +55,14 @@ export const resolveTests = async (rootFolder, type, traceFn) => {
     }
   }
 
+  if (type !== 'browser') {
+    if (Array.isArray(cfg.cli)) {
+      patterns = patterns.concat(cfg.cli);
+    } else if (typeof cfg.cli == 'string') {
+      patterns.push(cfg.cli);
+    }
+  }
+
   if (Array.isArray(cfg.tests)) {
     patterns = patterns.concat(cfg.tests);
   } else if (typeof cfg.tests == 'string') {