diff --git a/CHANGELOG.md b/CHANGELOG.md index 43c29c9..6a44b28 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,156 +4,169 @@ All notable changes to this project will be documented in this auto-generated file. The format is based on [Conventional Commits][1]; this project adheres to [Semantic Versioning][2]. -### [1.2.6][3] (2024-06-02) +### [1.2.7][3] (2024-06-30) #### 🪄 Fixes -- **src:** ignore --help and --version if they occur after -- in argv ([35f66cc][4]) +- **types:** pass through `CustomExecutionContext` as context type in `ImportedConfigurationModule` ([cdc6af5][4]) -### [1.2.5][5] (2024-05-30) +#### ⚙️ Build System + +- **spellcheck-commit:** fix commit spellchecker ([6e7a268][5]) + +### [1.2.6][6] (2024-06-02) + +#### 🪄 Fixes + +- **src:** ignore --help and --version if they occur after -- in argv ([35f66cc][7]) + +### [1.2.5][8] (2024-05-30) #### 🪄 Fixes -- **src:** permanently fix --version support regression in node\@22 ([c201c2f][6]) +- **src:** permanently fix --version support regression in node\@22 ([c201c2f][9]) #### ⚙️ Build System -- **package:** append node\@22 to supported node versions ([98815d1][7]) +- **package:** append node\@22 to supported node versions ([98815d1][10]) -### [1.2.4][8] (2024-03-27) +### [1.2.4][11] (2024-03-27) #### 🪄 Fixes -- **src:** explicitly ignore .d.ts files within command dirs ([d6618d3][9]) +- **src:** explicitly ignore .d.ts files within command dirs ([d6618d3][12]) -### [1.2.3][10] (2024-03-27) +### [1.2.3][13] (2024-03-27) #### 🪄 Fixes -- **package:** bump minimum node support to 20 LTS ([4b8c975][11]) -- **src:** ignore unknown file extension errors when discovering commands ([4babf12][12]) +- **package:** bump minimum node support to 20 LTS ([4b8c975][14]) +- **src:** ignore unknown file extension errors when discovering commands ([4babf12][15]) -### [1.2.2][13] (2024-03-21) +### [1.2.2][16] (2024-03-21) #### 🪄 Fixes -- No longer include default command when listing subcommands ([be2960a][14]) +- No longer include default command when listing subcommands ([be2960a][17]) #### ⚙️ Build System -- **husky:** update to latest hooks ([75d5c66][15]) -- **src:** do not filter to own methods when proxying and rebinding ([8bb0254][16]) +- **husky:** update to latest hooks ([75d5c66][18]) +- **src:** do not filter to own methods when proxying and rebinding ([8bb0254][19]) -### [1.2.1][17] (2024-03-19) +### [1.2.1][20] (2024-03-19) #### ⚙️ Build System -- **babel:** fix import specifier rewrite oversight ([2369534][18]) +- **babel:** fix import specifier rewrite oversight ([2369534][21]) -## [1.2.0][19] (2024-03-18) +## [1.2.0][22] (2024-03-18) #### ✨ Features -- Add `showHelp` option to `CliError` ([b5a1e58][20]) +- Add `showHelp` option to `CliError` ([b5a1e58][23]) -### [1.1.4][21] (2024-03-16) +### [1.1.4][24] (2024-03-16) #### 🪄 Fixes -- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][22]) +- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][25]) -### [1.1.3][23] (2024-03-15) +### [1.1.3][26] (2024-03-15) #### 🪄 Fixes -- Add support for `export default X` syntax ([bad391d][24]) -- Ensure `demandOption` is properly supported ([2f205c1][25]) +- Add support for `export default X` syntax ([bad391d][27]) +- Ensure `demandOption` is properly supported ([2f205c1][28]) -### [1.1.2][26] (2023-12-31) +### [1.1.2][29] (2023-12-31) #### 🪄 Fixes -- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][27]) +- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][30]) -### [1.1.1][28] (2023-12-31) +### [1.1.1][31] (2023-12-31) #### 🪄 Fixes -- Fix Node10 type resolution failure ([b6178c9][29]) +- Fix Node10 type resolution failure ([b6178c9][32]) -## [1.1.0][30] (2023-12-31) +## [1.1.0][33] (2023-12-31) #### ✨ Features -- **src:** support file://-style URLs ([0e5067e][31]) +- **src:** support file://-style URLs ([0e5067e][34]) #### 🪄 Fixes -- **src:** ensure --version is included in help text output when relevant ([4f159dc][32]) +- **src:** ensure --version is included in help text output when relevant ([4f159dc][35]) #### ⚙️ Build System -- **babel:** fix ESM<=>CJS interop issue ([5470091][33]) +- **babel:** fix ESM<=>CJS interop issue ([5470091][36]) -## [1.0.0][34] (2023-12-29) +## [1.0.0][37] (2023-12-29) #### ✨ Features -- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][35]) +- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][38]) #### 🪄 Fixes -- Rename package from "black-flag" to "[@black-][36]flag/core" npm typosquat workaround ([292ead5][37]) +- Rename package from "black-flag" to "[@black-][39]flag/core" npm typosquat workaround ([292ead5][40]) #### ⚙️ Build System -- Fix horrible decision by marked devs to break output for no reason ([036e350][38]) -- **jest:** ensure pkg-up is transformed ([c7f4aef][39]) -- **jest:** fix transformIgnorePatterns ([0548d34][40]) -- **jest:** transpile node\_modules ([5cf7a6c][41]) -- **tsconfig:** fix internal path resolution ([fbe3a69][42]) -- **tsconfig:** upgrade to NodeNext ([d3a499e][43]) +- Fix horrible decision by marked devs to break output for no reason ([036e350][41]) +- **jest:** ensure pkg-up is transformed ([c7f4aef][42]) +- **jest:** fix transformIgnorePatterns ([0548d34][43]) +- **jest:** transpile node\_modules ([5cf7a6c][44]) +- **tsconfig:** fix internal path resolution ([fbe3a69][45]) +- **tsconfig:** upgrade to NodeNext ([d3a499e][46]) [1]: https://conventionalcommits.org [2]: https://semver.org -[3]: https://github.com/Xunnamius/black-flag/compare/v1.2.5...v1.2.6 -[4]: https://github.com/Xunnamius/black-flag/commit/35f66cc9d69f8434d03db49f067b4f7e03d4c58c -[5]: https://github.com/Xunnamius/black-flag/compare/v1.2.4...v1.2.5 -[6]: https://github.com/Xunnamius/black-flag/commit/c201c2ff87c1119b9678e38acdc12918d2ed7fc2 -[7]: https://github.com/Xunnamius/black-flag/commit/98815d1ef218af56e07493a921c66294f91101cf -[8]: https://github.com/Xunnamius/black-flag/compare/v1.2.3...v1.2.4 -[9]: https://github.com/Xunnamius/black-flag/commit/d6618d370bd9a7264dad240856dc989a61071986 -[10]: https://github.com/Xunnamius/black-flag/compare/v1.2.2...v1.2.3 -[11]: https://github.com/Xunnamius/black-flag/commit/4b8c9759bc09f9b07593ce89446d4ec0e614db71 -[12]: https://github.com/Xunnamius/black-flag/commit/4babf12308b7aab0ed319077701eb6f3a1fdf1d3 -[13]: https://github.com/Xunnamius/black-flag/compare/v1.2.1...v1.2.2 -[14]: https://github.com/Xunnamius/black-flag/commit/be2960a507c43b3db598157de4dcafe22ee8906e -[15]: https://github.com/Xunnamius/black-flag/commit/75d5c66bcce8f0c2c139962f7ddd28aa0c9499d7 -[16]: https://github.com/Xunnamius/black-flag/commit/8bb025436d219c024a5d4a4a0ac59999440b7c13 -[17]: https://github.com/Xunnamius/black-flag/compare/v1.2.0...v1.2.1 -[18]: https://github.com/Xunnamius/black-flag/commit/2369534f63aa3858714bb81505d3fff4ed77c6b1 -[19]: https://github.com/Xunnamius/black-flag/compare/v1.1.4...v1.2.0 -[20]: https://github.com/Xunnamius/black-flag/commit/b5a1e58add31902fd9ec80b93dd37305b8fd0684 -[21]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4 -[22]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824 -[23]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3 -[24]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53 -[25]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8 -[26]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2 -[27]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271 -[28]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1 -[29]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c -[30]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0 -[31]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98 -[32]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea -[33]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8 -[34]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0 -[35]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842 -[36]: https://github.com/black- -[37]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d -[38]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87 -[39]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff -[40]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72 -[41]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17 -[42]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f -[43]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f +[3]: https://github.com/Xunnamius/black-flag/compare/v1.2.6...v1.2.7 +[4]: https://github.com/Xunnamius/black-flag/commit/cdc6af55387aac92b7d9fc16a57790068e4b6d49 +[5]: https://github.com/Xunnamius/black-flag/commit/6e7a268bebe71f19120fd926b004f3cb9e490760 +[6]: https://github.com/Xunnamius/black-flag/compare/v1.2.5...v1.2.6 +[7]: https://github.com/Xunnamius/black-flag/commit/35f66cc9d69f8434d03db49f067b4f7e03d4c58c +[8]: https://github.com/Xunnamius/black-flag/compare/v1.2.4...v1.2.5 +[9]: https://github.com/Xunnamius/black-flag/commit/c201c2ff87c1119b9678e38acdc12918d2ed7fc2 +[10]: https://github.com/Xunnamius/black-flag/commit/98815d1ef218af56e07493a921c66294f91101cf +[11]: https://github.com/Xunnamius/black-flag/compare/v1.2.3...v1.2.4 +[12]: https://github.com/Xunnamius/black-flag/commit/d6618d370bd9a7264dad240856dc989a61071986 +[13]: https://github.com/Xunnamius/black-flag/compare/v1.2.2...v1.2.3 +[14]: https://github.com/Xunnamius/black-flag/commit/4b8c9759bc09f9b07593ce89446d4ec0e614db71 +[15]: https://github.com/Xunnamius/black-flag/commit/4babf12308b7aab0ed319077701eb6f3a1fdf1d3 +[16]: https://github.com/Xunnamius/black-flag/compare/v1.2.1...v1.2.2 +[17]: https://github.com/Xunnamius/black-flag/commit/be2960a507c43b3db598157de4dcafe22ee8906e +[18]: https://github.com/Xunnamius/black-flag/commit/75d5c66bcce8f0c2c139962f7ddd28aa0c9499d7 +[19]: https://github.com/Xunnamius/black-flag/commit/8bb025436d219c024a5d4a4a0ac59999440b7c13 +[20]: https://github.com/Xunnamius/black-flag/compare/v1.2.0...v1.2.1 +[21]: https://github.com/Xunnamius/black-flag/commit/2369534f63aa3858714bb81505d3fff4ed77c6b1 +[22]: https://github.com/Xunnamius/black-flag/compare/v1.1.4...v1.2.0 +[23]: https://github.com/Xunnamius/black-flag/commit/b5a1e58add31902fd9ec80b93dd37305b8fd0684 +[24]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4 +[25]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824 +[26]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3 +[27]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53 +[28]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8 +[29]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2 +[30]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271 +[31]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1 +[32]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c +[33]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0 +[34]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98 +[35]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea +[36]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8 +[37]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0 +[38]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842 +[39]: https://github.com/black- +[40]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d +[41]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87 +[42]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff +[43]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72 +[44]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17 +[45]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f +[46]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f diff --git a/docs/index/classes/CliError.md b/docs/index/classes/CliError.md index f377e5a..5c17b16 100644 --- a/docs/index/classes/CliError.md +++ b/docs/index/classes/CliError.md @@ -47,9 +47,9 @@ other context. `AppError.constructor` -#### Source +#### Defined in -[src/error.ts:101](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L101) +[src/error.ts:101](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L101) ### new CliError() @@ -76,9 +76,9 @@ via `super`. `AppError.constructor` -#### Source +#### Defined in -[src/error.ts:106](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L106) +[src/error.ts:106](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L106) ## Properties @@ -86,9 +86,9 @@ via `super`. > **\[$type\]**: `string`[] -#### Source +#### Defined in -[src/error.ts:96](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L96) +[src/error.ts:96](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L96) *** @@ -100,7 +100,7 @@ via `super`. `AppError.cause` -#### Source +#### Defined in node\_modules/typescript/lib/lib.es2022.error.d.ts:24 @@ -114,7 +114,7 @@ node\_modules/typescript/lib/lib.es2022.error.d.ts:24 `AppError.message` -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1077 @@ -128,7 +128,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1077 `AppError.name` -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1076 @@ -138,13 +138,23 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 > **showHelp**: `boolean` = `false` +If `true`, help text will be sent to stderr _before this exception finishes +bubbling_. Where the exception is thrown will determine which instance is +responsible for error text generation. + +#### Default + +```ts +false +``` + #### Implementation of `NonNullable.showHelp` -#### Source +#### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L94) *** @@ -156,7 +166,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 `AppError.stack` -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1078 @@ -166,13 +176,22 @@ node\_modules/typescript/lib/lib.es5.d.ts:1078 > **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError` +The exit code that will be returned when the application exits, given +nothing else goes wrong in the interim. + +#### Default + +```ts +FrameworkExitCode.DefaultError +``` + #### Implementation of `NonNullable.suggestedExitCode` -#### Source +#### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L93) *** @@ -200,7 +219,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces `AppError.prepareStackTrace` -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:28 @@ -214,7 +233,7 @@ node\_modules/@types/node/globals.d.ts:28 `AppError.stackTraceLimit` -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:30 @@ -240,6 +259,6 @@ Create .stack property on a target object `AppError.captureStackTrace` -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:21 diff --git a/docs/index/classes/GracefulEarlyExitError.md b/docs/index/classes/GracefulEarlyExitError.md index 2a1b0ed..463a6ca 100644 --- a/docs/index/classes/GracefulEarlyExitError.md +++ b/docs/index/classes/GracefulEarlyExitError.md @@ -32,9 +32,9 @@ termination of the application but with an exit code indicating success [`CliError`](CliError.md).[`constructor`](CliError.md#constructors) -#### Source +#### Defined in -[src/error.ts:172](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L172) +[src/error.ts:172](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L172) ## Properties @@ -46,9 +46,9 @@ termination of the application but with an exit code indicating success [`CliError`](CliError.md).[`[$type]`](CliError.md#%5B$type%5D) -#### Source +#### Defined in -[src/error.ts:166](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L166) +[src/error.ts:166](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L166) *** @@ -60,7 +60,7 @@ termination of the application but with an exit code indicating success [`CliError`](CliError.md).[`cause`](CliError.md#cause) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es2022.error.d.ts:24 @@ -74,7 +74,7 @@ node\_modules/typescript/lib/lib.es2022.error.d.ts:24 [`CliError`](CliError.md).[`message`](CliError.md#message) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1077 @@ -88,7 +88,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1077 [`CliError`](CliError.md).[`name`](CliError.md#name) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1076 @@ -98,13 +98,23 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 > **showHelp**: `boolean` = `false` +If `true`, help text will be sent to stderr _before this exception finishes +bubbling_. Where the exception is thrown will determine which instance is +responsible for error text generation. + +#### Default + +```ts +false +``` + #### Inherited from [`CliError`](CliError.md).[`showHelp`](CliError.md#showhelp) -#### Source +#### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L94) *** @@ -116,7 +126,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 [`CliError`](CliError.md).[`stack`](CliError.md#stack) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1078 @@ -126,13 +136,22 @@ node\_modules/typescript/lib/lib.es5.d.ts:1078 > **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError` +The exit code that will be returned when the application exits, given +nothing else goes wrong in the interim. + +#### Default + +```ts +FrameworkExitCode.DefaultError +``` + #### Inherited from [`CliError`](CliError.md).[`suggestedExitCode`](CliError.md#suggestedexitcode) -#### Source +#### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L93) *** @@ -160,7 +179,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces [`CliError`](CliError.md).[`prepareStackTrace`](CliError.md#preparestacktrace) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:28 @@ -174,7 +193,7 @@ node\_modules/@types/node/globals.d.ts:28 [`CliError`](CliError.md).[`stackTraceLimit`](CliError.md#stacktracelimit) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:30 @@ -200,6 +219,6 @@ Create .stack property on a target object [`CliError`](CliError.md).[`captureStackTrace`](CliError.md#capturestacktrace) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:21 diff --git a/docs/index/enumerations/FrameworkExitCode.md b/docs/index/enumerations/FrameworkExitCode.md index 916f739..a9dceed 100644 --- a/docs/index/enumerations/FrameworkExitCode.md +++ b/docs/index/enumerations/FrameworkExitCode.md @@ -20,9 +20,9 @@ this code, that's a hint to re-run things in debug mode (example: In most cases, this exit code is indicative of improper use of Black Flag. -#### Source +#### Defined in -[src/constant.ts:60](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L60) +[src/constant.ts:60](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L60) *** @@ -32,9 +32,9 @@ In most cases, this exit code is indicative of improper use of Black Flag. Hard-coded default fallback exit code when fatal errors occur. -#### Source +#### Defined in -[src/constant.ts:48](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L48) +[src/constant.ts:48](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L48) *** @@ -44,9 +44,9 @@ Hard-coded default fallback exit code when fatal errors occur. The exit code used when executing an unimplemented child command. -#### Source +#### Defined in -[src/constant.ts:52](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L52) +[src/constant.ts:52](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L52) *** @@ -56,6 +56,6 @@ The exit code used when executing an unimplemented child command. The exit code used when execution succeeds and exits gracefully. -#### Source +#### Defined in -[src/constant.ts:44](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L44) +[src/constant.ts:44](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L44) diff --git a/docs/index/functions/configureProgram.md b/docs/index/functions/configureProgram.md index 90dd1a6..1cec9dd 100644 --- a/docs/index/functions/configureProgram.md +++ b/docs/index/functions/configureProgram.md @@ -18,7 +18,7 @@ occur if no commands are loadable from the given `commandModulePath`. an entry point for a CLI. See [runProgram](runProgram.md) for a wrapper function that handles exceptions and sets the exit code for you. -## Type parameters +## Type Parameters • **CustomContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) @@ -37,6 +37,6 @@ occur if no commands are loadable from the given `commandModulePath`. `Promise`\<[`PreExecutionContext`](../../util/type-aliases/PreExecutionContext.md)\> -## Source +## Defined in -[src/index.ts:59](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/index.ts#L59) +[src/index.ts:59](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/index.ts#L59) diff --git a/docs/index/functions/isCliError.md b/docs/index/functions/isCliError.md index c95a9a7..2956d44 100644 --- a/docs/index/functions/isCliError.md +++ b/docs/index/functions/isCliError.md @@ -18,6 +18,6 @@ Type guard for [CliError](../classes/CliError.md). `parameter is CliError` -## Source +## Defined in -[src/error.ts:25](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L25) +[src/error.ts:25](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L25) diff --git a/docs/index/functions/isGracefulEarlyExitError.md b/docs/index/functions/isGracefulEarlyExitError.md index 6711898..2cc7802 100644 --- a/docs/index/functions/isGracefulEarlyExitError.md +++ b/docs/index/functions/isGracefulEarlyExitError.md @@ -18,6 +18,6 @@ Type guard for [GracefulEarlyExitError](../classes/GracefulEarlyExitError.md). `parameter is GracefulEarlyExitError` -## Source +## Defined in -[src/error.ts:38](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L38) +[src/error.ts:38](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L38) diff --git a/docs/index/functions/runProgram.md b/docs/index/functions/runProgram.md index 3e0bfca..6a94584 100644 --- a/docs/index/functions/runProgram.md +++ b/docs/index/functions/runProgram.md @@ -21,7 +21,7 @@ or reject no matter what.** Instead, when an error is caught, Note: It is always safe to invoke this form of `runProgram` as many times as desired. -### Type parameters +### Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -36,9 +36,9 @@ desired. `NullArguments` if `GracefulEarlyExitError` is thrown, `undefined` if any other error occurs, or `Arguments` otherwise. -### Source +### Defined in -[src/util.ts:172](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L172) +[src/util.ts:172](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L172) ## runProgram(args) @@ -55,7 +55,7 @@ or reject no matter what.** Instead, when an error is caught, Note: It is always safe to invoke this form of `runProgram` as many times as desired. -### Type parameters +### Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -70,9 +70,9 @@ desired. `NullArguments` if `GracefulEarlyExitError` is thrown, `undefined` if any other error occurs, or `Arguments` otherwise. -### Source +### Defined in -[src/util.ts:193](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L193) +[src/util.ts:193](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L193) ## runProgram(args) @@ -90,7 +90,7 @@ or reject no matter what.** Instead, when an error is caught, `process.exitCode` is set to the appropriate value and either `NullArguments` (only if `GracefulEarlyExitError` was thrown) or `undefined` is returned. -### Type parameters +### Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -105,9 +105,9 @@ or reject no matter what.** Instead, when an error is caught, `NullArguments` if `GracefulEarlyExitError` is thrown, `undefined` if any other error occurs, or `Arguments` otherwise. -### Source +### Defined in -[src/util.ts:214](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L214) +[src/util.ts:214](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L214) ## runProgram(args) @@ -125,7 +125,7 @@ or reject no matter what.** Instead, when an error is caught, Note: It is always safe to invoke this form of `runProgram` as many times as desired. -### Type parameters +### Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -140,9 +140,9 @@ desired. `NullArguments` if `GracefulEarlyExitError` is thrown, `undefined` if any other error occurs, or `Arguments` otherwise. -### Source +### Defined in -[src/util.ts:238](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L238) +[src/util.ts:238](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L238) ## runProgram(args) @@ -160,7 +160,7 @@ or reject no matter what.** Instead, when an error is caught, Note: It is always safe to invoke this form of `runProgram` as many times as desired. -### Type parameters +### Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -175,9 +175,9 @@ desired. `NullArguments` if `GracefulEarlyExitError` is thrown, `undefined` if any other error occurs, or `Arguments` otherwise. -### Source +### Defined in -[src/util.ts:260](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L260) +[src/util.ts:260](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L260) ## runProgram(args) @@ -196,7 +196,7 @@ or reject no matter what.** Instead, when an error is caught, `process.exitCode` is set to the appropriate value and either `NullArguments` (only if `GracefulEarlyExitError` was thrown) or `undefined` is returned. -### Type parameters +### Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -211,6 +211,6 @@ or reject no matter what.** Instead, when an error is caught, `NullArguments` if `GracefulEarlyExitError` is thrown, `undefined` if any other error occurs, or `Arguments` otherwise. -### Source +### Defined in -[src/util.ts:286](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L286) +[src/util.ts:286](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L286) diff --git a/docs/index/type-aliases/Arguments.md b/docs/index/type-aliases/Arguments.md index 2d33302..5b88025 100644 --- a/docs/index/type-aliases/Arguments.md +++ b/docs/index/type-aliases/Arguments.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / Arguments -# Type alias: Arguments\ +# Type Alias: Arguments\ > **Arguments**\<`CustomCliArguments`, `CustomExecutionContext`\>: `_Arguments`\<[`FrameworkArguments`](../../util/type-aliases/FrameworkArguments.md)\<`CustomExecutionContext`\> & `CustomCliArguments`\> @@ -12,12 +12,12 @@ Represents the parsed CLI arguments, plus `_` and `$0`, any (hidden) arguments/properties specific to Black Flag, and an indexer falling back to `unknown` for unrecognized arguments. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) -## Source +## Defined in -[types/program.ts:18](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L18) +[types/program.ts:18](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L18) diff --git a/docs/index/type-aliases/ChildConfiguration.md b/docs/index/type-aliases/ChildConfiguration.md index 81297ea..28aec68 100644 --- a/docs/index/type-aliases/ChildConfiguration.md +++ b/docs/index/type-aliases/ChildConfiguration.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ChildConfiguration -# Type alias: ChildConfiguration\ +# Type Alias: ChildConfiguration\ > **ChildConfiguration**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Partial`\<[`Configuration`](Configuration.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\> @@ -12,12 +12,12 @@ A partial extension to the [Configuration](Configuration.md) interface for child configurations. This type was designed for use in external ESM/CJS module files that will eventually get imported via auto-discovery. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) -## Source +## Defined in -[types/module.ts:158](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/module.ts#L158) +[types/module.ts:158](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/module.ts#L158) diff --git a/docs/index/type-aliases/Configuration.md b/docs/index/type-aliases/Configuration.md index bc66008..e971766 100644 --- a/docs/index/type-aliases/Configuration.md +++ b/docs/index/type-aliases/Configuration.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / Configuration -# Type alias: Configuration\ +# Type Alias: Configuration\ > **Configuration**\<`CustomCliArguments`, `CustomExecutionContext`\>: `object` @@ -12,7 +12,7 @@ A replacement for the `CommandModule` type that comes with yargs. Auto-discovered configuration modules must implement this interface or a subtype of this interface. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -169,6 +169,6 @@ order: "Usage: $000\n\n$1" ``` -## Source +## Defined in -[types/module.ts:11](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/module.ts#L11) +[types/module.ts:11](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/module.ts#L11) diff --git a/docs/index/type-aliases/ConfigurationHooks.md b/docs/index/type-aliases/ConfigurationHooks.md index 16068c5..e866c78 100644 --- a/docs/index/type-aliases/ConfigurationHooks.md +++ b/docs/index/type-aliases/ConfigurationHooks.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ConfigurationHooks -# Type alias: ConfigurationHooks +# Type Alias: ConfigurationHooks > **ConfigurationHooks**: `object` @@ -83,6 +83,6 @@ Note that any errors thrown this early in the initialization process will be thrown as-is and will NOT trigger [ConfigureErrorHandlingEpilogue](ConfigureErrorHandlingEpilogue.md). -## Source +## Defined in -[types/configure.ts:96](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/configure.ts#L96) +[types/configure.ts:96](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/configure.ts#L96) diff --git a/docs/index/type-aliases/ConfigureArguments.md b/docs/index/type-aliases/ConfigureArguments.md index ad006a1..4a94421 100644 --- a/docs/index/type-aliases/ConfigureArguments.md +++ b/docs/index/type-aliases/ConfigureArguments.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ConfigureArguments -# Type alias: ConfigureArguments()\ +# Type Alias: ConfigureArguments()\ > **ConfigureArguments**\<`CustomContext`\>: (`rawArgv`, `context`) => `Promisable`\<*typeof* `process.argv`\> @@ -14,7 +14,7 @@ This function is called once towards the beginning of the execution of This is where yargs middleware and other argument pre-processing can be implemented. -## Type parameters +## Type Parameters • **CustomContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) @@ -28,6 +28,6 @@ implemented. `Promisable`\<*typeof* `process.argv`\> -## Source +## Defined in -[types/configure.ts:48](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/configure.ts#L48) +[types/configure.ts:48](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/configure.ts#L48) diff --git a/docs/index/type-aliases/ConfigureErrorHandlingEpilogue.md b/docs/index/type-aliases/ConfigureErrorHandlingEpilogue.md index 1d41285..45e4eea 100644 --- a/docs/index/type-aliases/ConfigureErrorHandlingEpilogue.md +++ b/docs/index/type-aliases/ConfigureErrorHandlingEpilogue.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ConfigureErrorHandlingEpilogue -# Type alias: ConfigureErrorHandlingEpilogue()\ +# Type Alias: ConfigureErrorHandlingEpilogue()\ > **ConfigureErrorHandlingEpilogue**\<`CustomContext`\>: (`meta`, `argv`, `context`) => `Promisable`\<`void`\> @@ -20,7 +20,7 @@ exceptions to this are if (1) the error occurs within This function is also called even after yargs internally handles and reports an argument parsing/validation error. -## Type parameters +## Type Parameters • **CustomContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) @@ -42,6 +42,6 @@ an argument parsing/validation error. `Promisable`\<`void`\> -## Source +## Defined in -[types/configure.ts:81](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/configure.ts#L81) +[types/configure.ts:81](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/configure.ts#L81) diff --git a/docs/index/type-aliases/ConfigureExecutionContext.md b/docs/index/type-aliases/ConfigureExecutionContext.md index 03fb707..e088edd 100644 --- a/docs/index/type-aliases/ConfigureExecutionContext.md +++ b/docs/index/type-aliases/ConfigureExecutionContext.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ConfigureExecutionContext -# Type alias: ConfigureExecutionContext()\ +# Type Alias: ConfigureExecutionContext()\ > **ConfigureExecutionContext**\<`CustomContext`\>: (`context`) => `Promisable`\<`CustomContext`\> @@ -15,7 +15,7 @@ This function is called once towards the beginning of the execution of Note that any errors thrown this early in the initialization process will be thrown as-is and will NOT trigger [ConfigureErrorHandlingEpilogue](ConfigureErrorHandlingEpilogue.md). -## Type parameters +## Type Parameters • **CustomContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) @@ -27,6 +27,6 @@ thrown as-is and will NOT trigger [ConfigureErrorHandlingEpilogue](ConfigureErro `Promisable`\<`CustomContext`\> -## Source +## Defined in -[types/configure.ts:17](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/configure.ts#L17) +[types/configure.ts:17](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/configure.ts#L17) diff --git a/docs/index/type-aliases/ConfigureExecutionEpilogue.md b/docs/index/type-aliases/ConfigureExecutionEpilogue.md index 18c75e6..3ab4629 100644 --- a/docs/index/type-aliases/ConfigureExecutionEpilogue.md +++ b/docs/index/type-aliases/ConfigureExecutionEpilogue.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ConfigureExecutionEpilogue -# Type alias: ConfigureExecutionEpilogue()\ +# Type Alias: ConfigureExecutionEpilogue()\ > **ConfigureExecutionEpilogue**\<`CustomContext`\>: (`argv`, `context`) => `Promisable`\<[`Arguments`](Arguments.md)\> @@ -16,7 +16,7 @@ when yargs argument validation fails. This function is the complement of [ConfigureExecutionPrologue](ConfigureExecutionPrologue.md). -## Type parameters +## Type Parameters • **CustomContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) @@ -30,6 +30,6 @@ This function is the complement of [ConfigureExecutionPrologue](ConfigureExecuti `Promisable`\<[`Arguments`](Arguments.md)\> -## Source +## Defined in -[types/configure.ts:64](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/configure.ts#L64) +[types/configure.ts:64](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/configure.ts#L64) diff --git a/docs/index/type-aliases/ConfigureExecutionPrologue.md b/docs/index/type-aliases/ConfigureExecutionPrologue.md index 81063a2..a16e082 100644 --- a/docs/index/type-aliases/ConfigureExecutionPrologue.md +++ b/docs/index/type-aliases/ConfigureExecutionPrologue.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ConfigureExecutionPrologue -# Type alias: ConfigureExecutionPrologue()\ +# Type Alias: ConfigureExecutionPrologue()\ > **ConfigureExecutionPrologue**\<`CustomContext`\>: (`rootPrograms`, `context`) => `Promisable`\<`void`\> @@ -23,7 +23,7 @@ This function is the complement of [ConfigureExecutionEpilogue](ConfigureExecuti Note that any errors thrown this early in the initialization process will be thrown as-is and will NOT trigger [ConfigureErrorHandlingEpilogue](ConfigureErrorHandlingEpilogue.md). -## Type parameters +## Type Parameters • **CustomContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) @@ -37,6 +37,6 @@ thrown as-is and will NOT trigger [ConfigureErrorHandlingEpilogue](ConfigureErro `Promisable`\<`void`\> -## Source +## Defined in -[types/configure.ts:37](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/configure.ts#L37) +[types/configure.ts:37](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/configure.ts#L37) diff --git a/docs/index/type-aliases/ImportedConfigurationModule.md b/docs/index/type-aliases/ImportedConfigurationModule.md index c8394e8..be475a6 100644 --- a/docs/index/type-aliases/ImportedConfigurationModule.md +++ b/docs/index/type-aliases/ImportedConfigurationModule.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ImportedConfigurationModule -# Type alias: ImportedConfigurationModule\ +# Type Alias: ImportedConfigurationModule\ > **ImportedConfigurationModule**\<`CustomCliArguments`, `CustomExecutionContext`\>: (`context`) => `Promisable`\<`Partial`\<[`RootConfiguration`](RootConfiguration.md)\<`CustomCliArguments`, `CustomExecutionContext`\> \| [`ParentConfiguration`](ParentConfiguration.md)\<`CustomCliArguments`, `CustomExecutionContext`\> \| [`ChildConfiguration`](ChildConfiguration.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\>\> \| `Partial`\<[`RootConfiguration`](RootConfiguration.md)\<`CustomCliArguments`, `CustomExecutionContext`\> \| [`ParentConfiguration`](ParentConfiguration.md)\<`CustomCliArguments`, `CustomExecutionContext`\> \| [`ChildConfiguration`](ChildConfiguration.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\> & `object` @@ -18,12 +18,12 @@ file). > `optional` **default**: [`ImportedConfigurationModule`](ImportedConfigurationModule.md)\<`CustomCliArguments`, `CustomExecutionContext`\> -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) -## Source +## Defined in -[types/module.ts:168](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/module.ts#L168) +[types/module.ts:168](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/module.ts#L168) diff --git a/docs/index/type-aliases/NullArguments.md b/docs/index/type-aliases/NullArguments.md index fc167cf..f5581ca 100644 --- a/docs/index/type-aliases/NullArguments.md +++ b/docs/index/type-aliases/NullArguments.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / NullArguments -# Type alias: NullArguments\ +# Type Alias: NullArguments\ > **NullArguments**\<`CustomExecutionContext`\>: `object` & [`FrameworkArguments`](../../util/type-aliases/FrameworkArguments.md)\<`CustomExecutionContext`\> @@ -24,10 +24,10 @@ yargs from returning a real `Arguments` parse result. > **\_**: [] -## Type parameters +## Type Parameters • **CustomExecutionContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) -## Source +## Defined in -[types/program.ts:30](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L30) +[types/program.ts:30](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L30) diff --git a/docs/index/type-aliases/ParentConfiguration.md b/docs/index/type-aliases/ParentConfiguration.md index 55b2264..5b5121e 100644 --- a/docs/index/type-aliases/ParentConfiguration.md +++ b/docs/index/type-aliases/ParentConfiguration.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / ParentConfiguration -# Type alias: ParentConfiguration\ +# Type Alias: ParentConfiguration\ > **ParentConfiguration**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Partial`\<[`Configuration`](Configuration.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\> @@ -12,12 +12,12 @@ A partial extension to the [Configuration](Configuration.md) interface for non-r parent configurations. This type was designed for use in external ESM/CJS module files that will eventually get imported via auto-discovery. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) -## Source +## Defined in -[types/module.ts:148](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/module.ts#L148) +[types/module.ts:148](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/module.ts#L148) diff --git a/docs/index/type-aliases/RootConfiguration.md b/docs/index/type-aliases/RootConfiguration.md index 5d38435..9858afa 100644 --- a/docs/index/type-aliases/RootConfiguration.md +++ b/docs/index/type-aliases/RootConfiguration.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [index](../README.md) / RootConfiguration -# Type alias: RootConfiguration\ +# Type Alias: RootConfiguration\ > **RootConfiguration**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Partial`\<[`ParentConfiguration`](ParentConfiguration.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\> @@ -12,12 +12,12 @@ A partial extension to the [Configuration](Configuration.md) interface for root configurations. This type was designed for use in external ESM/CJS module files that will eventually get imported via auto-discovery. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) = [`ExecutionContext`](../../util/type-aliases/ExecutionContext.md) -## Source +## Defined in -[types/module.ts:138](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/module.ts#L138) +[types/module.ts:138](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/module.ts#L138) diff --git a/docs/index/variables/$executionContext.md b/docs/index/variables/$executionContext.md index d45c5e0..2bc77b4 100644 --- a/docs/index/variables/$executionContext.md +++ b/docs/index/variables/$executionContext.md @@ -11,6 +11,6 @@ A symbol allowing access to the `ExecutionContext` object "hidden" within each `Arguments` instance. -## Source +## Defined in -[src/constant.ts:5](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L5) +[src/constant.ts:5](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L5) diff --git a/docs/util/classes/AssertionFailedError.md b/docs/util/classes/AssertionFailedError.md index d956f8e..6c0503d 100644 --- a/docs/util/classes/AssertionFailedError.md +++ b/docs/util/classes/AssertionFailedError.md @@ -32,9 +32,9 @@ Represents a failed sanity check. [`CliError`](../../index/classes/CliError.md).[`constructor`](../../index/classes/CliError.md#constructors) -#### Source +#### Defined in -[src/error.ts:188](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L188) +[src/error.ts:188](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L188) ## Properties @@ -46,9 +46,9 @@ Represents a failed sanity check. [`CliError`](../../index/classes/CliError.md).[`[$type]`](../../index/classes/CliError.md#%5B$type%5D) -#### Source +#### Defined in -[src/error.ts:184](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L184) +[src/error.ts:184](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L184) *** @@ -60,7 +60,7 @@ Represents a failed sanity check. [`CliError`](../../index/classes/CliError.md).[`cause`](../../index/classes/CliError.md#cause) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es2022.error.d.ts:24 @@ -74,7 +74,7 @@ node\_modules/typescript/lib/lib.es2022.error.d.ts:24 [`CliError`](../../index/classes/CliError.md).[`message`](../../index/classes/CliError.md#message) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1077 @@ -88,7 +88,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1077 [`CliError`](../../index/classes/CliError.md).[`name`](../../index/classes/CliError.md#name) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1076 @@ -98,13 +98,23 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 > **showHelp**: `boolean` = `false` +If `true`, help text will be sent to stderr _before this exception finishes +bubbling_. Where the exception is thrown will determine which instance is +responsible for error text generation. + +#### Default + +```ts +false +``` + #### Inherited from [`CliError`](../../index/classes/CliError.md).[`showHelp`](../../index/classes/CliError.md#showhelp) -#### Source +#### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L94) *** @@ -116,7 +126,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 [`CliError`](../../index/classes/CliError.md).[`stack`](../../index/classes/CliError.md#stack) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1078 @@ -126,13 +136,22 @@ node\_modules/typescript/lib/lib.es5.d.ts:1078 > **suggestedExitCode**: [`FrameworkExitCode`](../../index/enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError` +The exit code that will be returned when the application exits, given +nothing else goes wrong in the interim. + +#### Default + +```ts +FrameworkExitCode.DefaultError +``` + #### Inherited from [`CliError`](../../index/classes/CliError.md).[`suggestedExitCode`](../../index/classes/CliError.md#suggestedexitcode) -#### Source +#### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L93) *** @@ -160,7 +179,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces [`CliError`](../../index/classes/CliError.md).[`prepareStackTrace`](../../index/classes/CliError.md#preparestacktrace) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:28 @@ -174,7 +193,7 @@ node\_modules/@types/node/globals.d.ts:28 [`CliError`](../../index/classes/CliError.md).[`stackTraceLimit`](../../index/classes/CliError.md#stacktracelimit) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:30 @@ -200,6 +219,6 @@ Create .stack property on a target object [`CliError`](../../index/classes/CliError.md).[`captureStackTrace`](../../index/classes/CliError.md#capturestacktrace) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:21 diff --git a/docs/util/classes/CommandNotImplementedError.md b/docs/util/classes/CommandNotImplementedError.md index 106834f..cc7c920 100644 --- a/docs/util/classes/CommandNotImplementedError.md +++ b/docs/util/classes/CommandNotImplementedError.md @@ -29,9 +29,9 @@ implemented. [`CliError`](../../index/classes/CliError.md).[`constructor`](../../index/classes/CliError.md#constructors) -#### Source +#### Defined in -[src/error.ts:150](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L150) +[src/error.ts:150](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L150) ## Properties @@ -43,9 +43,9 @@ implemented. [`CliError`](../../index/classes/CliError.md).[`[$type]`](../../index/classes/CliError.md#%5B$type%5D) -#### Source +#### Defined in -[src/error.ts:145](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L145) +[src/error.ts:145](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L145) *** @@ -57,7 +57,7 @@ implemented. [`CliError`](../../index/classes/CliError.md).[`cause`](../../index/classes/CliError.md#cause) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es2022.error.d.ts:24 @@ -71,7 +71,7 @@ node\_modules/typescript/lib/lib.es2022.error.d.ts:24 [`CliError`](../../index/classes/CliError.md).[`message`](../../index/classes/CliError.md#message) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1077 @@ -85,7 +85,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1077 [`CliError`](../../index/classes/CliError.md).[`name`](../../index/classes/CliError.md#name) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1076 @@ -95,13 +95,23 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 > **showHelp**: `boolean` = `false` +If `true`, help text will be sent to stderr _before this exception finishes +bubbling_. Where the exception is thrown will determine which instance is +responsible for error text generation. + +#### Default + +```ts +false +``` + #### Inherited from [`CliError`](../../index/classes/CliError.md).[`showHelp`](../../index/classes/CliError.md#showhelp) -#### Source +#### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L94) *** @@ -113,7 +123,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076 [`CliError`](../../index/classes/CliError.md).[`stack`](../../index/classes/CliError.md#stack) -#### Source +#### Defined in node\_modules/typescript/lib/lib.es5.d.ts:1078 @@ -123,13 +133,22 @@ node\_modules/typescript/lib/lib.es5.d.ts:1078 > **suggestedExitCode**: [`FrameworkExitCode`](../../index/enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError` +The exit code that will be returned when the application exits, given +nothing else goes wrong in the interim. + +#### Default + +```ts +FrameworkExitCode.DefaultError +``` + #### Inherited from [`CliError`](../../index/classes/CliError.md).[`suggestedExitCode`](../../index/classes/CliError.md#suggestedexitcode) -#### Source +#### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L93) *** @@ -157,7 +176,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces [`CliError`](../../index/classes/CliError.md).[`prepareStackTrace`](../../index/classes/CliError.md#preparestacktrace) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:28 @@ -171,7 +190,7 @@ node\_modules/@types/node/globals.d.ts:28 [`CliError`](../../index/classes/CliError.md).[`stackTraceLimit`](../../index/classes/CliError.md#stacktracelimit) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:30 @@ -197,6 +216,6 @@ Create .stack property on a target object [`CliError`](../../index/classes/CliError.md).[`captureStackTrace`](../../index/classes/CliError.md#capturestacktrace) -#### Source +#### Defined in node\_modules/@types/node/globals.d.ts:21 diff --git a/docs/util/functions/hideBin.md b/docs/util/functions/hideBin.md index 3b42c4e..1f9b349 100644 --- a/docs/util/functions/hideBin.md +++ b/docs/util/functions/hideBin.md @@ -16,10 +16,6 @@ `string`[] -## See +## Defined in -https://yargs.js.org/docs/#api-reference - -## Source - -[src/exports/util.ts:48](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/exports/util.ts#L48) +[src/exports/util.ts:48](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/exports/util.ts#L48) diff --git a/docs/util/functions/isArguments.md b/docs/util/functions/isArguments.md index bc9f9e2..a03cf9e 100644 --- a/docs/util/functions/isArguments.md +++ b/docs/util/functions/isArguments.md @@ -18,6 +18,6 @@ Type-guard for [Arguments](../../index/type-aliases/Arguments.md). `obj is Arguments` -## Source +## Defined in -[src/util.ts:458](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L458) +[src/util.ts:458](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L458) diff --git a/docs/util/functions/isAssertionSystemError.md b/docs/util/functions/isAssertionSystemError.md index fd7cff2..129cdf2 100644 --- a/docs/util/functions/isAssertionSystemError.md +++ b/docs/util/functions/isAssertionSystemError.md @@ -18,6 +18,6 @@ Type-guard for Node's "ERR_ASSERTION" so-called `SystemError`. `error is ErrnoException & Object` -## Source +## Defined in -[src/util.ts:472](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L472) +[src/util.ts:472](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L472) diff --git a/docs/util/functions/isCommandNotImplementedError.md b/docs/util/functions/isCommandNotImplementedError.md index f5d20d2..9742834 100644 --- a/docs/util/functions/isCommandNotImplementedError.md +++ b/docs/util/functions/isCommandNotImplementedError.md @@ -18,6 +18,6 @@ Type guard for [CommandNotImplementedError](../classes/CommandNotImplementedErro `parameter is CommandNotImplementedError` -## Source +## Defined in -[src/error.ts:53](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L53) +[src/error.ts:53](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L53) diff --git a/docs/util/functions/isNullArguments.md b/docs/util/functions/isNullArguments.md index 89809cf..60ecc2e 100644 --- a/docs/util/functions/isNullArguments.md +++ b/docs/util/functions/isNullArguments.md @@ -18,6 +18,6 @@ Type-guard for [NullArguments](../../index/type-aliases/NullArguments.md). `obj is NullArguments` -## Source +## Defined in -[src/util.ts:447](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L447) +[src/util.ts:447](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L447) diff --git a/docs/util/functions/isPreExecutionContext.md b/docs/util/functions/isPreExecutionContext.md index 5088a10..9f407a2 100644 --- a/docs/util/functions/isPreExecutionContext.md +++ b/docs/util/functions/isPreExecutionContext.md @@ -18,6 +18,6 @@ Type-guard for [PreExecutionContext](../type-aliases/PreExecutionContext.md). `obj is PreExecutionContext` -## Source +## Defined in -[src/util.ts:434](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L434) +[src/util.ts:434](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L434) diff --git a/docs/util/functions/makeRunner.md b/docs/util/functions/makeRunner.md index 6d181ad..d45820e 100644 --- a/docs/util/functions/makeRunner.md +++ b/docs/util/functions/makeRunner.md @@ -23,7 +23,7 @@ function will never reject and no exception will ever be thrown.** Keep this in mind when writing your unit tests and see [runProgram](../../index/functions/runProgram.md) for more details. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> @@ -35,7 +35,7 @@ details. `Function` -### Type parameters +### Type Parameters • **T** *extends* [`string`] \| [`string`, `Promisable`\<[`ConfigurationHooks`](../../index/type-aliases/ConfigurationHooks.md)\>] \| [`string`, `Promisable`\<[`PreExecutionContext`](../type-aliases/PreExecutionContext.md)\>] \| [`string`, `string` \| `string`[]] \| [`string`, `string` \| `string`[], `Promisable`\<[`ConfigurationHooks`](../../index/type-aliases/ConfigurationHooks.md)\>] \| [`string`, `string` \| `string`[], `Promisable`\<[`PreExecutionContext`](../type-aliases/PreExecutionContext.md)\>] @@ -47,6 +47,6 @@ details. `Promise`\<[`NullArguments`](../../index/type-aliases/NullArguments.md) \| [`Arguments`](../../index/type-aliases/Arguments.md)\<`CustomCliArguments`\>\> -## Source +## Defined in -[src/util.ts:50](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/util.ts#L50) +[src/util.ts:50](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/util.ts#L50) diff --git a/docs/util/type-aliases/CliErrorOptions.md b/docs/util/type-aliases/CliErrorOptions.md index bc3b730..a845dcb 100644 --- a/docs/util/type-aliases/CliErrorOptions.md +++ b/docs/util/type-aliases/CliErrorOptions.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [util](../README.md) / CliErrorOptions -# Type alias: CliErrorOptions +# Type Alias: CliErrorOptions > **CliErrorOptions**: `object` @@ -39,6 +39,6 @@ nothing else goes wrong in the interim. FrameworkExitCode.DefaultError ``` -## Source +## Defined in -[src/error.ts:67](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L67) +[src/error.ts:67](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L67) diff --git a/docs/util/type-aliases/DescriptorToProgram.md b/docs/util/type-aliases/DescriptorToProgram.md index 92dd64c..de7227a 100644 --- a/docs/util/type-aliases/DescriptorToProgram.md +++ b/docs/util/type-aliases/DescriptorToProgram.md @@ -4,13 +4,13 @@ [@black-flag/core](../../README.md) / [util](../README.md) / DescriptorToProgram -# Type alias: DescriptorToProgram\ +# Type Alias: DescriptorToProgram\ > **DescriptorToProgram**\<`Descriptor`, `CustomCliArguments`, `CustomExecutionContext`\>: `"effector"` *extends* `Descriptor` ? [`EffectorProgram`](EffectorProgram.md)\<`CustomCliArguments`, `CustomExecutionContext`\> : `"helper"` *extends* `Descriptor` ? [`HelperProgram`](HelperProgram.md)\<`CustomCliArguments`, `CustomExecutionContext`\> : [`RouterProgram`](RouterProgram.md)\<`CustomCliArguments`, `CustomExecutionContext`\> Accepts a `Descriptor` type and maps it to one of the `XProgram` types. -## Type parameters +## Type Parameters • **Descriptor** *extends* [`ProgramDescriptor`](ProgramDescriptor.md) @@ -18,6 +18,6 @@ Accepts a `Descriptor` type and maps it to one of the `XProgram` types. • **CustomExecutionContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) -## Source +## Defined in -[types/program.ts:159](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L159) +[types/program.ts:159](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L159) diff --git a/docs/util/type-aliases/EffectorProgram.md b/docs/util/type-aliases/EffectorProgram.md index c5a37a0..c0fc5a9 100644 --- a/docs/util/type-aliases/EffectorProgram.md +++ b/docs/util/type-aliases/EffectorProgram.md @@ -4,18 +4,18 @@ [@black-flag/core](../../README.md) / [util](../README.md) / EffectorProgram -# Type alias: EffectorProgram\ +# Type Alias: EffectorProgram\ > **EffectorProgram**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Omit`\<[`Program`](Program.md)\<`CustomCliArguments`, `CustomExecutionContext`\>, `"command_deferred"` \| `"command_finalize_deferred"`\> Represents an "effector" [Program](Program.md) instance. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) -## Source +## Defined in -[types/program.ts:119](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L119) +[types/program.ts:119](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L119) diff --git a/docs/util/type-aliases/ExecutionContext.md b/docs/util/type-aliases/ExecutionContext.md index 909bbb6..36061d4 100644 --- a/docs/util/type-aliases/ExecutionContext.md +++ b/docs/util/type-aliases/ExecutionContext.md @@ -4,13 +4,13 @@ [@black-flag/core](../../README.md) / [util](../README.md) / ExecutionContext -# Type alias: ExecutionContext +# Type Alias: ExecutionContext > **ExecutionContext**: `object` Represents a globally-accessible shared context object singleton. -## Index signature +## Index Signature \[`key`: `string`\]: `unknown` @@ -39,7 +39,7 @@ The ExtendedDebugger for the current runtime level. The current state of the execution environment. -#### Index signature +#### Index Signature \[`key`: `string`\]: `unknown` @@ -270,6 +270,6 @@ This is also set when `Program::showHelpOnFail` is called. true ``` -## Source +## Defined in -[types/program.ts:328](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L328) +[types/program.ts:328](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L328) diff --git a/docs/util/type-aliases/Executor.md b/docs/util/type-aliases/Executor.md index cbafa09..a674031 100644 --- a/docs/util/type-aliases/Executor.md +++ b/docs/util/type-aliases/Executor.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [util](../README.md) / Executor -# Type alias: Executor() +# Type Alias: Executor() > **Executor**: (`rawArgv`?) => `Promise`\<[`Arguments`](../../index/type-aliases/Arguments.md)\> @@ -32,6 +32,6 @@ instead. `Promise`\<[`Arguments`](../../index/type-aliases/Arguments.md)\> -## Source +## Defined in -[types/program.ts:280](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L280) +[types/program.ts:280](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L280) diff --git a/docs/util/type-aliases/FrameworkArguments.md b/docs/util/type-aliases/FrameworkArguments.md index c8ff590..f391999 100644 --- a/docs/util/type-aliases/FrameworkArguments.md +++ b/docs/util/type-aliases/FrameworkArguments.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [util](../README.md) / FrameworkArguments -# Type alias: FrameworkArguments\ +# Type Alias: FrameworkArguments\ > **FrameworkArguments**\<`CustomExecutionContext`\>: `object` @@ -16,7 +16,7 @@ Instead of using this type directly, your project's custom arguments (e.g. (e.g. `Arguments`), which will extend `FrameworkArguments` for you. -## Type parameters +## Type Parameters • **CustomExecutionContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) @@ -26,6 +26,6 @@ you. > **\[$executionContext\]**: `CustomExecutionContext` -## Source +## Defined in -[types/program.ts:257](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L257) +[types/program.ts:257](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L257) diff --git a/docs/util/type-aliases/HelperProgram.md b/docs/util/type-aliases/HelperProgram.md index ec24d56..1d7b62d 100644 --- a/docs/util/type-aliases/HelperProgram.md +++ b/docs/util/type-aliases/HelperProgram.md @@ -4,18 +4,18 @@ [@black-flag/core](../../README.md) / [util](../README.md) / HelperProgram -# Type alias: HelperProgram\ +# Type Alias: HelperProgram\ > **HelperProgram**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Omit`\<[`Program`](Program.md)\<`CustomCliArguments`, `CustomExecutionContext`\>, `"demand"` \| `"demandCommand"` \| `"command"`\> Represents an "helper" [Program](Program.md) instance. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) -## Source +## Defined in -[types/program.ts:130](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L130) +[types/program.ts:130](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L130) diff --git a/docs/util/type-aliases/PreExecutionContext.md b/docs/util/type-aliases/PreExecutionContext.md index 166fc05..231f8fd 100644 --- a/docs/util/type-aliases/PreExecutionContext.md +++ b/docs/util/type-aliases/PreExecutionContext.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [util](../README.md) / PreExecutionContext -# Type alias: PreExecutionContext\ +# Type Alias: PreExecutionContext\ > **PreExecutionContext**\<`CustomContext`\>: `CustomContext` & `object` @@ -48,10 +48,10 @@ recursively contains some of the same entries as its enclosing An object containing the effector, helper, and router [Program](Program.md) instances belonging to the root command. -## Type parameters +## Type Parameters • **CustomContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) -## Source +## Defined in -[types/program.ts:291](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L291) +[types/program.ts:291](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L291) diff --git a/docs/util/type-aliases/Program.md b/docs/util/type-aliases/Program.md index 6ea0624..39d0d0c 100644 --- a/docs/util/type-aliases/Program.md +++ b/docs/util/type-aliases/Program.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [util](../README.md) / Program -# Type alias: Program\ +# Type Alias: Program\ > **Program**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Omit`\<`_Program`\<[`FrameworkArguments`](FrameworkArguments.md)\<`CustomExecutionContext`\> & `CustomCliArguments`\>, `"command"` \| `"onFinishCommand"` \| `"showHelpOnFail"` \| `"version"` \| `"help"` \| `"exitProcess"` \| `"commandDir"` \| `"parse"` \| `"parsed"` \| `"parseSync"` \| `"argv"`\> & `object` @@ -18,10 +18,10 @@ by yargs but with several differences and should be preferred. ### command() -`Internal` - > **command**: (`command`, `description`, `builder`, `handler`, `middlewares`, `deprecated`) => [`Program`](Program.md)\<`CustomCliArguments`, `CustomExecutionContext`\> +**`Internal`** + #### See _Program.command @@ -46,10 +46,10 @@ _Program.command ### command\_deferred -`Internal` - > **command\_deferred**: [`Program`](Program.md)\<`CustomCliArguments`, `CustomExecutionContext`\>\[`"command"`\] +**`Internal`** + Identical to `yargs::command` except its execution is enqueued and deferred until Program.command_finalize_deferred is called. @@ -59,10 +59,10 @@ _Program.command ### command\_finalize\_deferred() -`Internal` - > **command\_finalize\_deferred**: () => `void` +**`Internal`** + #### See Program.command_deferred @@ -95,12 +95,12 @@ _Program.showHelpOnFail [`Program`](Program.md)\<`CustomCliArguments`, `CustomExecutionContext`\> -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) -## Source +## Defined in -[types/program.ts:44](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L44) +[types/program.ts:44](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L44) diff --git a/docs/util/type-aliases/ProgramDescriptor.md b/docs/util/type-aliases/ProgramDescriptor.md index ed2c58e..acf3023 100644 --- a/docs/util/type-aliases/ProgramDescriptor.md +++ b/docs/util/type-aliases/ProgramDescriptor.md @@ -4,12 +4,12 @@ [@black-flag/core](../../README.md) / [util](../README.md) / ProgramDescriptor -# Type alias: ProgramDescriptor +# Type Alias: ProgramDescriptor > **ProgramDescriptor**: `"effector"` \| `"helper"` \| `"router"` Represents the three program types that comprise any Black Flag command. -## Source +## Defined in -[types/program.ts:154](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L154) +[types/program.ts:154](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L154) diff --git a/docs/util/type-aliases/ProgramMetadata.md b/docs/util/type-aliases/ProgramMetadata.md index e10f96f..ecd0aec 100644 --- a/docs/util/type-aliases/ProgramMetadata.md +++ b/docs/util/type-aliases/ProgramMetadata.md @@ -4,7 +4,7 @@ [@black-flag/core](../../README.md) / [util](../README.md) / ProgramMetadata -# Type alias: ProgramMetadata +# Type Alias: ProgramMetadata > **ProgramMetadata**: `object` @@ -86,6 +86,6 @@ Note that "root" `type` configurations are unique in that there will only ever be one `RootConfiguration`, and it **MUST** be the first command module auto-discovered and loaded (invariant). -## Source +## Defined in -[types/program.ts:188](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L188) +[types/program.ts:188](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L188) diff --git a/docs/util/type-aliases/ProgramType.md b/docs/util/type-aliases/ProgramType.md index 074df1a..35b85f2 100644 --- a/docs/util/type-aliases/ProgramType.md +++ b/docs/util/type-aliases/ProgramType.md @@ -4,12 +4,12 @@ [@black-flag/core](../../README.md) / [util](../README.md) / ProgramType -# Type alias: ProgramType +# Type Alias: ProgramType > **ProgramType**: `"pure parent"` \| `"parent-child"` \| `"pure child"` Represents valid [Configuration](../../index/type-aliases/Configuration.md) module types that can be loaded. -## Source +## Defined in -[types/program.ts:149](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L149) +[types/program.ts:149](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L149) diff --git a/docs/util/type-aliases/Programs.md b/docs/util/type-aliases/Programs.md index 85645e2..94e5f8c 100644 --- a/docs/util/type-aliases/Programs.md +++ b/docs/util/type-aliases/Programs.md @@ -4,19 +4,19 @@ [@black-flag/core](../../README.md) / [util](../README.md) / Programs -# Type alias: Programs\ +# Type Alias: Programs\ > **Programs**\<`CustomCliArguments`, `CustomExecutionContext`\>: `{ [Descriptor in ProgramDescriptor]: DescriptorToProgram }` Represents the program types that represent every Black Flag command as aptly-named values in an object. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) -## Source +## Defined in -[types/program.ts:173](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L173) +[types/program.ts:173](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L173) diff --git a/docs/util/type-aliases/RouterProgram.md b/docs/util/type-aliases/RouterProgram.md index 7483748..bf4e172 100644 --- a/docs/util/type-aliases/RouterProgram.md +++ b/docs/util/type-aliases/RouterProgram.md @@ -4,18 +4,18 @@ [@black-flag/core](../../README.md) / [util](../README.md) / RouterProgram -# Type alias: RouterProgram\ +# Type Alias: RouterProgram\ > **RouterProgram**\<`CustomCliArguments`, `CustomExecutionContext`\>: `Pick`\<[`Program`](Program.md)\<`CustomCliArguments`, `CustomExecutionContext`\>, `"parseAsync"` \| `"command"`\> Represents an "router" [Program](Program.md) instance. -## Type parameters +## Type Parameters • **CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> • **CustomExecutionContext** *extends* [`ExecutionContext`](ExecutionContext.md) = [`ExecutionContext`](ExecutionContext.md) -## Source +## Defined in -[types/program.ts:141](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/types/program.ts#L141) +[types/program.ts:141](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/types/program.ts#L141) diff --git a/docs/util/variables/ErrorMessage.md b/docs/util/variables/ErrorMessage.md index df57882..d3bf3dd 100644 --- a/docs/util/variables/ErrorMessage.md +++ b/docs/util/variables/ErrorMessage.md @@ -354,6 +354,6 @@ A collection of possible error and warning messages emitted by Black Flag. `string` -## Source +## Defined in -[src/error.ts:200](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L200) +[src/error.ts:200](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L200) diff --git a/docs/util/variables/defaultHelpOptionName.md b/docs/util/variables/defaultHelpOptionName.md index 7fc1298..a794a8e 100644 --- a/docs/util/variables/defaultHelpOptionName.md +++ b/docs/util/variables/defaultHelpOptionName.md @@ -11,6 +11,6 @@ Hard-coded default option name for dumping help text to stdout. For example: `--${defaultHelpOptionName}`. -## Source +## Defined in -[src/constant.ts:19](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L19) +[src/constant.ts:19](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L19) diff --git a/docs/util/variables/defaultHelpTextDescription.md b/docs/util/variables/defaultHelpTextDescription.md index 45e3038..336afcc 100644 --- a/docs/util/variables/defaultHelpTextDescription.md +++ b/docs/util/variables/defaultHelpTextDescription.md @@ -10,6 +10,6 @@ Hard-coded default help option description text. -## Source +## Defined in -[src/constant.ts:24](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L24) +[src/constant.ts:24](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L24) diff --git a/docs/util/variables/defaultUsageText.md b/docs/util/variables/defaultUsageText.md index 4cfb7b0..617cedb 100644 --- a/docs/util/variables/defaultUsageText.md +++ b/docs/util/variables/defaultUsageText.md @@ -13,6 +13,6 @@ Hard-coded default command `usage` text provided to programs via with a command's usage DSL (`command` export), name (`name` export), and description (`description` export) respectively. -## Source +## Defined in -[src/constant.ts:13](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L13) +[src/constant.ts:13](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L13) diff --git a/docs/util/variables/defaultVersionOptionName.md b/docs/util/variables/defaultVersionOptionName.md index 643f868..8258bbd 100644 --- a/docs/util/variables/defaultVersionOptionName.md +++ b/docs/util/variables/defaultVersionOptionName.md @@ -11,6 +11,6 @@ Hard-coded default option name for dumping version text to stdout. For example: `--${defaultVersionOptionName}`. -## Source +## Defined in -[src/constant.ts:30](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L30) +[src/constant.ts:30](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L30) diff --git a/docs/util/variables/defaultVersionTextDescription.md b/docs/util/variables/defaultVersionTextDescription.md index 08591b6..1e3d803 100644 --- a/docs/util/variables/defaultVersionTextDescription.md +++ b/docs/util/variables/defaultVersionTextDescription.md @@ -10,6 +10,6 @@ Hard-coded default version option description text. -## Source +## Defined in -[src/constant.ts:35](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/constant.ts#L35) +[src/constant.ts:35](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/constant.ts#L35) diff --git a/package-lock.json b/package-lock.json index edbd676..6af6482 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@black-flag/core", - "version": "1.2.6", + "version": "1.2.7", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@black-flag/core", - "version": "1.2.6", + "version": "1.2.7", "license": "MIT", "dependencies": { "@types/debug": "^4.1.12", diff --git a/package.json b/package.json index 363ac3c..2ebae01 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@black-flag/core", - "version": "1.2.6", + "version": "1.2.7", "description": "A declarative framework for building fluent, deeply hierarchical command line interfaces with yargs", "keywords": [ "cli",