tape-six 1.7.2 → 1.7.4

package/README.md

@@ -4,7 +4,7 @@
 [npm-url]: https://npmjs.org/package/tape-six
 
 `tape-six` is a [TAP](https://en.wikipedia.org/wiki/Test_Anything_Protocol)-based library for unit tests.
-It is written in the modern JavaScript for the modern JavaScript and works in [Node](https://nodejs.org/), [Deno](https://deno.land/), [Bun](https://bun.sh/) and browsers.
+It is written in the modern JavaScript for the modern JavaScript and works in [Node](https://nodejs.org/), [Deno](https://deno.land/), [Bun](https://bun.sh/) and browsers. **Zero runtime dependencies.**
 
 It runs ES modules (`import`-based code) natively and supports CommonJS modules transparently using the built-in [ESM](https://nodejs.org/api/esm.html).
 
@@ -37,7 +37,7 @@ with existing unit test libraries:
 - 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.
+    - Examples for [Playwright](https://playwright.dev/) and [Puppeteer](https://pptr.dev/) are provided.
 
 ## How it looks
 
@@ -137,6 +137,8 @@ import test from 'tape-six';
 // const {default: test} = require('tape-six');
 ```
 
+To help port tests from other frameworks, `test()` is aliased as `suite()`, `describe()` and `it()`. When called inside a test body, `test()` and its aliases automatically delegate to the current tester's `t.test()` method. The same applies to `test.skip()`, `test.todo()`, and `test.asPromise()`. Using `t.test()` directly is still preferred because it makes the delegation explicit.
+
 This function registers a test suite. Available options:
 
 - `async test(name, options, testFn)` — registers a test suite to be executed asynchronously.
@@ -162,11 +164,15 @@ The arguments mentioned above are:
   - `name` — the optional name of the test suite. If not provided, it will be set to the name of the test function or `'(anonymous)'`.
     - Can be overridden by the `name` argument.
   - `timeout` — the optional timeout in milliseconds. It is used for asynchronous tests.
-    - If the timeout is exceeded, the test suite will be marked as failed.
-    - **Important:** JavaScript does not provide a generic way to cancel asynchronous operations.
-      When the timeout is exceeded, `tape6` will stop waiting for the test to finish,
-      but it will continue running in the background.
+    - If the timeout is exceeded, `tape6` will use the tester's `signal` to indicate cancellation and stop waiting for the test to finish.
     - The default: no timeout.
+  - Hooks:
+    - `beforeAll` — a function to be executed before all tests in the suite.
+    - `afterAll` — a function to be executed after all tests in the suite.
+    - `beforeEach` — a function to be executed before each test in the suite.
+    - `afterEach` — a function to be executed after each test in the suite.
+    - `before` — an alias for `beforeAll`.
+    - `after` — an alias for `afterAll`.
   - `testFn` — the optional test function to be executed (see below).
     - Can be overridden by the `testFn` argument.
   - `testPromiseFn` — the optional callback-based test function to be executed.
@@ -307,8 +313,11 @@ The following methods are available (all `msg` arguments are optional):
   - `skip(name, options, testFn)` — skips a test suite asynchronously. See `test.skip()` above.
   - `todo(name, options, testFn)` — runs a provisional test suite asynchronously. See `test.todo()` above.
   - `asPromise(name, options, testPromiseFn)` — runs a test suite asynchronously. See `test.asPromise()` above.
+  - Note: top-level `test()` and its aliases auto-delegate to `t.test()` when called inside a test body. Using `t.test()` directly is preferred.
+- Properties:
+  - `signal` — an [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that fires when the test is aborted (e.g. on timeout or bail-out). Use it to cancel pending async operations.
 - Miscellaneous:
-  - `any` — returns the `any` object. It can be used in deep equivalency asserts to match any value.
+  - `any` — a symbol that can be used in deep equivalency asserts to match any value.
     See [deep6's any](https://github.com/uhop/deep6/wiki/any) for details.
     - `_` — an alias of `any`.
   - `plan(n)` — sets the number of tests in the test suite. Rarely used.
@@ -339,7 +348,7 @@ test('Sample test', async t => {
 
 ### Before/after hooks
 
-`tape-six` supports scope-based before/after hooks: `beforeAll`, `afterAll`, `beforeEach`, `afterEach`, which can be used to set-up and tear-down a proper environment for tests. Read all about it in [before and after hooks](https://github.com/uhop/tape-six/wiki/Before-and-after-hooks).
+`tape-six` supports scope-based before/after hooks: `beforeAll`, `afterAll`, `beforeEach`, `afterEach` (with `before`/`after` as aliases for `beforeAll`/`afterAll`), which can be used to set-up and tear-down a proper environment for tests. Like `test()` and its aliases, the top-level hook functions auto-delegate to the current tester when called inside a test body. Using `t.beforeAll()`, etc. is preferred. Read all about it in [before and after hooks](https://github.com/uhop/tape-six/wiki/Before-and-after-hooks).
 
 ### Running tests
 
@@ -411,6 +420,8 @@ Test output can be controlled by flags. See [Supported flags](https://github.com
 
 The most recent releases:
 
+- 1.7.4 _Bug fixes: uncaught exception handling, `StopTest` suppression in parallel runners._
+- 1.7.3 _Bug fixes in reporters, runners, and assertions. Documentation corrections and improvements._
 - 1.7.2 _Minor internal refactoring and fixes._
 - 1.7.1 _Added AI support, added timeout to start test runners, fixed some bugs in the sequential test runner._
 - 1.7.0 _New features: after/before hooks for tests, aliases for `suite()`, `describe()`, `it()`, `tape6-seq` — an in-process sequential test runner. Improvements: stricter monochrome detection, refactoring, bugfixes, updated dev dependencies and the documentation._