From 6fa1e92c8a94ca61fe4f78ed4709a571b48a6473 Mon Sep 17 00:00:00 2001 From: "Xunnamius (Romulus)" Date: Tue, 19 Mar 2024 02:10:19 -0700 Subject: [PATCH] release: 1.2.1 [skip ci] MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### [1.2.1](https://github.com/Xunnamius/black-flag/compare/v1.2.0...v1.2.1) (2024-03-19) #### ⚙️ Build system * **babel:** fix import specifier rewrite oversight ([2369534](https://github.com/Xunnamius/black-flag/commit/2369534f63aa3858714bb81505d3fff4ed77c6b1)) --- CHANGELOG.md | 106 ++++++++++-------- docs/classes/index.CliError.md | 10 +- docs/classes/index.GracefulEarlyExitError.md | 8 +- docs/classes/util.AssertionFailedError.md | 8 +- .../util.CommandNotImplementedError.md | 8 +- docs/enums/index.FrameworkExitCode.md | 8 +- docs/modules/index.md | 46 ++++---- docs/modules/util.md | 54 ++++----- package-lock.json | 4 +- package.json | 2 +- 10 files changed, 131 insertions(+), 123 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 33fa3d7..c49a1b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,94 +4,102 @@ 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.0][3] (2024-03-18) +### [1.2.1][3] (2024-03-19) + +#### ⚙️ Build System + +- **babel:** fix import specifier rewrite oversight ([2369534][4]) + +## [1.2.0][5] (2024-03-18) #### ✨ Features -- Add `showHelp` option to `CliError` ([b5a1e58][4]) +- Add `showHelp` option to `CliError` ([b5a1e58][6]) -### [1.1.4][5] (2024-03-16) +### [1.1.4][7] (2024-03-16) #### 🪄 Fixes -- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][6]) +- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][8]) -### [1.1.3][7] (2024-03-15) +### [1.1.3][9] (2024-03-15) #### 🪄 Fixes -- Add support for `export default X` syntax ([bad391d][8]) -- Ensure `demandOption` is properly supported ([2f205c1][9]) +- Add support for `export default X` syntax ([bad391d][10]) +- Ensure `demandOption` is properly supported ([2f205c1][11]) -### [1.1.2][10] (2023-12-31) +### [1.1.2][12] (2023-12-31) #### 🪄 Fixes -- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][11]) +- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][13]) -### [1.1.1][12] (2023-12-31) +### [1.1.1][14] (2023-12-31) #### 🪄 Fixes -- Fix Node10 type resolution failure ([b6178c9][13]) +- Fix Node10 type resolution failure ([b6178c9][15]) -## [1.1.0][14] (2023-12-31) +## [1.1.0][16] (2023-12-31) #### ✨ Features -- **src:** support file://-style URLs ([0e5067e][15]) +- **src:** support file://-style URLs ([0e5067e][17]) #### 🪄 Fixes -- **src:** ensure --version is included in help text output when relevant ([4f159dc][16]) +- **src:** ensure --version is included in help text output when relevant ([4f159dc][18]) #### ⚙️ Build System -- **babel:** fix ESM<=>CJS interop issue ([5470091][17]) +- **babel:** fix ESM<=>CJS interop issue ([5470091][19]) -## [1.0.0][18] (2023-12-29) +## [1.0.0][20] (2023-12-29) #### ✨ Features -- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][19]) +- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][21]) #### 🪄 Fixes -- Rename package from "black-flag" to "[@black-][20]flag/core" npm typosquat workaround ([292ead5][21]) +- Rename package from "black-flag" to "[@black-][22]flag/core" npm typosquat workaround ([292ead5][23]) #### ⚙️ Build System -- Fix horrible decision by marked devs to break output for no reason ([036e350][22]) -- **jest:** ensure pkg-up is transformed ([c7f4aef][23]) -- **jest:** fix transformIgnorePatterns ([0548d34][24]) -- **jest:** transpile node\_modules ([5cf7a6c][25]) -- **tsconfig:** fix internal path resolution ([fbe3a69][26]) -- **tsconfig:** upgrade to NodeNext ([d3a499e][27]) +- Fix horrible decision by marked devs to break output for no reason ([036e350][24]) +- **jest:** ensure pkg-up is transformed ([c7f4aef][25]) +- **jest:** fix transformIgnorePatterns ([0548d34][26]) +- **jest:** transpile node\_modules ([5cf7a6c][27]) +- **tsconfig:** fix internal path resolution ([fbe3a69][28]) +- **tsconfig:** upgrade to NodeNext ([d3a499e][29]) [1]: https://conventionalcommits.org [2]: https://semver.org -[3]: https://github.com/Xunnamius/black-flag/compare/v1.1.4...v1.2.0 -[4]: https://github.com/Xunnamius/black-flag/commit/b5a1e58add31902fd9ec80b93dd37305b8fd0684 -[5]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4 -[6]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824 -[7]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3 -[8]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53 -[9]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8 -[10]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2 -[11]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271 -[12]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1 -[13]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c -[14]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0 -[15]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98 -[16]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea -[17]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8 -[18]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0 -[19]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842 -[20]: https://github.com/black- -[21]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d -[22]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87 -[23]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff -[24]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72 -[25]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17 -[26]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f -[27]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f +[3]: https://github.com/Xunnamius/black-flag/compare/v1.2.0...v1.2.1 +[4]: https://github.com/Xunnamius/black-flag/commit/2369534f63aa3858714bb81505d3fff4ed77c6b1 +[5]: https://github.com/Xunnamius/black-flag/compare/v1.1.4...v1.2.0 +[6]: https://github.com/Xunnamius/black-flag/commit/b5a1e58add31902fd9ec80b93dd37305b8fd0684 +[7]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4 +[8]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824 +[9]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3 +[10]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53 +[11]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8 +[12]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2 +[13]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271 +[14]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1 +[15]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c +[16]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0 +[17]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98 +[18]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea +[19]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8 +[20]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0 +[21]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842 +[22]: https://github.com/black- +[23]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d +[24]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87 +[25]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff +[26]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72 +[27]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17 +[28]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f +[29]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f diff --git a/docs/classes/index.CliError.md b/docs/classes/index.CliError.md index 36ed817..a4c742c 100644 --- a/docs/classes/index.CliError.md +++ b/docs/classes/index.CliError.md @@ -72,7 +72,7 @@ AppError.constructor #### Defined in -[src/error.ts:101](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L101) +[src/error.ts:101](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L101) • **new CliError**(`cause`, `options`, `message`, `superOptions`): [`CliError`](index.CliError.md) @@ -98,7 +98,7 @@ AppError.constructor #### Defined in -[src/error.ts:106](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L106) +[src/error.ts:106](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L106) ## Properties @@ -108,7 +108,7 @@ AppError.constructor #### Defined in -[src/error.ts:96](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L96) +[src/error.ts:96](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L96) ___ @@ -164,7 +164,7 @@ NonNullable.showHelp #### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L94) ___ @@ -192,7 +192,7 @@ NonNullable.suggestedExitCode #### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L93) ___ diff --git a/docs/classes/index.GracefulEarlyExitError.md b/docs/classes/index.GracefulEarlyExitError.md index cb4aac3..e44936c 100644 --- a/docs/classes/index.GracefulEarlyExitError.md +++ b/docs/classes/index.GracefulEarlyExitError.md @@ -56,7 +56,7 @@ termination of the application but with an exit code indicating success #### Defined in -[src/error.ts:172](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L172) +[src/error.ts:172](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L172) ## Properties @@ -70,7 +70,7 @@ termination of the application but with an exit code indicating success #### Defined in -[src/error.ts:166](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L166) +[src/error.ts:166](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L166) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L94) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L93) ___ diff --git a/docs/classes/util.AssertionFailedError.md b/docs/classes/util.AssertionFailedError.md index 225dd6b..87aeb80 100644 --- a/docs/classes/util.AssertionFailedError.md +++ b/docs/classes/util.AssertionFailedError.md @@ -58,7 +58,7 @@ Represents a failed sanity check. #### Defined in -[src/error.ts:188](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L188) +[src/error.ts:188](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L188) ## Properties @@ -72,7 +72,7 @@ Represents a failed sanity check. #### Defined in -[src/error.ts:184](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L184) +[src/error.ts:184](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L184) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L94) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L93) ___ diff --git a/docs/classes/util.CommandNotImplementedError.md b/docs/classes/util.CommandNotImplementedError.md index c45e53a..6f9e26e 100644 --- a/docs/classes/util.CommandNotImplementedError.md +++ b/docs/classes/util.CommandNotImplementedError.md @@ -53,7 +53,7 @@ implemented. #### Defined in -[src/error.ts:150](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L150) +[src/error.ts:150](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L150) ## Properties @@ -67,7 +67,7 @@ implemented. #### Defined in -[src/error.ts:145](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L145) +[src/error.ts:145](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L145) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L94) +[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L94) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L93) +[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L93) ___ diff --git a/docs/enums/index.FrameworkExitCode.md b/docs/enums/index.FrameworkExitCode.md index 2276e28..37d71c1 100644 --- a/docs/enums/index.FrameworkExitCode.md +++ b/docs/enums/index.FrameworkExitCode.md @@ -29,7 +29,7 @@ In most cases, this exit code is indicative of improper use of Black Flag. #### Defined in -[src/constant.ts:60](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L60) +[src/constant.ts:60](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L60) ___ @@ -41,7 +41,7 @@ Hard-coded default fallback exit code when fatal errors occur. #### Defined in -[src/constant.ts:48](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L48) +[src/constant.ts:48](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L48) ___ @@ -53,7 +53,7 @@ The exit code used when executing an unimplemented child command. #### Defined in -[src/constant.ts:52](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L52) +[src/constant.ts:52](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L52) ___ @@ -65,4 +65,4 @@ The exit code used when execution succeeds and exits gracefully. #### Defined in -[src/constant.ts:44](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L44) +[src/constant.ts:44](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L44) diff --git a/docs/modules/index.md b/docs/modules/index.md index b94ae51..be14355 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -59,7 +59,7 @@ arguments/properties specific to Black Flag, and an indexer falling back to #### Defined in -[types/program.ts:18](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L18) +[types/program.ts:18](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L18) ___ @@ -80,7 +80,7 @@ files that will eventually get imported via auto-discovery. #### Defined in -[types/module.ts:158](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/module.ts#L158) +[types/module.ts:158](https://github.com/Xunnamius/black-flag/blob/2369534/types/module.ts#L158) ___ @@ -114,7 +114,7 @@ subtype of this interface. #### Defined in -[types/module.ts:11](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/module.ts#L11) +[types/module.ts:11](https://github.com/Xunnamius/black-flag/blob/2369534/types/module.ts#L11) ___ @@ -137,7 +137,7 @@ definition for details. #### Defined in -[types/configure.ts:96](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/configure.ts#L96) +[types/configure.ts:96](https://github.com/Xunnamius/black-flag/blob/2369534/types/configure.ts#L96) ___ @@ -174,7 +174,7 @@ implemented. #### Defined in -[types/configure.ts:48](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/configure.ts#L48) +[types/configure.ts:48](https://github.com/Xunnamius/black-flag/blob/2369534/types/configure.ts#L48) ___ @@ -221,7 +221,7 @@ an argument parsing/validation error. #### Defined in -[types/configure.ts:81](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/configure.ts#L81) +[types/configure.ts:81](https://github.com/Xunnamius/black-flag/blob/2369534/types/configure.ts#L81) ___ @@ -258,7 +258,7 @@ thrown as-is and will NOT trigger [ConfigureErrorHandlingEpilogue](index.md#conf #### Defined in -[types/configure.ts:17](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/configure.ts#L17) +[types/configure.ts:17](https://github.com/Xunnamius/black-flag/blob/2369534/types/configure.ts#L17) ___ @@ -297,7 +297,7 @@ This function is the complement of [ConfigureExecutionPrologue](index.md#configu #### Defined in -[types/configure.ts:64](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/configure.ts#L64) +[types/configure.ts:64](https://github.com/Xunnamius/black-flag/blob/2369534/types/configure.ts#L64) ___ @@ -343,7 +343,7 @@ thrown as-is and will NOT trigger [ConfigureErrorHandlingEpilogue](index.md#conf #### Defined in -[types/configure.ts:37](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/configure.ts#L37) +[types/configure.ts:37](https://github.com/Xunnamius/black-flag/blob/2369534/types/configure.ts#L37) ___ @@ -364,7 +364,7 @@ file). #### Defined in -[types/module.ts:168](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/module.ts#L168) +[types/module.ts:168](https://github.com/Xunnamius/black-flag/blob/2369534/types/module.ts#L168) ___ @@ -386,7 +386,7 @@ yargs from returning a real `Arguments` parse result. #### Defined in -[types/program.ts:30](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L30) +[types/program.ts:30](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L30) ___ @@ -407,7 +407,7 @@ module files that will eventually get imported via auto-discovery. #### Defined in -[types/module.ts:148](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/module.ts#L148) +[types/module.ts:148](https://github.com/Xunnamius/black-flag/blob/2369534/types/module.ts#L148) ___ @@ -428,7 +428,7 @@ files that will eventually get imported via auto-discovery. #### Defined in -[types/module.ts:138](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/module.ts#L138) +[types/module.ts:138](https://github.com/Xunnamius/black-flag/blob/2369534/types/module.ts#L138) ## Variables @@ -441,7 +441,7 @@ each `Arguments` instance. #### Defined in -[src/constant.ts:5](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L5) +[src/constant.ts:5](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L5) ## Functions @@ -478,7 +478,7 @@ handles exceptions and sets the exit code for you. #### Defined in -[src/index.ts:59](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/index.ts#L59) +[src/index.ts:59](https://github.com/Xunnamius/black-flag/blob/2369534/src/index.ts#L59) ___ @@ -500,7 +500,7 @@ parameter is CliError #### Defined in -[src/error.ts:25](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L25) +[src/error.ts:25](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L25) ___ @@ -522,7 +522,7 @@ parameter is GracefulEarlyExitError #### Defined in -[src/error.ts:38](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L38) +[src/error.ts:38](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L38) ___ @@ -562,7 +562,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:172](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L172) +[src/util.ts:172](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L172) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\> \| `undefined`\> @@ -598,7 +598,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:193](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L193) +[src/util.ts:193](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L193) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\> \| `undefined`\> @@ -635,7 +635,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:214](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L214) +[src/util.ts:214](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L214) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>\> @@ -672,7 +672,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:238](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L238) +[src/util.ts:238](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L238) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>\> @@ -709,7 +709,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:260](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L260) +[src/util.ts:260](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L260) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>\> @@ -747,4 +747,4 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:286](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L286) +[src/util.ts:286](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L286) diff --git a/docs/modules/util.md b/docs/modules/util.md index a832765..fdb580c 100644 --- a/docs/modules/util.md +++ b/docs/modules/util.md @@ -62,7 +62,7 @@ Options available when constructing a new `CliError` object. #### Defined in -[src/error.ts:67](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L67) +[src/error.ts:67](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L67) ___ @@ -82,7 +82,7 @@ Accepts a `Descriptor` type and maps it to one of the `XProgram` types. #### Defined in -[types/program.ts:159](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L159) +[types/program.ts:159](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L159) ___ @@ -101,7 +101,7 @@ Represents an "effector" [Program](util.md#program) instance. #### Defined in -[types/program.ts:119](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L119) +[types/program.ts:119](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L119) ___ @@ -137,7 +137,7 @@ Represents a globally-accessible shared context object singleton. #### Defined in -[types/program.ts:328](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L328) +[types/program.ts:328](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L328) ___ @@ -177,7 +177,7 @@ instead. #### Defined in -[types/program.ts:280](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L280) +[types/program.ts:280](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L280) ___ @@ -207,7 +207,7 @@ you. #### Defined in -[types/program.ts:257](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L257) +[types/program.ts:257](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L257) ___ @@ -226,7 +226,7 @@ Represents an "helper" [Program](util.md#program) instance. #### Defined in -[types/program.ts:130](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L130) +[types/program.ts:130](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L130) ___ @@ -245,7 +245,7 @@ Represents the pre-execution context that is the result of calling #### Defined in -[types/program.ts:291](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L291) +[types/program.ts:291](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L291) ___ @@ -268,7 +268,7 @@ by yargs but with several differences and should be preferred. #### Defined in -[types/program.ts:44](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L44) +[types/program.ts:44](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L44) ___ @@ -280,7 +280,7 @@ Represents the three program types that comprise any Black Flag command. #### Defined in -[types/program.ts:154](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L154) +[types/program.ts:154](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L154) ___ @@ -306,7 +306,7 @@ corresponding [Configuration](index.md#configuration) object/file. #### Defined in -[types/program.ts:188](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L188) +[types/program.ts:188](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L188) ___ @@ -318,7 +318,7 @@ Represents valid [Configuration](index.md#configuration) module types that can b #### Defined in -[types/program.ts:149](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L149) +[types/program.ts:149](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L149) ___ @@ -338,7 +338,7 @@ aptly-named values in an object. #### Defined in -[types/program.ts:173](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L173) +[types/program.ts:173](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L173) ___ @@ -357,7 +357,7 @@ Represents an "router" [Program](util.md#program) instance. #### Defined in -[types/program.ts:141](https://github.com/Xunnamius/black-flag/blob/b5a1e58/types/program.ts#L141) +[types/program.ts:141](https://github.com/Xunnamius/black-flag/blob/2369534/types/program.ts#L141) ## Variables @@ -411,7 +411,7 @@ A collection of possible error and warning messages emitted by Black Flag. #### Defined in -[src/error.ts:200](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L200) +[src/error.ts:200](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L200) ___ @@ -424,7 +424,7 @@ Hard-coded default option name for dumping help text to stdout. For example: #### Defined in -[src/constant.ts:19](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L19) +[src/constant.ts:19](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L19) ___ @@ -436,7 +436,7 @@ Hard-coded default help option description text. #### Defined in -[src/constant.ts:24](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L24) +[src/constant.ts:24](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L24) ___ @@ -451,7 +451,7 @@ description (`description` export) respectively. #### Defined in -[src/constant.ts:13](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L13) +[src/constant.ts:13](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L13) ___ @@ -464,7 +464,7 @@ example: `--${defaultVersionOptionName}`. #### Defined in -[src/constant.ts:30](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L30) +[src/constant.ts:30](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L30) ___ @@ -476,7 +476,7 @@ Hard-coded default version option description text. #### Defined in -[src/constant.ts:35](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/constant.ts#L35) +[src/constant.ts:35](https://github.com/Xunnamius/black-flag/blob/2369534/src/constant.ts#L35) ## Functions @@ -500,7 +500,7 @@ https://yargs.js.org/docs/#api-reference #### Defined in -[src/exports/util.ts:48](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/exports/util.ts#L48) +[src/exports/util.ts:48](https://github.com/Xunnamius/black-flag/blob/2369534/src/exports/util.ts#L48) ___ @@ -522,7 +522,7 @@ obj is Arguments #### Defined in -[src/util.ts:458](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L458) +[src/util.ts:458](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L458) ___ @@ -544,7 +544,7 @@ error is ErrnoException & Object #### Defined in -[src/util.ts:472](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L472) +[src/util.ts:472](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L472) ___ @@ -566,7 +566,7 @@ parameter is CommandNotImplementedError #### Defined in -[src/error.ts:53](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/error.ts#L53) +[src/error.ts:53](https://github.com/Xunnamius/black-flag/blob/2369534/src/error.ts#L53) ___ @@ -588,7 +588,7 @@ obj is NullArguments #### Defined in -[src/util.ts:447](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L447) +[src/util.ts:447](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L447) ___ @@ -610,7 +610,7 @@ obj is PreExecutionContext #### Defined in -[src/util.ts:434](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L434) +[src/util.ts:434](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L434) ___ @@ -669,4 +669,4 @@ details. #### Defined in -[src/util.ts:50](https://github.com/Xunnamius/black-flag/blob/b5a1e58/src/util.ts#L50) +[src/util.ts:50](https://github.com/Xunnamius/black-flag/blob/2369534/src/util.ts#L50) diff --git a/package-lock.json b/package-lock.json index 59aa54b..65c7880 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@black-flag/core", - "version": "1.2.0", + "version": "1.2.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@black-flag/core", - "version": "1.2.0", + "version": "1.2.1", "license": "MIT", "dependencies": { "@types/debug": "^4.1.12", diff --git a/package.json b/package.json index 84c5825..ff1e4ef 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@black-flag/core", - "version": "1.2.0", + "version": "1.2.1", "description": "A declarative framework for building fluent, deeply hierarchical command line interfaces with yargs", "keywords": [ "cli",