supertape 6.12.0 → 7.0.0

package/ChangeLog

@@ -1,3 +1,31 @@
+2022.02.14, v7.0.0
+
+fix:
+- chore(actions) add ability to fix
+
+feature:
+- supertape: check-scopes, check-assertions-count: enable by default
+
+
+2022.01.15, v6.13.1
+
+fix:
+- (supertape) revert: add exit code 5 for skip"
+
+
+2022.01.15, v6.13.0
+
+feature:
+- (supertape) add exit code 5 for skip
+- (@supertape/operator-stub) notCalled: no arg
+
+
+2022.01.14, v6.12.1
+
+fix:
+- (@supertape) engine-loader: windows support
+- (supertape) windows support
+
 2022.01.14, v6.12.0
 
 feature:

package/README.md

@@ -1,19 +1,25 @@
-# 📼 `Supertape` [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
+# 📼 Supertape [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
 
 [NPMURL]: https://npmjs.org/package/supertape "npm"
 [NPMIMGURL]: https://img.shields.io/npm/v/supertape.svg?style=flat&longCache=true
-[BuildStatusURL]: https://github.com/coderaiser/supertape/actions?query=workflow%3A%22Node+CI%22 "Build Status"
-[BuildStatusIMGURL]: https://github.com/coderaiser/supertape/workflows/Node%20CI/badge.svg
+[BuildStatusURL]: https://github.com/coderaiser/putout/actions?query=workflow%3A%22Node+CI%22 "Build Status"
+[BuildStatusIMGURL]: https://github.com/coderaiser/putout/workflows/Node%20CI/badge.svg
+[BuildStatusURL]: https://travis-ci.org/coderaiser/supertape "Build Status"
 [CoverageURL]: https://coveralls.io/github/coderaiser/supertape?branch=master
 [CoverageIMGURL]: https://coveralls.io/repos/coderaiser/supertape/badge.svg?branch=master&service=github
 
-[Tape](https://github.com/substack/tape) compatible [TAP](https://testanything.org/) test runner with superpowers. Contains:
+[![supertape](https://asciinema.org/a/Cgc3rDOfZAeDnJSxzEYpPfBMY.svg)](https://asciinema.org/a/Cgc3rDOfZAeDnJSxzEYpPfBMY)
+
+[Tape](https://github.com/substack/tape)-inspired [TAP](https://testanything.org/)-compatible simplest high speed test runner with superpowers.
+
+📼`Supertape` written from scratch after messing a lot with `tape`, it willing to be compatible with it as much as possible.
+and has a couple differences. It contains:
 
 - 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).
 - shows colored diff when test not `equal` or not `deepEqual`;
 - produces deteiled stack traces for `async functions`;
-- as many `only` as you wish
-- ability to extend
+- as many `only` as you wish;
+- ability to extend;
 - smart timeouts for long running tests 🏃‍♂️(configured with `SUPERTAPE_TIMEOUT`);
 - more natural assertions: `expected, result` -> `result, expected`, for example:
 
@@ -27,8 +33,6 @@ Doesn't contain:
 - aliases, methods list much shorter;
 - `throws`, `doesNotThrows` - use [tryCatch](https://github.com/coderaiser/try-catch), [tryToCatch](https://github.com/coderaiser/try-to-catch) with `equal` instead.
 
-`Supertape` was written from scratch after messing a lot with `tape`, it inspired by `tape` and willing to be compatible with it.
-
 ## Install
 
 ```
@@ -44,8 +48,8 @@ Options
    -v, --version               output version information and exit
    -f, --format                use a specific output format - default: progress-bar/tap on CI
    -r, --require               require module
-   --check-scopes              check that messages contains scope: 'scope: message'
-   --check-assertions-count    check that assertion count is no more then 1
+   --no-check-scopes           do not check that messages contains scope: 'scope: message'
+   --no-check-assertions-count do not check that assertion count is no more then 1
    --no-check-duplicates       do not check messages for duplicates
 ```
 
@@ -63,20 +67,74 @@ test('tape: error', (t) => {
 });
 ```
 
-## Codemod
+## 🤷 How to migrate from `tape`?
+
+You can convert your codebase from `tape` to 📼`Supertape` with help of 🐊[`Putout`](https://github.com/coderaiser/putout), which has built-in [@putout/plugin-tape](https://github.com/coderaiser/putout/tree/master/packages/plugin-tape),
+which has a lot of rules that helps to write tests.
+Here is [result example](https://github.com/coderaiser/cloudcmd/commit/74d56f795d22e98937dce0641ee3c7514a79e9e6).
+
+## `ESLint` rules
+
+[`eslint-plugin-putout`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#readme) has rules for 📼`Supertape`:
+
+- ✅ [`remove-newline-before-t-end`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout/lib/tape-remove-newline-before-t-end#readme)
+- ✅ [`add-newline-before-assertion`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout/lib/tape-add-newline-before-assertion#readme)
+- ✅ [`add-newline-between-tests`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout/lib/tape-add-newline-between-tests#readme)
+
+## Operators
+
+To simplify `supertape` core operators located in separate packages, called `operators`:
+
+Here is a list of built-int operators:
+
+| Package | Version |
+|--------|-------|
+| [`@supertape/operator-stub`](/packages/operator-stub) | [![npm](https://img.shields.io/npm/v/@supertape/operator-stub.svg?maxAge=86400)](https://www.npmjs.com/package/@supertape/operator-stub) |
+
+## Formatters
 
-You can convert your codebase from `tape` to `supertape` with help of a [putout](https://github.com/coderaiser/putout) and built-in [@putout/plugin-tape](https://github.com/coderaiser/putout/tree/master/packages/plugin-tape).
-Here is [example of a result](https://github.com/coderaiser/cloudcmd/commit/74d56f795d22e98937dce0641ee3c7514a79e9e6).
+There is a list of built-int `formatters` to customize output:
+
+| Package | Version |
+|--------|-------|
+| [`@supertape/formatter-tap`](/packages/formatter-tap) | [![npm](https://img.shields.io/npm/v/@supertape/formatter-tap.svg?maxAge=86400)](https://www.npmjs.com/package/@supertape/formatter-tap) |
+| [`@supertape/formatter-fail`](/packages/formatter-fail) | [![npm](https://img.shields.io/npm/v/@supertape/formatter-fail.svg?maxAge=86400)](https://www.npmjs.com/package/@supertape/formatter-fail) |
+| [`@supertape/formatter-short`](/packages/formatter-short) | [![npm](https://img.shields.io/npm/v/@supertape/formatter-short.svg?maxAge=86400)](https://www.npmjs.com/package/@supertape/formatter-short) |
+| [`@supertape/formatter-progress-bar`](/packages/formatter-progress-bar) | [![npm](https://img.shields.io/npm/v/@supertape/formatter-progress-bar.svg?maxAge=86400)](https://www.npmjs.com/package/@supertape/formatter-progress-bar) |
+| [`@supertape/formatter-json-lines`](/packages/formatter-json-lines) | [![npm](https://img.shields.io/npm/v/@supertape/formatter-json-lines.svg?maxAge=86400)](https://www.npmjs.com/package/@supertape/formatter-json-lines) |
 
 ## API
 
 ### Methods
 
-The assertion methods in `supertape` are heavily influenced or copied from the methods
-in [tape](https://github.com/substack/tape).
+The assertion methods in `supertape` are heavily influenced by [tape](https://github.com/substack/tape).
 
 ```js
 const test = require('supertape');
+const {sum} = require('./calc.js');
+
+test('calc: sum', (t) => {
+    const result = sum(1, 2);
+    const expected = 3;
+    
+    t.equal(result, expected);
+    t.end();
+});
+```
+
+or in `ESM`:
+
+```js
+import {test} from 'supertape';
+import {sum} from './calc.js';
+
+test('calc: sum', (t) => {
+    const result = sum(1, 2);
+    const expected = 3;
+    
+    t.equal(result, expected);
+    t.end();
+});
 ```
 
 ## test(name, cb)
@@ -176,9 +234,8 @@ const test = require('supertape');
 
 test('lib: arguments', async (t) => {
     throw Error('hello');
-    // will call t.fail() with an error
-    // will call t.end()
-    t.end();
+    // will call t.fail with an error
+    // will call t.end
 });
 
 test('lib: diff', (t) => {

package/help.json

@@ -3,7 +3,7 @@
     "-v, --version              ": "output version information and exit",
     "-f, --format               ": "use a specific output format - default: progress-bar/tap on CI",
     "-r, --require              ": "require module",
-    "--check-scopes             ": "check that messages contains scope: 'scope: message'",
-    "--check-assertions-count   ": "check that assertion count is no more then 1",
+    "--no-check-scopes          ": "do not check that messages contains scope: 'scope: message'",
+    "--no-check-assertions-count": "do not check that assertion count is no more then 1",
     "--no-check-duplicates      ": "do not check messages for duplicates"
 }

package/lib/cli.js

@@ -2,6 +2,7 @@
 
 const {resolve: resolvePath} = require('path');
 const {once} = require('events');
+const {pathToFileURL} = require('url');
 
 const yargsParser = require('yargs-parser');
 const glob = require('glob');
@@ -166,7 +167,9 @@ async function cli({argv, cwd, stdout, isStop}) {
     const files = removeDuplicates(allFiles);
     
     for (const file of files) {
-        promises.push(simpleImport(resolvePath(cwd, file)));
+        // always resolve before import for windows
+        const resolved = pathToFileURL(resolvePath(cwd, file));
+        promises.push(simpleImport(resolved));
     }
     
     filesCount(files.length);

package/lib/supertape.js

@@ -34,8 +34,8 @@ const defaultOptions = {
     isStop: () => false,
     checkDuplicates: true,
     checkIfEnded: true,
-    checkAssertionsCount: false,
-    checkScopes: false,
+    checkAssertionsCount: true,
+    checkScopes: true,
 };
 
 function _createEmitter({quiet, format, getOperators, isStop}) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "supertape",
-  "version": "6.12.0",
+  "version": "7.0.0",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
-  "description": "📼 Supertape fastest simplest test runner with lots of formatters",
+  "description": "📼 Supertape simplest high speed test runner with superpowers",
   "homepage": "http://github.com/coderaiser/supertape",
   "main": "./lib/supertape.js",
   "exports": {