Skip to content

Commit 335be15

Browse files
committed
release: @black-flag/[email protected] [skip ci]
## 💥 BREAKING CHANGES 💥 - `$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`. ## ✨ Features - **packages/extensions:** implement @black-flag/extensions ([f0525c5][2]) ## 🪄 Fixes - Fix Windows interop issues ([b3abf95][3]) <sup>see [#174][4]</sup> ## ⚙️ Build System - **deps:** bump type-fest from 4.35.0 to 4.36.0 ([80350cc][5]) - **deps:** bump type-fest from 4.36.0 to 4.37.0 ([7c8ff7a][6]) - **husky:** force lint-staged (via husky) to only use global config file ([5d3f2cc][7]) - **packages/extensions:** use correct git repo metadata in package.json ([0548f8f][8]) ## 🧙🏿 Refactored - Make exported symbols cross-realm ([af78a8f][9]) - Rename and restructure exports for better docs generation ([8303ba7][10]) [1]: https://github.com/Xunnamius/black-flag/compare/@black-flag/[email protected]...@black-flag/[email protected] [2]: f0525c5 [3]: b3abf95 [4]: #174 [5]: 80350cc [6]: 7c8ff7a [7]: 5d3f2cc [8]: 0548f8f [9]: af78a8f [10]: 8303ba7
1 parent 3c3f6e1 commit 335be15

33 files changed

+94
-32
lines changed

Diff for: packages/extensions/CHANGELOG.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this auto-generated
4+
file. The format is based on [Conventional Commits][1];
5+
this project adheres to [Semantic Versioning][2].
6+
7+
<br />
8+
9+
## @black-flag/extensions[@2.0.0][3] (2025-03-14)
10+
11+
### 💥 BREAKING CHANGES 💥
12+
13+
- `$executionContext` and `$artificiallyInvoked` symbols are now drawn from the global symbol registry. They will not match symbols from previous versions!
14+
15+
- **All instances in source where `commandModulePath` appeared have been replaced by `commandModulesPath`. This includes the call signatures of functions like `makeRunner`.**
16+
17+
The fix is simple: find-and-replace all instances of `commandModulePath` with `commandModulesPath`.
18+
19+
### ✨ Features
20+
21+
- **packages/extensions:** implement @black-flag/extensions ([f0525c5][4])
22+
23+
### 🪄 Fixes
24+
25+
- Fix Windows interop issues ([b3abf95][5]) <sup>see [#174][6]</sup>
26+
27+
### ⚙️ Build System
28+
29+
- **deps:** bump type-fest from 4.35.0 to 4.36.0 ([80350cc][7])
30+
- **deps:** bump type-fest from 4.36.0 to 4.37.0 ([7c8ff7a][8])
31+
- **husky:** force lint-staged (via husky) to only use global config file ([5d3f2cc][9])
32+
- **packages/extensions:** use correct git repo metadata in package.json ([0548f8f][10])
33+
34+
### 🧙🏿 Refactored
35+
36+
- Make exported symbols cross-realm ([af78a8f][11])
37+
- Rename and restructure exports for better docs generation ([8303ba7][12])
38+
39+
## @black-flag/extensions[@1.0.2][13] (2025-02-21)
40+
41+
#### ⚙️ Build System
42+
43+
- **husky:** update to latest hooks ([75d5c66][14])
44+
- **tsconfig:** fix internal path resolution ([fbe3a69][15])
45+
- **tsconfig:** upgrade to NodeNext ([d3a499e][16])
46+
47+
[1]: https://conventionalcommits.org
48+
[2]: https://semver.org
49+
[3]: https://github.com/Xunnamius/black-flag/compare/@black-flag/[email protected]...@black-flag/[email protected]
50+
[4]: https://github.com/Xunnamius/black-flag/commit/f0525c5f4bf72b0f28fedf4f6d66f4a1b7353b05
51+
[5]: https://github.com/Xunnamius/black-flag/commit/b3abf95ca2958d5d2fca1091178c050ef88fe5f5
52+
[6]: https://github.com/Xunnamius/black-flag/issues/174
53+
[7]: https://github.com/Xunnamius/black-flag/commit/80350cca61bef915d737fb097e4e3838118a1167
54+
[8]: https://github.com/Xunnamius/black-flag/commit/7c8ff7ad8ffd4d822329278da0a21db54f904f25
55+
[9]: https://github.com/Xunnamius/black-flag/commit/5d3f2ccdfcd615917892d27a5c2cfa1b28879e0c
56+
[10]: https://github.com/Xunnamius/black-flag/commit/0548f8fe3c7daa363173184e34f2307f8964dbed
57+
[11]: https://github.com/Xunnamius/black-flag/commit/af78a8fbc5839e0d3db1b07312bbc854ef1b7a0d
58+
[12]: https://github.com/Xunnamius/black-flag/commit/8303ba7f438ae7f7dedfc2b6f5fd396cab32b252
59+
[13]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...@black-flag/[email protected]
60+
[14]: https://github.com/Xunnamius/black-flag/commit/75d5c66bcce8f0c2c139962f7ddd28aa0c9499d7
61+
[15]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f
62+
[16]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f

Diff for: packages/extensions/docs/constant/variables/globalDebuggerNamespace.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88

99
> `const` **globalDebuggerNamespace**: `"bfe"` = `'bfe'`
1010
11-
Defined in: [packages/extensions/src/constant.ts:4](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/constant.ts#L4)
11+
Defined in: [packages/extensions/src/constant.ts:4](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/constant.ts#L4)
1212

1313
The project-wide namespace that appears in debugger output.

Diff for: packages/extensions/docs/error/type-aliases/KeyValueEntries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88

99
> **KeyValueEntries**: `Entries`\<\{\}\>
1010
11-
Defined in: [packages/extensions/src/error.ts:7](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/error.ts#L7)
11+
Defined in: [packages/extensions/src/error.ts:7](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/error.ts#L7)

Diff for: packages/extensions/docs/error/type-aliases/KeyValueEntry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88

99
> **KeyValueEntry**: [`KeyValueEntries`](KeyValueEntries.md)\[`number`\]
1010
11-
Defined in: [packages/extensions/src/error.ts:8](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/error.ts#L8)
11+
Defined in: [packages/extensions/src/error.ts:8](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/error.ts#L8)

Diff for: packages/extensions/docs/error/variables/BfeErrorMessage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> `const` **BfeErrorMessage**: `object`
1010
11-
Defined in: [packages/extensions/src/error.ts:14](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/error.ts#L14)
11+
Defined in: [packages/extensions/src/error.ts:14](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/error.ts#L14)
1212

1313
A collection of possible error and warning messages.
1414

Diff for: packages/extensions/docs/index/functions/getInvocableExtendedHandler.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **getInvocableExtendedHandler**\<`CustomCliArguments`, `CustomExecutionContext`\>(`maybeCommand`, `context`): `Promise`\<(`argv_`) => `Promise`\<`void`\>\>
1010
11-
Defined in: [packages/extensions/src/index.ts:1400](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L1400)
11+
Defined in: [packages/extensions/src/index.ts:1400](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L1400)
1212

1313
This function returns a version of `maybeCommand`'s handler function that is
1414
ready to invoke immediately. It can be used with both BFE and normal Black

Diff for: packages/extensions/docs/index/functions/withBuilderExtensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **withBuilderExtensions**\<`CustomCliArguments`, `CustomExecutionContext`\>(`customBuilder`?, `__namedParameters`?): [`WithBuilderExtensionsReturnType`](../type-aliases/WithBuilderExtensionsReturnType.md)\<`CustomCliArguments`, `CustomExecutionContext`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:725](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L725)
11+
Defined in: [packages/extensions/src/index.ts:725](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L725)
1212

1313
This function enables several additional options-related units of
1414
functionality via analysis of the returned options configuration object and

Diff for: packages/extensions/docs/index/functions/withUsageExtensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **withUsageExtensions**(`altDescription`, `__namedParameters`): `string`
1010
11-
Defined in: [packages/extensions/src/index.ts:1336](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L1336)
11+
Defined in: [packages/extensions/src/index.ts:1336](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L1336)
1212

1313
Generate command usage text consistently yet flexibly.
1414

Diff for: packages/extensions/docs/index/type-aliases/AsStrictExecutionContext.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **AsStrictExecutionContext**\<`CustomExecutionContext`\>: `OmitIndexSignature`\<`Exclude`\<`CustomExecutionContext`, `"state"`\>\> & `OmitIndexSignature`\<`CustomExecutionContext`\[`"state"`\]\>
1010
11-
Defined in: [packages/extensions/src/index.ts:617](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L617)
11+
Defined in: [packages/extensions/src/index.ts:617](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L617)
1212

1313
A stricter version of Black Flag's
1414
[ExecutionContext](https://github.com/Xunnamius/black-flag/blob/main/docs/api/src/exports/util/type-aliases/ExecutionContext.md)

Diff for: packages/extensions/docs/index/type-aliases/BfBuilderFunction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfBuilderFunction**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Extract`\<`Configuration`\<`CustomCliArguments`, `CustomExecutionContext`\>\[`"builder"`\], `Function`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:160](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L160)
11+
Defined in: [packages/extensions/src/index.ts:160](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L160)
1212

1313
The function type of the `builder` export accepted by Black Flag.
1414

Diff for: packages/extensions/docs/index/type-aliases/BfBuilderObject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfBuilderObject**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Exclude`\<`Configuration`\<`CustomCliArguments`, `CustomExecutionContext`\>\[`"builder"`\], `Function`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:172](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L172)
11+
Defined in: [packages/extensions/src/index.ts:172](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L172)
1212

1313
The object type of the `builder` export accepted by Black Flag.
1414

Diff for: packages/extensions/docs/index/type-aliases/BfBuilderObjectValue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfBuilderObjectValue**\<`CustomCliArguments`, `CustomExecutionContext`\>: [`BfBuilderObject`](BfBuilderObject.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\[`string`\]
1010
11-
Defined in: [packages/extensions/src/index.ts:186](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L186)
11+
Defined in: [packages/extensions/src/index.ts:186](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L186)
1212

1313
The object value type of a [BfBuilderObject](BfBuilderObject.md).
1414

Diff for: packages/extensions/docs/index/type-aliases/BfGenericBuilderObjectValue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88

99
> **BfGenericBuilderObjectValue**: [`BfBuilderObjectValue`](BfBuilderObjectValue.md)\<`Record`\<`string`, `unknown`\>, `ExecutionContext`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:194](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L194)
11+
Defined in: [packages/extensions/src/index.ts:194](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L194)
1212

1313
The generic object value type of a [BfBuilderObject](BfBuilderObject.md).

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderFunction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderFunction**\<`CustomCliArguments`, `CustomExecutionContext`\>: (...`args`) => [`BfBuilderObject`](BfBuilderObject.md)\<`CustomCliArguments`, `CustomExecutionContext`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:580](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L580)
11+
Defined in: [packages/extensions/src/index.ts:580](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L580)
1212

1313
This function implements several additional optionals-related units of
1414
functionality. This function is meant to take the place of a command's

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderObject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderObject**\<`CustomCliArguments`, `CustomExecutionContext`\>: `object`
1010
11-
Defined in: [packages/extensions/src/index.ts:203](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L203)
11+
Defined in: [packages/extensions/src/index.ts:203](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L203)
1212

1313
A version of the object type of the `builder` export accepted by Black Flag
1414
that supports BFE's additional functionality.

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderObjectValue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderObjectValue**\<`CustomCliArguments`, `CustomExecutionContext`\>: [`BfeBuilderObjectValueWithoutExtensions`](BfeBuilderObjectValueWithoutExtensions.md) & [`BfeBuilderObjectValueExtensions`](BfeBuilderObjectValueExtensions.md)\<`CustomCliArguments`, `CustomExecutionContext`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:213](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L213)
11+
Defined in: [packages/extensions/src/index.ts:213](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L213)
1212

1313
The object value type of a [BfeBuilderObject](BfeBuilderObject.md).
1414

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderObjectValueExtensionObject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderObjectValueExtensionObject**: `Record`\<`string`, `unknown`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:461](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L461)
11+
Defined in: [packages/extensions/src/index.ts:461](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L461)
1212

1313
The object type of a [BfeBuilderObjectValueExtensions](BfeBuilderObjectValueExtensions.md).
1414

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderObjectValueExtensionValue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderObjectValueExtensionValue**: `string` \| [`BfeBuilderObjectValueExtensionObject`](BfeBuilderObjectValueExtensionObject.md) \| (`string` \| [`BfeBuilderObjectValueExtensionObject`](BfeBuilderObjectValueExtensionObject.md))[]
1010
11-
Defined in: [packages/extensions/src/index.ts:451](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L451)
11+
Defined in: [packages/extensions/src/index.ts:451](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L451)
1212

1313
The string/object/array type of a [BfeBuilderObjectValueExtensions](BfeBuilderObjectValueExtensions.md).
1414

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderObjectValueExtensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderObjectValueExtensions**\<`CustomCliArguments`, `CustomExecutionContext`\>: `object`
1010
11-
Defined in: [packages/extensions/src/index.ts:226](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L226)
11+
Defined in: [packages/extensions/src/index.ts:226](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L226)
1212

1313
An object containing only those properties recognized by
1414
BFE.

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderObjectValueWithoutExtensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderObjectValueWithoutExtensions**: `Omit`\<[`BfGenericBuilderObjectValue`](BfGenericBuilderObjectValue.md), `"conflicts"` \| `"implies"` \| `"demandOption"` \| `"demand"` \| `"require"` \| `"required"` \| `"default"` \| `"coerce"`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:474](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L474)
11+
Defined in: [packages/extensions/src/index.ts:474](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L474)
1212

1313
An object containing a subset of only those properties recognized by
1414
Black Flag (and, consequentially, vanilla yargs). Also excludes

Diff for: packages/extensions/docs/index/type-aliases/BfeBuilderObjectValueWithoutSubOptionOfExtension.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeBuilderObjectValueWithoutSubOptionOfExtension**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Omit`\<[`BfeBuilderObjectValue`](BfeBuilderObjectValue.md)\<`CustomCliArguments`, `CustomExecutionContext`\>, `"subOptionOf"`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:490](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L490)
11+
Defined in: [packages/extensions/src/index.ts:490](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L490)
1212

1313
A [BfeBuilderObjectValue](BfeBuilderObjectValue.md) instance with the `subOptionOf` BFE key
1414
omitted.

Diff for: packages/extensions/docs/index/type-aliases/BfeCheckFunction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeCheckFunction**\<`CustomCliArguments`, `CustomExecutionContext`\>: (`currentArgumentValue`, `argv`) => `Promisable`\<`unknown`\>
1010
11-
Defined in: [packages/extensions/src/index.ts:561](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L561)
11+
Defined in: [packages/extensions/src/index.ts:561](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L561)
1212

1313
This function is used to validate an argument passed to Black Flag.
1414

Diff for: packages/extensions/docs/index/type-aliases/BfeCustomBuilderFunctionParameters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeCustomBuilderFunctionParameters**\<`CustomCliArguments`, `CustomExecutionContext`, `P`\>: `P` *extends* \[infer R, `...(infer S)`\] ? `S` *extends* \[infer T, `...(infer _U)`\] ? \[`R` & `object`, `T`, [`BfeStrictArguments`](BfeStrictArguments.md)\<`Partial`\<`CustomCliArguments`\>, `CustomExecutionContext`\> \| `undefined`\] : \[`R` & `object`, `...S`\] : `never`
1010
11-
Defined in: [packages/extensions/src/index.ts:627](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L627)
11+
Defined in: [packages/extensions/src/index.ts:627](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L627)
1212

1313
A version of Black Flag's `builder` function parameters that exclude yargs
1414
methods that are not supported by BFE.

Diff for: packages/extensions/docs/index/type-aliases/BfeStrictArguments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeStrictArguments**\<`CustomCliArguments`, `CustomExecutionContext`\>: `OmitIndexSignature`\<`Arguments`\<`CustomCliArguments`, `CustomExecutionContext`\>\> & `FrameworkArguments`\<`CustomExecutionContext`\> & `object`
1010
11-
Defined in: [packages/extensions/src/index.ts:597](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L597)
11+
Defined in: [packages/extensions/src/index.ts:597](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L597)
1212

1313
A stricter version of Black Flag's
1414
[Arguments](https://github.com/Xunnamius/black-flag/blob/main/docs/api/src/exports/type-aliases/Arguments.md)

Diff for: packages/extensions/docs/index/type-aliases/BfeSubOptionOfExtensionValue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **BfeSubOptionOfExtensionValue**\<`CustomCliArguments`, `CustomExecutionContext`\>: `object`
1010
11-
Defined in: [packages/extensions/src/index.ts:502](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L502)
11+
Defined in: [packages/extensions/src/index.ts:502](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L502)
1212

1313
The array element type of
1414
[BfeBuilderObjectValueExtensions.subOptionOf](BfeBuilderObjectValueExtensions.md#suboptionof).

Diff for: packages/extensions/docs/index/type-aliases/WithBuilderExtensionsConfig.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **WithBuilderExtensionsConfig**\<`CustomCliArguments`\>: `object`
1010
11-
Defined in: [packages/extensions/src/index.ts:687](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L687)
11+
Defined in: [packages/extensions/src/index.ts:687](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L687)
1212

1313
A configuration object that further configures the behavior of
1414
[withBuilderExtensions](../functions/withBuilderExtensions.md).

Diff for: packages/extensions/docs/index/type-aliases/WithBuilderExtensionsReturnType.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **WithBuilderExtensionsReturnType**\<`CustomCliArguments`, `CustomExecutionContext`\>: \[[`BfeBuilderFunction`](BfeBuilderFunction.md)\<`CustomCliArguments`, `CustomExecutionContext`\>, [`WithHandlerExtensions`](WithHandlerExtensions.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\]
1010
11-
Defined in: [packages/extensions/src/index.ts:672](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L672)
11+
Defined in: [packages/extensions/src/index.ts:672](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L672)
1212

1313
The array of extended exports and high-order functions returned by
1414
[withBuilderExtensions](../functions/withBuilderExtensions.md).

Diff for: packages/extensions/docs/index/type-aliases/WithHandlerExtensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **WithHandlerExtensions**\<`CustomCliArguments`, `CustomExecutionContext`\>: (`customHandler`?) => `Configuration`\<`CustomCliArguments`, `CustomExecutionContext`\>\[`"handler"`\]
1010
11-
Defined in: [packages/extensions/src/index.ts:659](https://github.com/Xunnamius/black-flag/blob/10cd0ebc0304d033218ec4dffba0c41cb2e85ff6/packages/extensions/src/index.ts#L659)
11+
Defined in: [packages/extensions/src/index.ts:659](https://github.com/Xunnamius/black-flag/blob/3c3f6e1e60095912b550318378e24dc68e62b7d6/packages/extensions/src/index.ts#L659)
1212

1313
This function implements several additional optionals-related units of
1414
functionality. The return value of this function is meant to take the place

0 commit comments

Comments
 (0)