tape-six 1.4.1 → 1.4.2

package/README.md

@@ -16,6 +16,8 @@ Why `tape-six`? It was supposed to be named `tape6` but `npm` does not allow nam
 to existing packages. Instead of eliminating name-squatting they force to use unintuitive and
 unmemorable names. That's why all internal names, environment variables, and public names still use `tape6`.
 
+See [examples in the wiki](https://github.com/uhop/tape-six/wiki/Examples).
+
 ## Rationale
 
 Why another library? Working on projects written in modern JS (with modules) I found several problems
@@ -37,6 +39,66 @@ with existing unit test libraries:
   - 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.
 
+## How it looks
+
+_(The examples below show actual output of test functions. In real life, successful tests are usually hidden and only the final results are shown. Usually failed tests are shown with details and stack traces and the first fail stops testing to speed up the fail-fix cycle. All those details can be configured with settings.)_
+
+Running a test file directly:
+
+```txt
+$ node tests/test-console.js
+○ console test
+  log: log #1
+  ✓ pass - 1.542ms
+  log: log #2
+  err: error #1
+  log: log #2a
+  ✓ should be truthy - 1.725ms
+  log: log #3
+  err: error #2
+✓ console test  2  0  - 4.747ms
+  ♥️   tests: 1, asserts: 2, passed: 2, failed: 0, skipped: 0, todo: 0, time: 6.474ms
+```
+
+Running a test suite:
+
+```txt
+$ npx tape6 tests/test-console.js tests/test-eval.js
+○ FILE: /tests/test-console.js
+  ○ console test
+    log: log #1
+    ✓ pass - 0.338ms
+    log: log #2
+    err: error #1
+    log: log #2a
+    ✓ should be truthy - 0.146ms
+    log: log #3
+    err: error #2
+  ✓ console test  2  0  - 1.286ms
+✓ FILE: /tests/test-console.js  2  0  - 7.411ms
+○ FILE: /tests/test-eval.js
+  ○ OK test
+    ✓ 1 < 2 - 1.28ms
+    ✓ a < b - 0.17ms
+    ✓ a + b + c == "3three" - 0.13ms
+    ✓ d.a < d.b - 0.105ms
+  ✓ OK test  4  0  - 2.695ms
+  ○ OK test with self
+    ✓ internal check - 0.178ms
+    ✓ 1 < 2 - 0.115ms
+  ✓ OK test with self  2  0  - 0.55ms
+✓ FILE: /tests/test-eval.js  6  0  - 5.756ms
+  ♥️   tests: 5, asserts: 8, passed: 8, failed: 0, skipped: 0, todo: 0, time: 108.8ms
+```
+
+More colorful versions (click to see the original screenshots):
+
+<img width="240" height="195" alt="image" src="https://github.com/user-attachments/assets/e10c631b-5035-4acb-b411-6af0e9b4041f" />
+
+And:
+
+<img width="240" height="329" alt="image" src="https://github.com/user-attachments/assets/f3d8ac65-9e6a-499d-837f-0271146da1de" />
+
 ## Docs
 
 The documentation can be found in the [wiki](https://github.com/uhop/tape-six/wiki).
@@ -318,6 +380,7 @@ Test output can be controlled by flags. See [Supported flags](https://github.com
 
 The most recent releases:
 
+- 1.4.2 _Improved documentation._
 - 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._

package/index.d.ts

@@ -348,21 +348,16 @@ export declare interface Test {
   /**
    * 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 message - Optional 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;
+  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
 
@@ -624,40 +619,30 @@ export declare interface Test {
   /**
    * 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 message - Optional 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;
+  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 message - Optional 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;
+  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.4.1",
+  "version": "1.4.2",
   "description": "TAP the test harness for the modern JavaScript (ES6).",
   "type": "module",
   "main": "index.js",

package/src/TTYReporter.js

@@ -397,7 +397,7 @@ export class TTYReporter {
     this.out(
       this.success('  ' + this.successfulAsserts + '  ') +
         this.failure('  ' + this.failedAsserts + '  ') +
-        (this.skippedAsserts ? this.skipped('  ' + this.skippedAsserts + '  ') : '')
+        (this.skippedAsserts ? this.skipped('  ' + this.skippedAsserts + '  ') : '', true)
     );
   }
   makeState(state) {