Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.79 KB

README.md

File metadata and controls

41 lines (23 loc) · 1.79 KB
Raw

@oclif/test

test helpers for oclif CLIs

Version Downloads/week License

Migration

See the V4 Migration Guide if you are migrating from v3 or older.

Usage

@oclif/test provides a handful of utilities that make it easy to test your oclif CLI.

NOTE for jest users - in order for these utilities to capture all output to the terminal, you must set verbose: true in your jest config to prevent jest from supressing any output. See https://jestjs.io/docs/configuration#verbose-boolean for more

captureOutput

captureOutput allows you to get the stdout, stderr, return value, and error of the callback you provide it. This makes it possible to assert that certain strings were printed to stdout and stderr or that the callback failed with the expected error or succeeded with the expected result.

Options

  • print - Print everything that goes to stdout and stderr.
  • stripAnsi - Strip ansi codes from everything that goes to stdout and stderr. Defaults to true.
  • testNodeEnv - Sets the NODE_ENV value when capturing output. Defaults to 'test'.

See the tests for example usage.

runCommand

runCommand allows you to get the stdout, stderr, return value, and error of a command in your CLI.

See the tests for example usage.

runHook

runHook allows you to get the stdout, stderr, return value, and error of a hook in your CLI.

See the tests for example usage.