9.4.0 • Published 4 months ago

@bevry/testen v9.4.0

Weekly downloads
3
License
Artistic-2.0
Repository
github
Last release
4 months ago

@bevry/testen

Run your tests locally against multiple node.js versions

@bevry/testen is a fork of testen which continues maintenance with various improvements and fixes.

Examples

Success

As JSON:

Failure

As JSON:

Usage

Complete API Documentation.

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, and system 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

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

Maintainers

Contributors

Finances

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

License

Unless stated otherwise all works are:

and licensed under: