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

package/README.md

@@ -1,18 +1,44 @@
 # @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
 
-`import { describe, it, assert, jest, expect } from '@exodus/test'`
+```js
+import {
+  jest,
+  expect,
+  describe,
+  it,
+  beforeEach,
+  afterEach,
+  beforeAll,
+  afterAll,
+} from '@exodus/test/jest'
+```
+
+Or, run with [`--jest` option](#options) to register jest globals
 
 ### Moving from tap/tape
 
-`import { tap as test } from '@exodus/test'`
-
-Not all features might be supported
+```js
+import test from '@exodus/test/tap'
+```
 
 ### Running tests asynchronously
 
@@ -20,41 +46,34 @@ Add `{ concurrency: true }`, like this: `describe('my testsuite', { concurrency:
 
 ### List of exports
 
-Adapters:
-
-- `jest` -- jest mock adapter
-- `tap` -- tap/tape adapter
-- `mock`
+- `@exodus/test/jest` -- `jest` mock
 
-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`
+- `@exodus/test/tape` -- `tape` mock (can also be helpful when moving from `tap`)
 
 ## Binary
 
-Just use `"test: "exodus-test"`
+Just use `"test": "exodus-test"`
 
 ### Options
 
-- `--global` -- register all test helpers as global variables
+- `--jest` -- register jest test helpers as global variables, also load `jest.config.*` configuration options
 
-- `--typescript` -- enable typescript support
+- `--esbuild` -- use esbuild loader, also enables Typescript support
 
-- `--babel` -- enable babel support
+- `--babel` -- use babel loader (slower than `--esbuild`, makes sense if you have a special config)
 
 - `--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)

package/bin/babel.cjs

@@ -0,0 +1,8 @@
+const register = require('@babel/register')
+
+register({
+  compact: false,
+  babelrc: false,
+  plugins: ['@babel/plugin-transform-modules-commonjs'],
+  ignore: [], // do not ignore node_modules
+})