Skip to content

Commit 3c3f6e1

Browse files
committed
release: @black-flag/core@2.0.0 [skip ci]
## 💥 BREAKING CHANGES 💥 - **Positionals are now available to builders alongside all other flags** This is how vanilla Yargs does it. In earlier versions, builders' `argv` param had all positionals dumped into `argv._` due to a suboptimal parsing extension. - **Show any available child commands in ALL error text** This includes when trying to use a command that is not found. - **Do not output entire help text when a command fails** Skip all but the first line of `usage` text in output by default. - **Upgrade `ExecutionContext::state.showHelpOnFail` to allow configuration of help text output style** New output style options include "short" (first line of `usage` only, this is now the default) and "full" (full `usage` string). Also allows configuration of which error kinds trigger help text output and which do not. See documentation for details. - **Surface new `CliError::showHelp` parameter values** - `"short"`/`true`, which will print the command help text without all but the first line of `usage` text. - `"default"`, which will defer to `ExecutionContext::state.showHelpOnFail`. - `"full"`, which will force the old functionality. - `false`, which ensures help text is never printed with respect to the current error instance. - **Better help text output for dynamic options** With this change, Black Flag lets Yargs fully parse `argv` and run through the builder twice before bailing to print help text when `--help` (or the equivalent option) is given. This allows input that triggers dynamic options like `my-command --flag-1 --flag-2 --help` to show help text specific to the final resolved builder configurations of `--flag-1 --flag-2` rather than always showing the most generic help text, which was the behavior of older Black Flag versions. See documentation for details. - `$executionContext` and `$artificiallyInvoked` symbols are now drawn from the global symbol registry. They will not match symbols from previous versions! - **All instances in source where `commandModulePath` appeared have been replaced by `commandModulesPath`. This includes the call signatures of functions like `makeRunner`.** The fix is simple: find-and-replace all instances of `commandModulePath` with `commandModulesPath`. - **Along with implementing the `errorHandlingBehavior` DX improvement in `makeRunner`, this update also addresses several small discrepancies in the behavior of `configureProgram`, `runProgram`, and `makeRunner`. These functions should now behave identically where appropriate (i.e. as described in their documentation), including consistently triggering the same error handling behavior at the same points for the same reasons given the same inputs.** Additionally, non-graceful errors that are not handled by `ConfigureErrorHandlingEpilogue` will be consistently presented to the user as framework errors (assertion failures). As such, `runProgram` (and the low-order function returned by `makeRunner`) should no longer throw in some edge cases, such as when being passed a rejected promise or when a hook that is evaluated early throws. - `ErrorMessage` export was renamed to `BfErrorMessage` ## ✨ Features - **src:** export `getDeepestErrorCause` under `/util` ([bf001c4][2]) - **src:** implement `errorHandlingBehavior` option in `makeRunner` ([5e4eb3d][3]) - **src:** make `expectedHelpTextRegExp` utility a public export ([8f2cb13][4]) - **src:** make positionals available to builders normally (no longer in `argv._`) ([42367ce][5]) - **src:** output help text with greater fidelity ([02a497f][6]) <sup>see [#172][7]</sup> - Support Windows-style paths ([cd288c5][8]) ## 🪄 Fixes - Fix Windows interop issues ([b3abf95][9]) <sup>see [#174][10]</sup> - **package:** add @types/yargs as production dependency ([8d50a56][11]) - **src:** ensure ESM file bare exports are seen by black flag ([389a2dc][12]) - **src:** fix node\@18 interop issue ([c1b5f61][13]) <sup>see [#173][14]</sup> - **src:** improve `isX` type assertion exports ([b980544][15]) - **src:** improve intellisense across various exports ([d6b1e73][16]) - **src:** more consistently handle various errors; improve output fidelity ([9412aa6][17]) - **src:** throw upon encountering a `command` export with invalid yargs DSL ([7312b8d][18]) - **src:** throw upon encountering an async `builder` export ([78eb0a2][19]) ## ⚙️ Build System - **deps:** bump type-fest from 4.35.0 to 4.36.0 ([33b2099][20]) - **deps:** bump type-fest from 4.36.0 to 4.37.0 ([cdd8f61][21]) - **husky:** force lint-staged (via husky) to only use global config file ([5d3f2cc][22]) - **package:** add @-xun/symbiote dev dependency ([074a930][23]) - **package:** prune unnecessary dependencies ([1b5cdbf][24]) - Throw in `runProgram` when an incompatible Node.js runtime version is detected ([cb56f8d][25]) ## 🧙🏿 Refactored - Make exported symbols cross-realm ([af78a8f][26]) - Rename and restructure exports for better docs generation ([8303ba7][27]) - **src:** `ErrorMessage` export is now `BfErrorMessage` ([3918a29][28]) [1]: https://github.com/Xunnamius/black-flag/compare/@black-flag/core@1.3.2...@black-flag/core@2.0.0 [2]: bf001c4 [3]: 5e4eb3d [4]: 8f2cb13 [5]: 42367ce [6]: 02a497f [7]: #172 [8]: cd288c5 [9]: b3abf95 [10]: #174 [11]: 8d50a56 [12]: 389a2dc [13]: c1b5f61 [14]: #173 [15]: b980544 [16]: d6b1e73 [17]: 9412aa6 [18]: 7312b8d [19]: 78eb0a2 [20]: 33b2099 [21]: cdd8f61 [22]: 5d3f2cc [23]: 074a930 [24]: 1b5cdbf [25]: cb56f8d [26]: af78a8f [27]: 8303ba7 [28]: 3918a29
1 parent aaa1a74 commit 3c3f6e1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+323
-209
lines changed

CHANGELOG.md

Lines changed: 229 additions & 115 deletions
Large diffs are not rendered by default.

docs/api/src/exports/classes/CliError.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: CliError
88

9-
Defined in: [src/error.ts:156](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L156)
9+
Defined in: [src/error.ts:156](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L156)
1010

1111
Represents a CLI-specific error with suggested exit code and other
1212
properties. As `CliError` has built-in support for cause chaining, this class
@@ -33,7 +33,7 @@ can be used as a simple wrapper around other errors.
3333

3434
> **new CliError**(`reason`?, `options`?): [`CliError`](CliError.md)
3535
36-
Defined in: [src/error.ts:169](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L169)
36+
Defined in: [src/error.ts:169](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L169)
3737

3838
Represents a CLI-specific error, optionally with suggested exit code and
3939
other context.
@@ -60,7 +60,7 @@ other context.
6060

6161
> **new CliError**(`reason`, `options`, `message`, `superOptions`): [`CliError`](CliError.md)
6262
63-
Defined in: [src/error.ts:174](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L174)
63+
Defined in: [src/error.ts:174](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L174)
6464

6565
This constructor syntax is used by subclasses when calling this constructor
6666
via `super`.
@@ -97,7 +97,7 @@ via `super`.
9797

9898
> **\[$type\]**: `string`[]
9999
100-
Defined in: [src/error.ts:164](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L164)
100+
Defined in: [src/error.ts:164](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L164)
101101

102102
***
103103

@@ -121,7 +121,7 @@ Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
121121

122122
> **dangerouslyFatal**: `boolean` = `false`
123123
124-
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L162)
124+
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L162)
125125

126126
This option is similar in intent to Yargs's `exitProcess()` function,
127127
except applied more granularly.
@@ -186,7 +186,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
186186

187187
> **showHelp**: `NonNullable`\<`undefined` \| `false` \| `"full"` \| `"short"` \| `"default"`\>
188188
189-
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L161)
189+
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L161)
190190

191191
If `showHelp` is set to a string that isn't `"default"`, help text will be
192192
sent to stderr. Note that help text is always sent _before this exception
@@ -237,7 +237,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
237237

238238
> **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError`
239239
240-
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L160)
240+
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L160)
241241

242242
The exit code that will be returned when the application exits, given
243243
nothing else goes wrong in the interim.

docs/api/src/exports/classes/GracefulEarlyExitError.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: GracefulEarlyExitError
88

9-
Defined in: [src/error.ts:246](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L246)
9+
Defined in: [src/error.ts:246](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L246)
1010

1111
Represents an exceptional event that should result in the immediate
1212
termination of the application but with an exit code indicating success
@@ -25,7 +25,7 @@ ignored.
2525

2626
> **new GracefulEarlyExitError**(`error`?, `options`?): [`GracefulEarlyExitError`](GracefulEarlyExitError.md)
2727
28-
Defined in: [src/error.ts:257](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L257)
28+
Defined in: [src/error.ts:257](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L257)
2929

3030
Represents an exceptional event that should result in the immediate
3131
termination of the application but with an exit code indicating success
@@ -58,7 +58,7 @@ ignored.
5858

5959
> **\[$type\]**: `string`[]
6060
61-
Defined in: [src/error.ts:248](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L248)
61+
Defined in: [src/error.ts:248](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L248)
6262

6363
#### Overrides
6464

@@ -82,7 +82,7 @@ Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
8282

8383
> **dangerouslyFatal**: `boolean` = `false`
8484
85-
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L162)
85+
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L162)
8686

8787
This option is similar in intent to Yargs's `exitProcess()` function,
8888
except applied more granularly.
@@ -147,7 +147,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
147147

148148
> **showHelp**: `NonNullable`\<`undefined` \| `false` \| `"full"` \| `"short"` \| `"default"`\>
149149
150-
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L161)
150+
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L161)
151151

152152
If `showHelp` is set to a string that isn't `"default"`, help text will be
153153
sent to stderr. Note that help text is always sent _before this exception
@@ -198,7 +198,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
198198

199199
> **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError`
200200
201-
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L160)
201+
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L160)
202202

203203
The exit code that will be returned when the application exits, given
204204
nothing else goes wrong in the interim.

docs/api/src/exports/enumerations/FrameworkExitCode.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Enumeration: FrameworkExitCode
88

9-
Defined in: [src/constant.ts:51](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/constant.ts#L51)
9+
Defined in: [src/constant.ts:51](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L51)
1010

1111
Well-known exit codes shared across CLI implementations.
1212

@@ -16,7 +16,7 @@ Well-known exit codes shared across CLI implementations.
1616

1717
> **AssertionFailed**: `3`
1818
19-
Defined in: [src/constant.ts:75](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/constant.ts#L75)
19+
Defined in: [src/constant.ts:75](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L75)
2020

2121
The exit code used when a sanity check fails. This includes (but is not
2222
limited to) all _framework errors_.
@@ -34,7 +34,7 @@ of Black Flag by the developer.
3434

3535
> **DefaultError**: `1`
3636
37-
Defined in: [src/constant.ts:59](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/constant.ts#L59)
37+
Defined in: [src/constant.ts:59](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L59)
3838

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

@@ -44,7 +44,7 @@ Hard-coded default fallback exit code when fatal errors occur.
4444

4545
> **NotImplemented**: `2`
4646
47-
Defined in: [src/constant.ts:63](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/constant.ts#L63)
47+
Defined in: [src/constant.ts:63](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L63)
4848

4949
The exit code used when executing an unimplemented child command.
5050

@@ -54,6 +54,6 @@ The exit code used when executing an unimplemented child command.
5454

5555
> **Ok**: `0`
5656
57-
Defined in: [src/constant.ts:55](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/constant.ts#L55)
57+
Defined in: [src/constant.ts:55](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L55)
5858

5959
The exit code used when execution succeeds and exits gracefully.

docs/api/src/exports/functions/configureProgram.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **configureProgram**(`commandModulesPath`, `configurationHooks`?): `Promise`\<[`PreExecutionContext`](../util/type-aliases/PreExecutionContext.md)\>
1010
11-
Defined in: [src/index.ts:188](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L188)
11+
Defined in: [src/index.ts:188](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L188)
1212

1313
Create and return a [PreExecutionContext](../util/type-aliases/PreExecutionContext.md) containing fully-configured
1414
[Program](../util/type-aliases/Program.md) instances and an [Executor](../util/type-aliases/Executor.md) entry point function.

docs/api/src/exports/functions/isCliError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **isCliError**(`parameter`): `parameter is CliError`
1010
11-
Defined in: [src/error.ts:33](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L33)
11+
Defined in: [src/error.ts:33](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L33)
1212

1313
Type guard for [CliError](../classes/CliError.md).
1414

docs/api/src/exports/functions/isGracefulEarlyExitError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **isGracefulEarlyExitError**(`parameter`): `parameter is GracefulEarlyExitError`
1010
11-
Defined in: [src/error.ts:46](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/error.ts#L46)
11+
Defined in: [src/error.ts:46](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L46)
1212

1313
Type guard for [GracefulEarlyExitError](../classes/GracefulEarlyExitError.md).
1414

docs/api/src/exports/functions/runProgram.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
1212
13-
Defined in: [src/index.ts:674](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L674)
13+
Defined in: [src/index.ts:674](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L674)
1414

1515
Invokes the dynamically imported
1616
`configureProgram(commandModulesPath).execute()` function.
@@ -46,7 +46,7 @@ if any other exception occurs, or `Arguments` otherwise.
4646

4747
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
4848
49-
Defined in: [src/index.ts:694](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L694)
49+
Defined in: [src/index.ts:694](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L694)
5050

5151
Invokes the dynamically imported `configureProgram(commandModulesPath,
5252
configurationHooks).execute()` function.
@@ -86,7 +86,7 @@ if any other exception occurs, or `Arguments` otherwise.
8686

8787
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
8888
89-
Defined in: [src/index.ts:718](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L718)
89+
Defined in: [src/index.ts:718](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L718)
9090

9191
Invokes the `preExecutionContext.execute()` function.
9292

@@ -127,7 +127,7 @@ if any other exception occurs, or `Arguments` otherwise.
127127

128128
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
129129
130-
Defined in: [src/index.ts:742](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L742)
130+
Defined in: [src/index.ts:742](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L742)
131131

132132
Invokes the dynamically imported
133133
`configureProgram(commandModulesPath).execute(argv)` function. If `argv` is a
@@ -168,7 +168,7 @@ if any other exception occurs, or `Arguments` otherwise.
168168

169169
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
170170
171-
Defined in: [src/index.ts:766](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L766)
171+
Defined in: [src/index.ts:766](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L766)
172172

173173
Invokes the dynamically imported `configureProgram(commandModulesPath,
174174
configurationHooks).execute(argv)` function. If `argv` is a string, `argv =
@@ -213,7 +213,7 @@ if any other exception occurs, or `Arguments` otherwise.
213213

214214
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
215215
216-
Defined in: [src/index.ts:792](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L792)
216+
Defined in: [src/index.ts:792](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L792)
217217

218218
Invokes the `preExecutionContext.execute(argv)` function. If `argv` is a
219219
string, `argv = argv.split(' ')` is applied first.
@@ -259,7 +259,7 @@ if any other exception occurs, or `Arguments` otherwise.
259259

260260
> **runProgram**\<`CustomCliArguments`\>(...`args`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
261261
262-
Defined in: [src/index.ts:812](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/index.ts#L812)
262+
Defined in: [src/index.ts:812](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L812)
263263

264264
Run the given program with the configuration given in `args`.
265265

docs/api/src/exports/type-aliases/Arguments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **Arguments**\<`CustomCliArguments`, `CustomExecutionContext`\>: `_Arguments`\<[`FrameworkArguments`](../util/type-aliases/FrameworkArguments.md)\<`CustomExecutionContext`\> & `CustomCliArguments`\>
1010
11-
Defined in: [src/types/program.ts:29](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/types/program.ts#L29)
11+
Defined in: [src/types/program.ts:29](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/types/program.ts#L29)
1212

1313
Represents the parsed CLI arguments, plus `_` and `$0`, any (hidden)
1414
arguments/properties specific to Black Flag, and an indexer falling back to

docs/api/src/exports/type-aliases/ChildConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **ChildConfiguration**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Partial`\<[`Configuration`](Configuration.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\>
1010
11-
Defined in: [src/types/module.ts:170](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/src/types/module.ts#L170)
11+
Defined in: [src/types/module.ts:170](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/types/module.ts#L170)
1212

1313
A partial extension to the [Configuration](Configuration.md) interface for child
1414
configurations. This type was designed for use in external ESM/CJS module

0 commit comments

Comments
 (0)