Skip to content

Latest commit

 

History

History
61 lines (32 loc) · 1.46 KB

FrameworkExitCode.md

File metadata and controls

61 lines (32 loc) · 1.46 KB

@black-flag/coreDocs


@black-flag/core / index / FrameworkExitCode

Enumeration: FrameworkExitCode

Well-known exit codes shared across CLI implementations.

Enumeration Members

AssertionFailed

AssertionFailed: 3

The exit code used when a sanity check fails. If your CLI is spitting out this code, that's a hint to re-run things in debug mode (example: DEBUG='black-flag*' npx jest) since an error is being suppressed.

In most cases, this exit code is indicative of improper use of Black Flag.

Defined in

src/constant.ts:60


DefaultError

DefaultError: 1

Hard-coded default fallback exit code when fatal errors occur.

Defined in

src/constant.ts:48


NotImplemented

NotImplemented: 2

The exit code used when executing an unimplemented child command.

Defined in

src/constant.ts:52


Ok

Ok: 0

The exit code used when execution succeeds and exits gracefully.

Defined in

src/constant.ts:44