supertape 8.0.1 → 8.2.0

package/ChangeLog

@@ -1,3 +1,17 @@
+2022.11.14, v8.2.0
+
+feature:
+- supertape: types: improve support of skip, only in WebStorm
+- (package) putout v28.0.0
+- (package) lerna v6.0.1
+
+2022.09.15, v8.1.0
+
+feature:
+- supertape: add ability to return value from operator
+- package: @supertape/operator-stub v3.0.0
+- @supertape/operator-stub: type: Result -> OperationResult
+
 2022.09.07, v8.0.1
 
 feature:

package/README.md

@@ -17,13 +17,12 @@
 📼 **Supertape** is a fast, minimal test runner with the soul of **tape**. It's designed to be as compatible as possible with **tape** while still having some key improvements, such as:
 
 - the ability to work with [ESM Modules](https://nodejs.org/api/esm.html) (take a look at [mock-import](https://github.com/coderaiser/mock-import) for mocking and 🎩[ESCover](https://github.com/coderaiser/escover) for coverage)
-- a number of [built-in pretty output formatters](#formatting)
-- easy [configuration](#list-of-options)
-- the ability to [extend](#extending)
+- a number of [built-in pretty output formatters](#formatters)
+- the ability to [extend](#testextendextensions)
 - showing colored diff when using the [`t.equal()`](#tequalresult-any-expected-any-message-string) and [`t.deepEqual()`](#tdeepequalresult-any-expected-any-message-string) assertion operators
 - detailed stack traces for `async` functions
-- multiple [`test.only`'s](#testonlymessage-string-fn-t-test--void-options-testoptions)
-- [smart timeouts](#supertape_timeout) for long running tests 🏃‍♂️
+- multiple [`test.only`'s](#testonlyname-cb)
+- [smart timeouts](#environment-variables) for long running tests 🏃‍♂️
 - more natural assertions: `expected, result` -> `result, expected`:
 
   ```js
@@ -92,7 +91,7 @@ Here is [result example](https://github.com/coderaiser/cloudcmd/commit/74d56f795
 
 The assertion methods of 📼 **Supertape** are heavily influenced by [**tape**](https://github.com/substack/tape). However, to keep a minimal core of assertions, there are no aliases and some superfluous operators have been removed (such as `t.throws()`).
 
-The following is a list of the base methods maintained by 📼 **Supertape**. Others, such as assertions for stubbing, are maintained in [separate packages](#other-built-in-operators). To add custom assertion operators, see [Extending](#extending).
+The following is a list of the base methods maintained by 📼 **Supertape**. Others, such as assertions for stubbing, are maintained in [special operators](#special-operators). To add custom assertion operators, see [Extending](#testextendextensions).
 
 ### Core Operators
 
@@ -140,7 +139,7 @@ Generates a failing assertion with `message` as a description.
 
 #### `t.end()`
 
-Declares the end of a test explicitly. Must be called exactly once per test. (See: [Single Call to `t.end()`](#single-call-to-tend))
+Declares the end of a test explicitly. Must be called exactly once per test. (See: [Single Call to `t.end()`](#single-tend))
 
 #### `t.match(result: string, pattern: string | RegExp, message?: string)`
 
@@ -248,58 +247,6 @@ test('assertion', (t) => {
 });
 ```
 
-## t.end()
-
-Declare the end of a test explicitly.
-
-## t.fail(msg)
-
-Generate a failing assertion with a message `msg`.
-
-## t.pass(msg)
-
-Generate a passing assertion with a message `msg`.
-
-## t.ok(value, msg)
-
-Assert that `value` is truthy with an optional description of the assertion `msg`.
-
-## t.notOk(value, msg)
-
-Assert that `value` is falsy with an optional description of the assertion `msg`.
-
-## t.match(result, pattern[, msg])
-
-Assert that `pattern: string | regexp` matches `result` with an optional description of the assertion `msg`.
-
-## t.notMatch(result, pattern[, msg])
-
-Assert that `pattern: string | regexp`  not matches `result` with an optional description of the assertion `msg`.
-
-## t.equal(result, expected, msg)
-
-Assert that `Object.is(result, expected)` with an optional description of the assertion `msg`.
-
-## t.notEqual(result, expected, msg)
-
-Assert that `!Object.is(result, expected)` with an optional description of the assertion `msg`.
-
-## t.deepEqual(result, expected, msg)
-
-Assert that `result` and `expected` have the same structure and nested values using
-[node's deepEqual() algorithm](https://github.com/substack/node-deep-equal)
-with strict comparisons (`===`) on leaf nodes and an optional description of the assertion `msg`.
-
-## t.notDeepEqual(result, expected, msg)
-
-Assert that `result` and `expected` do not have the same structure and nested values using
-[node's deepEqual() algorithm](https://github.com/substack/node-deep-equal)
-with strict comparisons (`===`) on leaf nodes and an optional description of the assertion `msg`.
-
-## t.comment(message)
-
-Print a message without breaking the tap output. (Useful when using e.g. `tap-colorize` where output is buffered & `console.log` will print in incorrect order vis-a-vis tap output.)
-
 ## Example
 
 ```js

package/lib/operators.mjs

@@ -179,7 +179,9 @@ const initOperator = (runnerState) => (name) => {
                 return end;
             
             const testState = await fn(...a);
-            return run(name, runnerState, testState);
+            run(name, runnerState, testState);
+            
+            return testState;
         };
     
     return (...a) => {
@@ -193,7 +195,9 @@ const initOperator = (runnerState) => (name) => {
             return end;
         
         const testState = fn(...a);
-        return run(name, runnerState, testState);
+        run(name, runnerState, testState);
+        
+        return testState;
     };
 };
 

package/lib/supertape.d.ts

@@ -39,9 +39,14 @@ type TestOptions = {
 };
 
 declare function test(message: string, fn: (t: Test) => void, options?: TestOptions): void;
+declare const skip: typeof test;
+declare const only: typeof test;
+
 declare namespace test {
-    export var only: typeof test;
-    export var skip: typeof test;
+    export {
+        only,
+        skip,
+    };
 }
 
 export default test;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supertape",
-  "version": "8.0.1",
+  "version": "8.2.0",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "📼 Supertape simplest high speed test runner with superpowers",
   "homepage": "http://github.com/coderaiser/supertape",
@@ -87,7 +87,7 @@
     "montag": "^1.0.0",
     "nodemon": "^2.0.2",
     "pullout": "^4.0.0",
-    "putout": "^27.2.0",
+    "putout": "^28.0.0",
     "runsome": "^1.0.0",
     "try-catch": "^3.0.0",
     "typescript": "^4.4.4"