Skip to content

Latest commit

 

History

History
73 lines (43 loc) · 2.07 KB

test.md

File metadata and controls

73 lines (43 loc) · 2.07 KB

benmvp test Documentation

Runs a one-time pass of typing, linting & unit tests for the library.

NOTE: benmvp test assumes your source files live within the src/ folder of the current working directory where the script is being called.

Looking for Node API docs? View companion test() documentation.

Examples

To run all modes on all files (default behavior):

benmvp test

To run just unit tests on all files:

benmvp test --modes spec

To run linting & typing on all files:

benmvp test --modes lint type

To run all modes only on files within utils/ directories:

benmvp test --pattern utils/

To just run linting on files within api/ directories while continuously watching for changes:

benmvp test --modes lint --pattern api/ --watch

Arguments

--modes

A space-separated list of the types or modes of tests to run. Aliased as -m. Available modes:

  • lint - Runs ESLint (files ending in .ts or .tsx)
  • type - Runs Typescript type-checking (files ending in .ts or .tsx)
  • spec - Runs Jest-based unit tests (files ending in .spec.ts or in __tests__ folder)

Optional. Defaults to all modes.

--pattern

A regexp pattern string that is matched against all tests paths before executing the test. Aliased as -p.

Optional. Defaults to '' (signifying no filter)

--watch

A flag indicating whether or not to continuously run the tests whenever source files change. Aliased as -w.

Optional. Defaults to false.

NOTE: Jest Watch Plugins are added to make watch mode even more useful. Specifically the eslint watch-fix plugin is added to enable auto-fixing of lint errors. However, for this to work, lint has to be the first mode whe specified.

More help

Looking for Node API docs? View companion test() documentation.

Still unsure of how to use @benmvp/cli? Ask for help!