Skip to content

Commit ca2ffa7

Browse files
committed
release: @black-flag/core@3.0.3 [skip ci]
## ⚙️ Build System - **deps:** bump @-xun/error from 1.1.5 to 1.1.6 ([3b81a78][2]) - **deps:** bump core-js from 3.43.0 to 3.44.0 ([accf0d5][3]) - **package:** add @-xun/error dependency ([68b0032][4]) - **package:** integrate @-xun/error dependency ([8d03166][5]) [1]: https://github.com/Xunnamius/black-flag/compare/@black-flag/core@3.0.2...@black-flag/core@3.0.3 [2]: 3b81a78 [3]: accf0d5 [4]: 68b0032 [5]: 8d03166
1 parent 54f69b5 commit ca2ffa7

File tree

65 files changed

+307
-291
lines changed

Some content is hidden

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

65 files changed

+307
-291
lines changed

CHANGELOG.md

Lines changed: 200 additions & 184 deletions
Large diffs are not rendered by default.

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/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/constant.ts#L51)
9+
Defined in: [src/constant.ts:51](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/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/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/constant.ts#L75)
19+
Defined in: [src/constant.ts:75](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/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/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/constant.ts#L59)
37+
Defined in: [src/constant.ts:59](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/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/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/constant.ts#L63)
47+
Defined in: [src/constant.ts:63](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/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/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/constant.ts#L55)
57+
Defined in: [src/constant.ts:55](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/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:201](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L201)
11+
Defined in: [src/index.ts:201](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L201)
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/runProgram.md

Lines changed: 9 additions & 9 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:687](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L687)
13+
Defined in: [src/index.ts:687](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L687)
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:707](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L707)
51+
Defined in: [src/index.ts:707](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L707)
5252

5353
Invokes the dynamically imported `configureProgram(commandModulesPath,
5454
configurationHooks).execute()` function.
@@ -90,7 +90,7 @@ if any other exception occurs, or `Arguments` otherwise.
9090

9191
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
9292
93-
Defined in: [src/index.ts:730](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L730)
93+
Defined in: [src/index.ts:730](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L730)
9494

9595
Invokes the dynamically imported `configureProgram(commandModulesPath,
9696
configurationHooks).execute()` function.
@@ -132,7 +132,7 @@ if any other exception occurs, or `Arguments` otherwise.
132132

133133
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
134134
135-
Defined in: [src/index.ts:754](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L754)
135+
Defined in: [src/index.ts:754](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L754)
136136

137137
Invokes the `preExecutionContext.execute()` function.
138138

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

176176
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
177177
178-
Defined in: [src/index.ts:778](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L778)
178+
Defined in: [src/index.ts:778](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L778)
179179

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

219219
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
220220
221-
Defined in: [src/index.ts:802](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L802)
221+
Defined in: [src/index.ts:802](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L802)
222222

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

266266
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
267267
268-
Defined in: [src/index.ts:827](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L827)
268+
Defined in: [src/index.ts:827](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L827)
269269

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

313313
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
314314
315-
Defined in: [src/index.ts:853](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L853)
315+
Defined in: [src/index.ts:853](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L853)
316316

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

361361
> **runProgram**\<`CustomCliArguments`\>(...`args`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
362362
363-
Defined in: [src/index.ts:873](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/index.ts#L873)
363+
Defined in: [src/index.ts:873](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/index.ts#L873)
364364

365365
Run the given program with the configuration given in `args`.
366366

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

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

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

99
> **CliError** = `InstanceType`\<*typeof* [`CliError`](../variables/CliError.md)\>
1010
11-
Defined in: [src/error.ts:102](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/error.ts#L102)
11+
Defined in: [src/error.ts:102](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/error.ts#L102)
1212

1313
Represents a CLI-specific error with suggested exit code and other
1414
properties. As `CliError` has built-in support for cause chaining, this class

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **Configuration**\<`CustomCliArguments`, `CustomExecutionContext`\> = `object`
1010
11-
Defined in: [src/types/module.ts:15](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L15)
11+
Defined in: [src/types/module.ts:15](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L15)
1212

1313
A replacement for the `CommandModule` type that comes with yargs.
1414
Auto-discovered configuration modules must implement this interface or a
@@ -30,7 +30,7 @@ subtype of this interface.
3030

3131
> **aliases**: `string`[]
3232
33-
Defined in: [src/types/module.ts:33](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L33)
33+
Defined in: [src/types/module.ts:33](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L33)
3434

3535
An array of `command` aliases [as
3636
interpreted](https://github.com/yargs/yargs/pull/647) by
@@ -55,7 +55,7 @@ Note: when a command file is interpreted as a [RootConfiguration](RootConfigurat
5555

5656
> **builder**: \{[`key`: `string`]: `Options`; \} \| (`blackFlag`, `helpOrVersionSet`, `argv?`) => `undefined` \| `void` \| `object` \| \{[`key`: `string`]: `Options`; \}
5757
58-
Defined in: [src/types/module.ts:49](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L49)
58+
Defined in: [src/types/module.ts:49](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L49)
5959

6060
An object containing yargs options configuration or a function that will
6161
receive the current Black Flag program. Unlike with vanilla yargs, you do
@@ -81,7 +81,7 @@ async logic out of the builder function to work around this bug for now.
8181

8282
> **command**: `"$0"` \| `` `$0 ${string}` ``
8383
84-
Defined in: [src/types/module.ts:81](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L81)
84+
Defined in: [src/types/module.ts:81](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L81)
8585

8686
The command as interpreted by yargs. Must always begin with `$0`. May
8787
contain positional arguments declared using the [`yargs::command`
@@ -104,7 +104,7 @@ using positional arguments. If you want to change your command's name, use
104104

105105
> **deprecated**: `string` \| `boolean`
106106
107-
Defined in: [src/types/module.ts:89](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L89)
107+
Defined in: [src/types/module.ts:89](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L89)
108108

109109
If truthy, the command will be considered "deprecated" by yargs. If
110110
`deprecated` is a string, it will additionally be treated as a deprecation
@@ -122,7 +122,7 @@ false
122122

123123
> **description**: `string` \| `false`
124124
125-
Defined in: [src/types/module.ts:96](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L96)
125+
Defined in: [src/types/module.ts:96](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L96)
126126

127127
The description for the command in help text. If `false`, the command will
128128
be considered "hidden" by yargs.
@@ -139,7 +139,7 @@ be considered "hidden" by yargs.
139139

140140
> **handler**: (`argv`) => `Promisable`\<`void`\>
141141
142-
Defined in: [src/types/module.ts:106](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L106)
142+
Defined in: [src/types/module.ts:106](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L106)
143143

144144
A function called when this command is invoked. It will receive an object
145145
of parsed arguments.
@@ -169,7 +169,7 @@ undefined
169169

170170
> **name**: `string`
171171
172-
Defined in: [src/types/module.ts:118](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L118)
172+
Defined in: [src/types/module.ts:118](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L118)
173173

174174
The name of the command. Any spaces will be replaced with hyphens.
175175
Including a character that yargs does not consider valid for a
@@ -185,7 +185,7 @@ filename without extension is "index".
185185

186186
> **usage**: `string`
187187
188-
Defined in: [src/types/module.ts:138](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/module.ts#L138)
188+
Defined in: [src/types/module.ts:138](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/module.ts#L138)
189189

190190
Set a usage message shown at the top of the command's help text.
191191

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

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

99
> **ConfigurationHooks**\<`CustomContext`\> = `object`
1010
11-
Defined in: [src/types/configure.ts:111](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/configure.ts#L111)
11+
Defined in: [src/types/configure.ts:111](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/configure.ts#L111)
1212

1313
An object containing zero or more configuration hooks. See each hook type
1414
definition for details.
@@ -25,7 +25,7 @@ definition for details.
2525

2626
> `optional` **configureArguments**: [`ConfigureArguments`](ConfigureArguments.md)\<`CustomContext`\>
2727
28-
Defined in: [src/types/configure.ts:160](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/configure.ts#L160)
28+
Defined in: [src/types/configure.ts:160](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/configure.ts#L160)
2929

3030
This function is called once towards the beginning of the execution of
3131
`PreExecutionContext::execute` and should return a `process.argv`-like
@@ -44,7 +44,7 @@ text to stderr regardless of error type.
4444

4545
> `optional` **configureErrorHandlingEpilogue**: [`ConfigureErrorHandlingEpilogue`](ConfigureErrorHandlingEpilogue.md)\<`CustomContext`\>
4646
47-
Defined in: [src/types/configure.ts:188](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/configure.ts#L188)
47+
Defined in: [src/types/configure.ts:188](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/configure.ts#L188)
4848

4949
This function is called once at the very end of the error handling process
5050
after an error has occurred.
@@ -64,7 +64,7 @@ reports an argument parsing/validation error.
6464

6565
> `optional` **configureExecutionContext**: [`ConfigureExecutionContext`](ConfigureExecutionContext.md)\<`CustomContext`\>
6666
67-
Defined in: [src/types/configure.ts:128](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/configure.ts#L128)
67+
Defined in: [src/types/configure.ts:128](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/configure.ts#L128)
6868

6969
This function is called once towards the beginning of the execution of
7070
`configureProgram` and should return the value that will become the global
@@ -85,7 +85,7 @@ regardless of error type.
8585

8686
> `optional` **configureExecutionEpilogue**: [`ConfigureExecutionEpilogue`](ConfigureExecutionEpilogue.md)\<`CustomContext`\>
8787
88-
Defined in: [src/types/configure.ts:174](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/configure.ts#L174)
88+
Defined in: [src/types/configure.ts:174](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/configure.ts#L174)
8989

9090
This function is called once after CLI argument parsing completes and
9191
either (1) handler execution succeeds or (2) a `GracefulEarlyExitError` is
@@ -105,7 +105,7 @@ text to stderr regardless of error type.
105105

106106
> `optional` **configureExecutionPrologue**: [`ConfigureExecutionPrologue`](ConfigureExecutionPrologue.md)\<`CustomContext`\>
107107
108-
Defined in: [src/types/configure.ts:147](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/configure.ts#L147)
108+
Defined in: [src/types/configure.ts:147](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/configure.ts#L147)
109109

110110
This function is called once towards the end of the execution of
111111
`configureProgram`, after all commands have been discovered but before any

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

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

99
> **ConfigureArguments**\<`CustomContext`\> = (`rawArgv`, `context`) => `Promisable`\<*typeof* `process.argv`\>
1010
11-
Defined in: [src/types/configure.ts:59](https://github.com/Xunnamius/black-flag/blob/8d031666f2b06def50a0b12d4e86a7961a49e69d/src/types/configure.ts#L59)
11+
Defined in: [src/types/configure.ts:59](https://github.com/Xunnamius/black-flag/blob/54f69b5502007e20a8937998cea6e285d5db6d7c/src/types/configure.ts#L59)
1212

1313
This function is called once towards the beginning of the execution of
1414
`PreExecutionContext::execute` and should return a `process.argv`-like array.

0 commit comments

Comments
 (0)