release: 1.2.0 [skip ci]

## [1.2.0](v1.1.4...v1.2.0) (2024-03-18)

#### ✨ Features

* Add `showHelp` option to `CliError` ([b5a1e58](b5a1e58))

Author: Xunnamius

CHANGELOG.md

@@ -4,86 +4,94 @@ All notable changes to this project will be documented in this auto-generated
 file. The format is based on [Conventional Commits][1];
 this project adheres to [Semantic Versioning][2].
 
-### [1.1.4][3] (2024-03-16)
+## [1.2.0][3] (2024-03-18)
+
+#### ✨ Features
+
+- Add `showHelp` option to `CliError` ([b5a1e58][4])
+
+### [1.1.4][5] (2024-03-16)
 
 #### 🪄 Fixes
 
-- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][4])
+- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][6])
 
-### [1.1.3][5] (2024-03-15)
+### [1.1.3][7] (2024-03-15)
 
 #### 🪄 Fixes
 
-- Add support for `export default X` syntax ([bad391d][6])
-- Ensure `demandOption` is properly supported ([2f205c1][7])
+- Add support for `export default X` syntax ([bad391d][8])
+- Ensure `demandOption` is properly supported ([2f205c1][9])
 
-### [1.1.2][8] (2023-12-31)
+### [1.1.2][10] (2023-12-31)
 
 #### 🪄 Fixes
 
-- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][9])
+- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][11])
 
-### [1.1.1][10] (2023-12-31)
+### [1.1.1][12] (2023-12-31)
 
 #### 🪄 Fixes
 
-- Fix Node10 type resolution failure ([b6178c9][11])
+- Fix Node10 type resolution failure ([b6178c9][13])
 
-## [1.1.0][12] (2023-12-31)
+## [1.1.0][14] (2023-12-31)
 
 #### ✨ Features
 
-- **src:** support file://-style URLs ([0e5067e][13])
+- **src:** support file://-style URLs ([0e5067e][15])
 
 #### 🪄 Fixes
 
-- **src:** ensure --version is included in help text output when relevant ([4f159dc][14])
+- **src:** ensure --version is included in help text output when relevant ([4f159dc][16])
 
 #### ⚙️ Build System
 
-- **babel:** fix ESM<=>CJS interop issue ([5470091][15])
+- **babel:** fix ESM<=>CJS interop issue ([5470091][17])
 
-## [1.0.0][16] (2023-12-29)
+## [1.0.0][18] (2023-12-29)
 
 #### ✨ Features
 
-- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][17])
+- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][19])
 
 #### 🪄 Fixes
 
-- Rename package from "black-flag" to "[@black-][18]flag/core" npm typosquat workaround ([292ead5][19])
+- Rename package from "black-flag" to "[@black-][20]flag/core" npm typosquat workaround ([292ead5][21])
 
 #### ⚙️ Build System
 
-- Fix horrible decision by marked devs to break output for no reason ([036e350][20])
-- **jest:** ensure pkg-up is transformed ([c7f4aef][21])
-- **jest:** fix transformIgnorePatterns ([0548d34][22])
-- **jest:** transpile node\_modules ([5cf7a6c][23])
-- **tsconfig:** fix internal path resolution ([fbe3a69][24])
-- **tsconfig:** upgrade to NodeNext ([d3a499e][25])
+- Fix horrible decision by marked devs to break output for no reason ([036e350][22])
+- **jest:** ensure pkg-up is transformed ([c7f4aef][23])
+- **jest:** fix transformIgnorePatterns ([0548d34][24])
+- **jest:** transpile node\_modules ([5cf7a6c][25])
+- **tsconfig:** fix internal path resolution ([fbe3a69][26])
+- **tsconfig:** upgrade to NodeNext ([d3a499e][27])
 
 [1]: https://conventionalcommits.org
 [2]: https://semver.org
-[3]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4
-[4]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824
-[5]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3
-[6]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53
-[7]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8
-[8]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2
-[9]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271
-[10]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1
-[11]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c
-[12]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0
-[13]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98
-[14]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea
-[15]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8
-[16]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0
-[17]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842
-[18]: https://github.com/black-
-[19]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d
-[20]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87
-[21]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff
-[22]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72
-[23]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17
-[24]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f
-[25]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f
+[3]: https://github.com/Xunnamius/black-flag/compare/v1.1.4...v1.2.0
+[4]: https://github.com/Xunnamius/black-flag/commit/b5a1e58add31902fd9ec80b93dd37305b8fd0684
+[5]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4
+[6]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824
+[7]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3
+[8]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53
+[9]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8
+[10]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2
+[11]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271
+[12]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1
+[13]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c
+[14]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0
+[15]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98
+[16]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea
+[17]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8
+[18]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0
+[19]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842
+[20]: https://github.com/black-
+[21]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d
+[22]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87
+[23]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff
+[24]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72
+[25]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17
+[26]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f
+[27]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f

docs/classes/index.CliError.md

@@ -36,6 +36,7 @@ can be used as a simple wrapper around other errors.
 - [cause](index.CliError.md#cause)
 - [message](index.CliError.md#message)
 - [name](index.CliError.md#name)
+- [showHelp](index.CliError.md#showhelp)
 - [stack](index.CliError.md#stack)
 - [suggestedExitCode](index.CliError.md#suggestedexitcode)
 - [prepareStackTrace](index.CliError.md#preparestacktrace)
@@ -71,7 +72,7 @@ AppError.constructor
 
 #### Defined in
 
-[src/error.ts:92](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L92)
+[src/error.ts:101](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L101)
 
 • **new CliError**(`cause`, `options`, `message`, `superOptions`): [`CliError`](index.CliError.md)
 
@@ -97,7 +98,7 @@ AppError.constructor
 
 #### Defined in
 
-[src/error.ts:97](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L97)
+[src/error.ts:106](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L106)
 
 ## Properties
 
@@ -107,7 +108,7 @@ AppError.constructor
 
 #### Defined in
 
-[src/error.ts:87](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L87)
+[src/error.ts:96](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L96)
 
 ___
 
@@ -153,6 +154,20 @@ node_modules/typescript/lib/lib.es5.d.ts:1076
 
 ___
 
+### showHelp
+
+• **showHelp**: `boolean` = `false`
+
+#### Implementation of
+
+NonNullable.showHelp
+
+#### Defined in
+
+[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94)
+
+___
+
 ### stack
 
 • `Optional` **stack**: `string`
@@ -177,7 +192,7 @@ NonNullable.suggestedExitCode
 
 #### Defined in
 
-[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L85)
+[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93)
 
 ___
 

docs/classes/index.GracefulEarlyExitError.md

@@ -26,6 +26,7 @@ termination of the application but with an exit code indicating success
 - [cause](index.GracefulEarlyExitError.md#cause)
 - [message](index.GracefulEarlyExitError.md#message)
 - [name](index.GracefulEarlyExitError.md#name)
+- [showHelp](index.GracefulEarlyExitError.md#showhelp)
 - [stack](index.GracefulEarlyExitError.md#stack)
 - [suggestedExitCode](index.GracefulEarlyExitError.md#suggestedexitcode)
 - [prepareStackTrace](index.GracefulEarlyExitError.md#preparestacktrace)
@@ -55,7 +56,7 @@ termination of the application but with an exit code indicating success
 
 #### Defined in
 
-[src/error.ts:159](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L159)
+[src/error.ts:172](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L172)
 
 ## Properties
 
@@ -69,7 +70,7 @@ termination of the application but with an exit code indicating success
 
 #### Defined in
 
-[src/error.ts:153](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L153)
+[src/error.ts:166](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L166)
 
 ___
 
@@ -115,6 +116,20 @@ node_modules/typescript/lib/lib.es5.d.ts:1076
 
 ___
 
+### showHelp
+
+• **showHelp**: `boolean` = `false`
+
+#### Inherited from
+
+[CliError](index.CliError.md).[showHelp](index.CliError.md#showhelp)
+
+#### Defined in
+
+[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94)
+
+___
+
 ### stack
 
 • `Optional` **stack**: `string`
@@ -139,7 +154,7 @@ ___
 
 #### Defined in
 
-[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L85)
+[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93)
 
 ___
 

docs/classes/util.AssertionFailedError.md

@@ -24,6 +24,7 @@ Represents a failed sanity check.
 - [cause](util.AssertionFailedError.md#cause)
 - [message](util.AssertionFailedError.md#message)
 - [name](util.AssertionFailedError.md#name)
+- [showHelp](util.AssertionFailedError.md#showhelp)
 - [stack](util.AssertionFailedError.md#stack)
 - [suggestedExitCode](util.AssertionFailedError.md#suggestedexitcode)
 - [prepareStackTrace](util.AssertionFailedError.md#preparestacktrace)
@@ -57,7 +58,7 @@ Represents a failed sanity check.
 
 #### Defined in
 
-[src/error.ts:175](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L175)
+[src/error.ts:188](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L188)
 
 ## Properties
 
@@ -71,7 +72,7 @@ Represents a failed sanity check.
 
 #### Defined in
 
-[src/error.ts:171](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L171)
+[src/error.ts:184](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L184)
 
 ___
 
@@ -117,6 +118,20 @@ node_modules/typescript/lib/lib.es5.d.ts:1076
 
 ___
 
+### showHelp
+
+• **showHelp**: `boolean` = `false`
+
+#### Inherited from
+
+[CliError](index.CliError.md).[showHelp](index.CliError.md#showhelp)
+
+#### Defined in
+
+[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94)
+
+___
+
 ### stack
 
 • `Optional` **stack**: `string`
@@ -141,7 +156,7 @@ ___
 
 #### Defined in
 
-[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L85)
+[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93)
 
 ___
 

docs/classes/util.CommandNotImplementedError.md

@@ -24,6 +24,7 @@ Represents trying to execute a CLI command that has not yet been implemented.
 - [cause](util.CommandNotImplementedError.md#cause)
 - [message](util.CommandNotImplementedError.md#message)
 - [name](util.CommandNotImplementedError.md#name)
+- [showHelp](util.CommandNotImplementedError.md#showhelp)
 - [stack](util.CommandNotImplementedError.md#stack)
 - [suggestedExitCode](util.CommandNotImplementedError.md#suggestedexitcode)
 - [prepareStackTrace](util.CommandNotImplementedError.md#preparestacktrace)
@@ -52,7 +53,7 @@ implemented.
 
 #### Defined in
 
-[src/error.ts:137](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L137)
+[src/error.ts:150](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L150)
 
 ## Properties
 
@@ -66,7 +67,7 @@ implemented.
 
 #### Defined in
 
-[src/error.ts:132](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L132)
+[src/error.ts:145](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L145)
 
 ___
 
@@ -112,6 +113,20 @@ node_modules/typescript/lib/lib.es5.d.ts:1076
 
 ___
 
+### showHelp
+
+• **showHelp**: `boolean` = `false`
+
+#### Inherited from
+
+[CliError](index.CliError.md).[showHelp](index.CliError.md#showhelp)
+
+#### Defined in
+
+[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94)
+
+___
+
 ### stack
 
 • `Optional` **stack**: `string`
@@ -136,7 +151,7 @@ ___
 
 #### Defined in
 
-[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/4e1a91c/src/error.ts#L85)
+[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93)
 
 ___