@exodus/test 1.0.0-rc.29 → 1.0.0-rc.3

package/README.md

@@ -1,44 +1,18 @@
 # @exodus/test
 
-A runner for `node:test`, `jest`, and `tape` test suites on top of `node:test`
-
 Most likely it will just work on your simple jest tests as as drop-in replacement
 
-Comes with typescript support, optional esm/cjs interop, and also loading babel transforms!
-
-Use `--coverage` to generate coverage output
-
-Default `NODE_ENV` value is "test", use `NODE_ENV=` to override (e.g. to empty)
-
 ## Library
 
-### Using with `node:test` natively
-
-You can just use pure [`node:test`](https://nodejs.org/api/test.html) in your tests,
-this runner is fully compatible with that (and will set version-specific options for you)!
-
 ### Moving from jest
 
-```js
-import {
-  jest,
-  expect,
-  describe,
-  it,
-  beforeEach,
-  afterEach,
-  beforeAll,
-  afterAll,
-} from '@exodus/test/jest'
-```
-
-Or, run with [`--jest` option](#options) to register jest globals
+`import { describe, it, assert, jest, expect } from '@exodus/test'`
 
 ### Moving from tap/tape
 
-```js
-import test from '@exodus/test/tap'
-```
+`import { tap as test } from '@exodus/test'`
+
+Not all features might be supported
 
 ### Running tests asynchronously
 
@@ -46,34 +20,41 @@ Add `{ concurrency: true }`, like this: `describe('my testsuite', { concurrency:
 
 ### List of exports
 
-- `@exodus/test/jest` -- `jest` mock
+Adapters:
+
+- `jest` -- jest mock adapter
+- `tap` -- tap/tape adapter
+- `mock`
 
-- `@exodus/test/tape` -- `tape` mock (can also be helpful when moving from `tap`)
+Assertions:
+
+- `assert` -- alias for `node:assert/strict`
+- `expect` -- expect with additional features for function mocks
+
+Suite:
+
+- `describe`
+- `test`
+- `it` -- alias for `test`
+- `beforeEach`
+- `afterEach`
+- `before` -- alias for `beforeAll`
+- `after` -- alias for `afterAll`
 
 ## Binary
 
-Just use `"test": "exodus-test"`
+Just use `"test: "exodus-test"`
 
 ### Options
 
-- `--jest` -- register jest test helpers as global variables, also load `jest.config.*` configuration options
+- `--global` -- register all test helpers as global variables
 
-- `--esbuild` -- use esbuild loader, also enables Typescript support
+- `--typescript` -- enable typescript support
 
-- `--babel` -- use babel loader (slower than `--esbuild`, makes sense if you have a special config)
+- `--babel` -- enable babel support
 
 - `--coverage` -- enable coverage, prints coverage output (varies by coverage engine)
 
 - `--coverage-engine c8` -- use c8 coverage engine (default), also generates `./coverage/` dirs
 
 - `--coverage-engine node` -- use Node.js builtint coverage engine
-
-- `--watch` -- operate in watch mode and re-run tests on file changes
-
-- `--only` -- only run the tests marked with `test.only`
-
-- `--passWithNoTests` -- do not error when no test files were found
-
-- `--write-snapshots` -- write snapshots instead of verifying them (has `--test-update-snapshots` alias)
-
-- `--test-force-exit` -- force exit after tests are done (useful in integration tests where it could be unfeasible to resolve all open handles)