Awesome
<!-- TITLE/ -->@bevry/testen
<!-- /TITLE --> <!-- BADGES/ --><span class="badge-githubworkflow"><a href="https://github.com/bevry/testen/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/testen/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span> <span class="badge-npmversion"><a href="https://npmjs.org/package/@bevry/testen" title="View this project on NPM"><img src="https://img.shields.io/npm/v/@bevry/testen.svg" alt="NPM version" /></a></span> <span class="badge-npmdownloads"><a href="https://npmjs.org/package/@bevry/testen" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/@bevry/testen.svg" alt="NPM downloads" /></a></span> <br class="badge-separator" /> <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span> <span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span> <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span> <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span> <br class="badge-separator" /> <span class="badge-discord"><a href="https://discord.gg/nQuXddV7VP" title="Join this project's community on Discord"><img src="https://img.shields.io/discord/1147436445783560193?logo=discord&label=discord" alt="Discord server badge" /></a></span> <span class="badge-twitch"><a href="https://www.twitch.tv/balupton" title="Join this project's community on Twitch"><img src="https://img.shields.io/twitch/status/balupton?logo=twitch" alt="Twitch community badge" /></a></span>
<!-- /BADGES --> <!-- DESCRIPTION/ -->Run your tests locally against multiple node.js versions
<!-- /DESCRIPTION -->@bevry/testen
is a fork of testen which continues maintenance with various improvements and fixes.
Examples
Success
<a href="https://asciinema.org/a/se1hXojsgeN4EJj0q2u0CRiQj?autoplay=1"><img src="https://asciinema.org/a/se1hXojsgeN4EJj0q2u0CRiQj.png" width="350" alt="success case"/></a>
As JSON:
<a href="https://asciinema.org/a/pRI8Q5oNkbt3vSVa1JXfMMyE4?autoplay=1&speed=10"><img src="https://asciinema.org/a/pRI8Q5oNkbt3vSVa1JXfMMyE4.png" width="350" alt="success case as JSON"/></a>
Failure
<a href="https://asciinema.org/a/T6TzRzu8R9ozEdsMkoAK1rjU5?autoplay=1&speed=5"><img src="https://asciinema.org/a/T6TzRzu8R9ozEdsMkoAK1rjU5.png" width="350" alt="failure case"/></a>
As JSON:
<a href="https://asciinema.org/a/XnZasiO2HKi9wnXjd0LJgLjv7?autoplay=1&speed=10"><img src="https://asciinema.org/a/XnZasiO2HKi9wnXjd0LJgLjv7.png" width="350" alt="failure case as JSON"/></a>
Usage
Testen uses nvm behind the scenes for its node.js version management.
Node.js Versions
The CLI will determine which Node.js versions to run your tests again in this order of most preferred first:
- use the CLI via
-n <version>
flag (--node
is also suitable):testen -n 8.0.0 -n 10
testen -n '8 || 10'
testen -n '>=8 <=10'
- use the
package.json
configuration file via:"testen": { "node": ["8.0.0", 10] }
"testen": { "node": "8 || 10" }
"testen": { "node": ">=8 <=10" }
- use the
package.json
configuration file via:"testen": { "node": "8 || 10" }
"testen": { "node": ">=8 <=10" }
- otherwise, the
current
,stable
, andsystem
versions are used which are resolved by nvm
Command
The CLI will default to npm test
as the command that will run for each Node.js version, however the API has no such default. You can customize this via:
- use the CLI via
-- <command>
, e.g.testen -- echo hello world
- use the
package.json
configuration file via"testen": { "serial": true }
Serial or Parallel
By default tests will run in parallel (multiple at once), to use serial, you can either:
- use the CLI via
-s
flag (--serial
is also suitable) - use the
package.json
configuration file via"testen": { "serial": true }
JSON Output
By default Testen will output pretty output, to only output the JSON result, you can either:
- use the CLI via
-j
flag (--json
is also suitable) - use the
package.json
configuration file via"testen": { "json": true }
Other CLI Flags
Refer to testen --help
.
API Usage
Testen also provides an API which can be used like so:
const { Versions } = require('@bevry/testen')
async function main() {
const versions = new Versions([4, 8, 10, 'current', 'stable', 'system'])
await versions.load()
await versions.install()
await versions.test('npm test')
console.log(versions.success)
}
main()
Complete API documentation is available.
<!-- INSTALL/ -->Install
npm
Install Globally
- Install:
npm install --global @bevry/testen
- Executable:
@bevry/testen
Install Locally
- Install:
npm install --save @bevry/testen
- Executable:
npx @bevry/testen
- Import:
import * as pkg from ('@bevry/testen')
- Require:
const pkg = require('@bevry/testen')
Editions
This package is published with the following editions:
@bevry/testen/source/index.ts
is TypeScript source code with Import for modules@bevry/testen
aliases@bevry/testen/edition-es2022-esm/index.js
@bevry/testen/edition-es2022-esm/index.js
is TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Import for modules@bevry/testen/edition-types/index.d.ts
is TypeScript compiled Types with Import for modules
History
Discover the release history by heading on over to the HISTORY.md
file.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md
file.
Authors
- 2018+ Benjamin Lupton — Accelerating collaborative wisdom.
- 2016-2017 EGOIST — Indie Hacker
Maintainers
- Benjamin Lupton — Accelerating collaborative wisdom.
Contributors
Finances
<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span> <span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span> <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span> <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © 2018+ Benjamin Lupton
- Copyright © 2016-2017 EGOIST
and licensed under:
<!-- /LICENSE -->