Skip to content

Commit 8fdffe9

Browse files
committed
release: @black-flag/core@3.0.1 [skip ci]
## 🪄 Fixes - Account for `ConfigurationHooks` in contravariant position in `runProgram` params ([19fa7dc][2]) [1]: https://github.com/Xunnamius/black-flag/compare/@black-flag/core@3.0.0...@black-flag/core@3.0.1 [2]: 19fa7dc
1 parent d6004b4 commit 8fdffe9

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

+413
-309
lines changed

CHANGELOG.md

Lines changed: 180 additions & 170 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:166](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L166)
9+
Defined in: [src/error.ts:166](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L166)
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`
3535
36-
Defined in: [src/error.ts:179](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L179)
36+
Defined in: [src/error.ts:179](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L179)
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`
6262
63-
Defined in: [src/error.ts:184](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L184)
63+
Defined in: [src/error.ts:184](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L184)
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:174](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L174)
100+
Defined in: [src/error.ts:174](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L174)
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:172](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L172)
124+
Defined in: [src/error.ts:172](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L172)
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` \| `"short"` \| `"full"` \| `"default"`\>
188188
189-
Defined in: [src/error.ts:171](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L171)
189+
Defined in: [src/error.ts:171](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L171)
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
@@ -238,7 +238,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
238238

239239
> **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError`
240240
241-
Defined in: [src/error.ts:170](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L170)
241+
Defined in: [src/error.ts:170](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L170)
242242

243243
The exit code that will be returned when the application exits, given
244244
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:256](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L256)
9+
Defined in: [src/error.ts:256](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L256)
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**(`reason?`, `options?`): `GracefulEarlyExitError`
2727
28-
Defined in: [src/error.ts:267](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L267)
28+
Defined in: [src/error.ts:267](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L267)
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:258](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L258)
61+
Defined in: [src/error.ts:258](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L258)
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:172](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L172)
85+
Defined in: [src/error.ts:172](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L172)
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` \| `"short"` \| `"full"` \| `"default"`\>
149149
150-
Defined in: [src/error.ts:171](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L171)
150+
Defined in: [src/error.ts:171](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L171)
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
@@ -199,7 +199,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
199199

200200
> **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError`
201201
202-
Defined in: [src/error.ts:170](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L170)
202+
Defined in: [src/error.ts:170](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L170)
203203

204204
The exit code that will be returned when the application exits, given
205205
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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/constant.ts#L51)
9+
Defined in: [src/constant.ts:51](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/constant.ts#L75)
19+
Defined in: [src/constant.ts:75](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/constant.ts#L59)
37+
Defined in: [src/constant.ts:59](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/constant.ts#L63)
47+
Defined in: [src/constant.ts:63](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/constant.ts#L55)
57+
Defined in: [src/constant.ts:55](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/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: 2 additions & 2 deletions
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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L188)
11+
Defined in: [src/index.ts:202](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L202)
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.
@@ -34,7 +34,7 @@ occur if no commands are loadable from the given `commandModulesPath`.
3434

3535
### configurationHooks?
3636

37-
`Promisable`\<[`ConfigurationHooks`](../type-aliases/ConfigurationHooks.md)\>
37+
`Promisable`\<[`ConfigurationHooks`](../type-aliases/ConfigurationHooks.md)\<`any`\>\>
3838

3939
## Returns
4040

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:42](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L42)
11+
Defined in: [src/error.ts:42](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L42)
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:55](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/error.ts#L55)
11+
Defined in: [src/error.ts:55](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/error.ts#L55)
1212

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

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

Lines changed: 96 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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L674)
13+
Defined in: [src/index.ts:688](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L688)
1414

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

4949
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
5050
51-
Defined in: [src/index.ts:694](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L694)
51+
Defined in: [src/index.ts:708](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L708)
5252

5353
Invokes the dynamically imported `configureProgram(commandModulesPath,
5454
configurationHooks).execute()` function.
@@ -88,9 +88,51 @@ if any other exception occurs, or `Arguments` otherwise.
8888

8989
## Call Signature
9090

91+
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
92+
93+
Defined in: [src/index.ts:731](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L731)
94+
95+
Invokes the dynamically imported `configureProgram(commandModulesPath,
96+
configurationHooks).execute()` function.
97+
98+
This function is suitable for a CLI entry point since it will **never throw
99+
or reject no matter what.** Instead, when an exception occurs,
100+
`process.exitCode` is set to the appropriate value, the
101+
[ConfigureErrorHandlingEpilogue](../type-aliases/ConfigureErrorHandlingEpilogue.md) hook is triggered, and either
102+
`NullArguments` (only if `GracefulEarlyExitError` was thrown) or `undefined`
103+
is returned.
104+
105+
Note: It is always safe to invoke this form of `runProgram` as many times as
106+
desired.
107+
108+
### Type Parameters
109+
110+
#### CustomCliArguments
111+
112+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
113+
114+
### Parameters
115+
116+
#### commandModulesPath
117+
118+
`string`
119+
120+
#### configurationHooks
121+
122+
`Promisable`\<[`ConfigurationHooks`](../type-aliases/ConfigurationHooks.md)\<`any`\>\>
123+
124+
### Returns
125+
126+
[`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
127+
128+
`NullArguments` if `GracefulEarlyExitError` is thrown, `undefined`
129+
if any other exception occurs, or `Arguments` otherwise.
130+
131+
## Call Signature
132+
91133
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
92134
93-
Defined in: [src/index.ts:718](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L718)
135+
Defined in: [src/index.ts:755](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L755)
94136

95137
Invokes the `preExecutionContext.execute()` function.
96138

@@ -133,7 +175,7 @@ if any other exception occurs, or `Arguments` otherwise.
133175

134176
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
135177
136-
Defined in: [src/index.ts:742](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L742)
178+
Defined in: [src/index.ts:779](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L779)
137179

138180
Invokes the dynamically imported
139181
`configureProgram(commandModulesPath).execute(argv)` function. If `argv` is a
@@ -176,7 +218,7 @@ if any other exception occurs, or `Arguments` otherwise.
176218

177219
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
178220
179-
Defined in: [src/index.ts:766](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L766)
221+
Defined in: [src/index.ts:803](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L803)
180222

181223
Invokes the dynamically imported `configureProgram(commandModulesPath,
182224
configurationHooks).execute(argv)` function. If `argv` is a string, `argv =
@@ -221,9 +263,56 @@ if any other exception occurs, or `Arguments` otherwise.
221263

222264
## Call Signature
223265

266+
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
267+
268+
Defined in: [src/index.ts:828](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L828)
269+
270+
Invokes the dynamically imported `configureProgram(commandModulesPath,
271+
configurationHooks).execute(argv)` function. If `argv` is a string, `argv =
272+
argv.split(' ')` is applied first.
273+
274+
This function is suitable for a CLI entry point since it will **never throw
275+
or reject no matter what.** Instead, when an exception occurs,
276+
`process.exitCode` is set to the appropriate value, the
277+
[ConfigureErrorHandlingEpilogue](../type-aliases/ConfigureErrorHandlingEpilogue.md) hook is triggered, and either
278+
`NullArguments` (only if `GracefulEarlyExitError` was thrown) or `undefined`
279+
is returned.
280+
281+
Note: It is always safe to invoke this form of `runProgram` as many times as
282+
desired.
283+
284+
### Type Parameters
285+
286+
#### CustomCliArguments
287+
288+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
289+
290+
### Parameters
291+
292+
#### commandModulesPath
293+
294+
`string`
295+
296+
#### argv
297+
298+
`string` | `string`[]
299+
300+
#### configurationHooks
301+
302+
`Promisable`\<[`ConfigurationHooks`](../type-aliases/ConfigurationHooks.md)\<`any`\>\>
303+
304+
### Returns
305+
306+
[`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
307+
308+
`NullArguments` if `GracefulEarlyExitError` is thrown, `undefined`
309+
if any other exception occurs, or `Arguments` otherwise.
310+
311+
## Call Signature
312+
224313
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
225314
226-
Defined in: [src/index.ts:792](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L792)
315+
Defined in: [src/index.ts:854](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L854)
227316

228317
Invokes the `preExecutionContext.execute(argv)` function. If `argv` is a
229318
string, `argv = argv.split(' ')` is applied first.
@@ -271,7 +360,7 @@ if any other exception occurs, or `Arguments` otherwise.
271360

272361
> **runProgram**\<`CustomCliArguments`\>(...`args`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
273362
274-
Defined in: [src/index.ts:812](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/index.ts#L812)
363+
Defined in: [src/index.ts:874](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/index.ts#L874)
275364

276365
Run the given program with the configuration given in `args`.
277366

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/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/types/program.ts#L29)
11+
Defined in: [src/types/program.ts:29](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/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:166](https://github.com/Xunnamius/black-flag/blob/7a70c7e44633bf3b15b0662ce212ece66de038c8/src/types/module.ts#L166)
11+
Defined in: [src/types/module.ts:166](https://github.com/Xunnamius/black-flag/blob/d6004b46e3ac5a451e4e0f05bf5c8726ce157ac9/src/types/module.ts#L166)
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)