expected-exit-status

3.1.0 • Public • Published

expected-exit-status Actions Status: test

A CLI check that command exit status is expected.

  • Cross platform(Windows/Linux/macOS) support
  • Test command's exit code

Install

Install with npm:

npm install expected-exit-status
  • Requires Node.js 18+

Usage

Usage
  $ expected-exit-status <status-code> --command <command>

Options:
  --command Execute command
  --stdout  Expected stdout. "pattern" or "/pattern/"
  --stderr  Expected stderr. "pattern" or "/pattern/"
  --silent  Suppress stdout and stderr

Examples
  # exit status test -> It is ok
  $ expected-exit-status 1 --command "exit 1"
  // $? => 0 -> It throws error
  $ expected-exit-status 0 --command "exit 1"
  # stdout test -> It is ok
  $ expected-exit-status 0 --command "echo 'foo' && exit 1" --stdout "foo"
  # stderr test -> It is ok
  $ expected-exit-status 1 --command "echo 'err' >&2 && exit 1" --stderr "err"
  # regexp test -> It is ok
  $ expected-exit-status 1 --command "echo '3 problems' && exit 1" --stdout "/\d problems/"

Usecase

If you want to test if "abc-command" should be failed(exit status 1), you can write following.

$ expected-exit-status 1 --command "abc-command"

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu

Package Sidebar

Install

npm i expected-exit-status

Weekly Downloads

50

Version

3.1.0

License

MIT

Unpacked Size

9.12 kB

Total Files

5

Last publish

Collaborators

  • azu