From 002de085991baead37a7f94068ae444b8c859e62 Mon Sep 17 00:00:00 2001 From: "Xunnamius (Romulus)" Date: Sun, 31 Dec 2023 15:53:36 -0800 Subject: [PATCH] release: 1.1.2 [skip ci] MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### [1.1.2](https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2) (2023-12-31) #### 🪄 Fixes * **readme:** move parserConfiguration call out of dead zone in example ([f79c114](https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271)) --- CHANGELOG.md | 70 +++++++++++-------- docs/classes/index.CliError.md | 8 +-- docs/classes/index.GracefulEarlyExitError.md | 6 +- docs/classes/util.AssertionFailedError.md | 6 +- .../util.CommandNotImplementedError.md | 6 +- docs/enums/index.FrameworkExitCode.md | 8 +-- docs/modules/index.md | 48 ++++++------- docs/modules/util.md | 54 +++++++------- package-lock.json | 4 +- package.json | 2 +- 10 files changed, 110 insertions(+), 102 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47b42e9..f8a4e7a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,60 +4,68 @@ 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.1.1][3] (2023-12-31) +### [1.1.2][3] (2023-12-31) #### 🪄 Fixes -- Fix Node10 type resolution failure ([b6178c9][4]) +- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][4]) -## [1.1.0][5] (2023-12-31) +### [1.1.1][5] (2023-12-31) + +#### 🪄 Fixes + +- Fix Node10 type resolution failure ([b6178c9][6]) + +## [1.1.0][7] (2023-12-31) #### ✨ Features -- **src:** support file://-style URLs ([0e5067e][6]) +- **src:** support file://-style URLs ([0e5067e][8]) #### 🪄 Fixes -- **src:** ensure --version is included in help text output when relevant ([4f159dc][7]) +- **src:** ensure --version is included in help text output when relevant ([4f159dc][9]) #### ⚙️ Build System -- **babel:** fix ESM<=>CJS interop issue ([5470091][8]) +- **babel:** fix ESM<=>CJS interop issue ([5470091][10]) -## [1.0.0][9] (2023-12-29) +## [1.0.0][11] (2023-12-29) #### ✨ Features -- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][10]) +- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][12]) #### 🪄 Fixes -- Rename package from "black-flag" to "[@black-][11]flag/core" npm typosquat workaround ([292ead5][12]) +- Rename package from "black-flag" to "[@black-][13]flag/core" npm typosquat workaround ([292ead5][14]) #### ⚙️ Build System -- Fix horrible decision by marked devs to break output for no reason ([036e350][13]) -- **jest:** ensure pkg-up is transformed ([c7f4aef][14]) -- **jest:** fix transformIgnorePatterns ([0548d34][15]) -- **jest:** transpile node\_modules ([5cf7a6c][16]) -- **tsconfig:** fix internal path resolution ([fbe3a69][17]) -- **tsconfig:** upgrade to NodeNext ([d3a499e][18]) +- Fix horrible decision by marked devs to break output for no reason ([036e350][15]) +- **jest:** ensure pkg-up is transformed ([c7f4aef][16]) +- **jest:** fix transformIgnorePatterns ([0548d34][17]) +- **jest:** transpile node\_modules ([5cf7a6c][18]) +- **tsconfig:** fix internal path resolution ([fbe3a69][19]) +- **tsconfig:** upgrade to NodeNext ([d3a499e][20]) [1]: https://conventionalcommits.org [2]: https://semver.org -[3]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1 -[4]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c -[5]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0 -[6]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98 -[7]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea -[8]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8 -[9]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0 -[10]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842 -[11]: https://github.com/black- -[12]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d -[13]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87 -[14]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff -[15]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72 -[16]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17 -[17]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f -[18]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f +[3]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2 +[4]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271 +[5]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1 +[6]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c +[7]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0 +[8]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98 +[9]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea +[10]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8 +[11]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0 +[12]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842 +[13]: https://github.com/black- +[14]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d +[15]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87 +[16]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff +[17]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72 +[18]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17 +[19]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f +[20]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f diff --git a/docs/classes/index.CliError.md b/docs/classes/index.CliError.md index 80bf5f1..8cfaba2 100644 --- a/docs/classes/index.CliError.md +++ b/docs/classes/index.CliError.md @@ -71,7 +71,7 @@ AppError.constructor #### Defined in -[src/error.ts:92](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L92) +[src/error.ts:92](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L92) • **new CliError**(`cause`, `options`, `message`, `superOptions`): [`CliError`](index.CliError.md) @@ -97,7 +97,7 @@ AppError.constructor #### Defined in -[src/error.ts:97](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L97) +[src/error.ts:97](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L97) ## Properties @@ -107,7 +107,7 @@ AppError.constructor #### Defined in -[src/error.ts:87](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L87) +[src/error.ts:87](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L87) ___ @@ -177,7 +177,7 @@ NonNullable.suggestedExitCode #### Defined in -[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L85) +[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L85) ___ diff --git a/docs/classes/index.GracefulEarlyExitError.md b/docs/classes/index.GracefulEarlyExitError.md index ea007a3..28c2758 100644 --- a/docs/classes/index.GracefulEarlyExitError.md +++ b/docs/classes/index.GracefulEarlyExitError.md @@ -55,7 +55,7 @@ termination of the application but with an exit code indicating success #### Defined in -[src/error.ts:159](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L159) +[src/error.ts:159](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L159) ## Properties @@ -69,7 +69,7 @@ termination of the application but with an exit code indicating success #### Defined in -[src/error.ts:153](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L153) +[src/error.ts:153](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L153) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L85) +[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L85) ___ diff --git a/docs/classes/util.AssertionFailedError.md b/docs/classes/util.AssertionFailedError.md index 39626d8..f3a477a 100644 --- a/docs/classes/util.AssertionFailedError.md +++ b/docs/classes/util.AssertionFailedError.md @@ -57,7 +57,7 @@ Represents a failed sanity check. #### Defined in -[src/error.ts:175](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L175) +[src/error.ts:175](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L175) ## Properties @@ -71,7 +71,7 @@ Represents a failed sanity check. #### Defined in -[src/error.ts:171](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L171) +[src/error.ts:171](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L171) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L85) +[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L85) ___ diff --git a/docs/classes/util.CommandNotImplementedError.md b/docs/classes/util.CommandNotImplementedError.md index ab95aa0..1857c9b 100644 --- a/docs/classes/util.CommandNotImplementedError.md +++ b/docs/classes/util.CommandNotImplementedError.md @@ -52,7 +52,7 @@ implemented. #### Defined in -[src/error.ts:137](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L137) +[src/error.ts:137](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L137) ## Properties @@ -66,7 +66,7 @@ implemented. #### Defined in -[src/error.ts:132](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L132) +[src/error.ts:132](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L132) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L85) +[src/error.ts:85](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L85) ___ diff --git a/docs/enums/index.FrameworkExitCode.md b/docs/enums/index.FrameworkExitCode.md index 2ce3f0f..12f0622 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/b6178c9/src/constant.ts#L60) +[src/constant.ts:60](https://github.com/Xunnamius/black-flag/blob/5438f60/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/b6178c9/src/constant.ts#L48) +[src/constant.ts:48](https://github.com/Xunnamius/black-flag/blob/5438f60/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/b6178c9/src/constant.ts#L52) +[src/constant.ts:52](https://github.com/Xunnamius/black-flag/blob/5438f60/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/b6178c9/src/constant.ts#L44) +[src/constant.ts:44](https://github.com/Xunnamius/black-flag/blob/5438f60/src/constant.ts#L44) diff --git a/docs/modules/index.md b/docs/modules/index.md index 1004ef6..e148ba3 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -58,7 +58,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/b6178c9/types/program.ts#L18) +[types/program.ts:18](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L18) ___ @@ -78,7 +78,7 @@ files that will eventually get imported via auto-discovery. #### Defined in -[types/module.ts:153](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/module.ts#L153) +[types/module.ts:153](https://github.com/Xunnamius/black-flag/blob/5438f60/types/module.ts#L153) ___ @@ -105,13 +105,13 @@ subtype of this interface. | `command` | ``"$0"`` \| \`$0 $\{string}\` | The command as interpreted by yargs. May contain positional arguments. It is usually unnecessary to change or use this property if you're not using positional arguments. If you want to change your command's name, use [Configuration.name](index.md#name). If you want to change the usage text, use [Configuration.usage](index.md#usage). **`Default`** ```ts "$0" ``` | | `deprecated` | `string` \| `boolean` | If truthy, the command will be considered "deprecated" by yargs. If `deprecated` is a string, it will additionally be treated as a deprecation message that will appear alongside the command in help text. **`Default`** ```ts false ``` | | `description` | `string` \| ``false`` | The description for the command in help text. If `false`, the command will be considered "hidden" by yargs. **`Default`** ```ts "" ``` | -| `handler` | (`args`: [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>) => `Promisable`\<`void`\> | A function called when this command is invoked. It will receive an object of parsed arguments. If `undefined`, a `CommandNotImplementedError` will be thrown. **`Default`** ```ts undefined ``` | +| `handler` | (`argv`: [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>) => `Promisable`\<`void`\> | A function called when this command is invoked. It will receive an object of parsed arguments. If `undefined`, a `CommandNotImplementedError` will be thrown. **`Default`** ```ts undefined ``` | | `name` | `string` | The name of the command. Any spaces will be replaced with hyphens. Including a character that yargs does not consider valid for a command name will result in an error. Defaults to the filename containing the configuration, excluding its extension, or the directory name (with spaces replaced) if the filename without extension is "index". | | `usage` | `string` | Set a usage message shown at the top of the command's help text. Several replacements are made to the `usage` string before it is output. In order: - `$000` will be replaced by the entire command itself (including full canonical name and parameters). - `$1` will be replaced by the description of the command. - `$0` will be replaced with the full canonical name of the command. **`Default`** ```ts "Usage: $000\n\n$1" ``` | #### Defined in -[types/module.ts:11](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/module.ts#L11) +[types/module.ts:11](https://github.com/Xunnamius/black-flag/blob/5438f60/types/module.ts#L11) ___ @@ -134,7 +134,7 @@ definition for details. #### Defined in -[types/configure.ts:96](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/configure.ts#L96) +[types/configure.ts:96](https://github.com/Xunnamius/black-flag/blob/5438f60/types/configure.ts#L96) ___ @@ -171,7 +171,7 @@ implemented. #### Defined in -[types/configure.ts:48](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/configure.ts#L48) +[types/configure.ts:48](https://github.com/Xunnamius/black-flag/blob/5438f60/types/configure.ts#L48) ___ @@ -218,7 +218,7 @@ an argument parsing/validation error. #### Defined in -[types/configure.ts:81](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/configure.ts#L81) +[types/configure.ts:81](https://github.com/Xunnamius/black-flag/blob/5438f60/types/configure.ts#L81) ___ @@ -255,7 +255,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/b6178c9/types/configure.ts#L17) +[types/configure.ts:17](https://github.com/Xunnamius/black-flag/blob/5438f60/types/configure.ts#L17) ___ @@ -294,7 +294,7 @@ This function is the complement of [ConfigureExecutionPrologue](index.md#configu #### Defined in -[types/configure.ts:64](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/configure.ts#L64) +[types/configure.ts:64](https://github.com/Xunnamius/black-flag/blob/5438f60/types/configure.ts#L64) ___ @@ -340,7 +340,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/b6178c9/types/configure.ts#L37) +[types/configure.ts:37](https://github.com/Xunnamius/black-flag/blob/5438f60/types/configure.ts#L37) ___ @@ -360,7 +360,7 @@ file). #### Defined in -[types/module.ts:162](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/module.ts#L162) +[types/module.ts:162](https://github.com/Xunnamius/black-flag/blob/5438f60/types/module.ts#L162) ___ @@ -376,7 +376,7 @@ yargs from returning a real `Arguments` parse result. #### Defined in -[types/program.ts:29](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L29) +[types/program.ts:29](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L29) ___ @@ -396,7 +396,7 @@ module files that will eventually get imported via auto-discovery. #### Defined in -[types/module.ts:144](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/module.ts#L144) +[types/module.ts:144](https://github.com/Xunnamius/black-flag/blob/5438f60/types/module.ts#L144) ___ @@ -416,7 +416,7 @@ files that will eventually get imported via auto-discovery. #### Defined in -[types/module.ts:135](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/module.ts#L135) +[types/module.ts:135](https://github.com/Xunnamius/black-flag/blob/5438f60/types/module.ts#L135) ## Variables @@ -429,7 +429,7 @@ each `Arguments` instance. #### Defined in -[src/constant.ts:5](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/constant.ts#L5) +[src/constant.ts:5](https://github.com/Xunnamius/black-flag/blob/5438f60/src/constant.ts#L5) ## Functions @@ -466,7 +466,7 @@ handles exceptions and sets the exit code for you. #### Defined in -[src/index.ts:59](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/index.ts#L59) +[src/index.ts:59](https://github.com/Xunnamius/black-flag/blob/5438f60/src/index.ts#L59) ___ @@ -488,7 +488,7 @@ parameter is CliError #### Defined in -[src/error.ts:25](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L25) +[src/error.ts:25](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L25) ___ @@ -510,7 +510,7 @@ parameter is GracefulEarlyExitError #### Defined in -[src/error.ts:38](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L38) +[src/error.ts:38](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L38) ___ @@ -550,7 +550,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:172](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L172) +[src/util.ts:172](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L172) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\> \| `undefined`\> @@ -586,7 +586,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:193](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L193) +[src/util.ts:193](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L193) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\> \| `undefined`\> @@ -623,7 +623,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:214](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L214) +[src/util.ts:214](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L214) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>\> @@ -660,7 +660,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:238](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L238) +[src/util.ts:238](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L238) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>\> @@ -697,7 +697,7 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:260](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L260) +[src/util.ts:260](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L260) ▸ **runProgram**\<`CustomCliArguments`\>(`...args`): `Promise`\<[`NullArguments`](index.md#nullarguments) \| [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>\> @@ -735,4 +735,4 @@ if any other error occurs, or `Arguments` otherwise. #### Defined in -[src/util.ts:286](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L286) +[src/util.ts:286](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L286) diff --git a/docs/modules/util.md b/docs/modules/util.md index 078ef82..7a784dc 100644 --- a/docs/modules/util.md +++ b/docs/modules/util.md @@ -61,7 +61,7 @@ Options available when constructing a new `CliError` object. #### Defined in -[src/error.ts:67](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L67) +[src/error.ts:67](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L67) ___ @@ -80,7 +80,7 @@ Accepts a `Descriptor` type and maps it to one of the `XProgram` types. #### Defined in -[types/program.ts:141](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L141) +[types/program.ts:141](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L141) ___ @@ -98,7 +98,7 @@ Represents an "effector" [Program](util.md#program) instance. #### Defined in -[types/program.ts:110](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L110) +[types/program.ts:110](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L110) ___ @@ -134,7 +134,7 @@ Represents a globally-accessible shared context object singleton. #### Defined in -[types/program.ts:302](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L302) +[types/program.ts:302](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L302) ___ @@ -174,7 +174,7 @@ instead. #### Defined in -[types/program.ts:254](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L254) +[types/program.ts:254](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L254) ___ @@ -198,7 +198,7 @@ you. #### Defined in -[types/program.ts:233](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L233) +[types/program.ts:233](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L233) ___ @@ -216,7 +216,7 @@ Represents an "helper" [Program](util.md#program) instance. #### Defined in -[types/program.ts:117](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L117) +[types/program.ts:117](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L117) ___ @@ -235,13 +235,13 @@ Represents the pre-execution context that is the result of calling #### Defined in -[types/program.ts:265](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L265) +[types/program.ts:265](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L265) ___ ### Program -Ƭ **Program**\<`CustomCliArguments`\>: `Omit`\<`_Program`\<[`FrameworkArguments`](util.md#frameworkarguments) & `CustomCliArguments`\>, ``"command"`` \| ``"onFinishCommand"`` \| ``"showHelpOnFail"`` \| ``"version"`` \| ``"help"`` \| ``"exitProcess"`` \| ``"commandDir"`` \| ``"parse"`` \| ``"parsed"`` \| ``"parseSync"`` \| ``"argv"``\> & \{ `command`: (`command`: `string`[], `description`: `string` \| ``false``, `builder`: (`yargs`: `Argv`\<{}\>, `helpOrVersionSet`: `boolean`) => `Argv`\<{}\> \| `Record`\<`string`, `never`\>, `handler`: (`args`: [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>) => `Promisable`\<`void`\>, `middlewares`: [], `deprecated`: `string` \| `boolean`) => [`Program`](util.md#program)\<`CustomCliArguments`\> ; `command_deferred`: [`Program`](util.md#program)\<`CustomCliArguments`\>[``"command"``] ; `command_finalize_deferred`: () => `void` ; `showHelpOnFail`: (`enabled`: `boolean`) => [`Program`](util.md#program)\<`CustomCliArguments`\> } +Ƭ **Program**\<`CustomCliArguments`\>: `Omit`\<`_Program`\<[`FrameworkArguments`](util.md#frameworkarguments) & `CustomCliArguments`\>, ``"command"`` \| ``"onFinishCommand"`` \| ``"showHelpOnFail"`` \| ``"version"`` \| ``"help"`` \| ``"exitProcess"`` \| ``"commandDir"`` \| ``"parse"`` \| ``"parsed"`` \| ``"parseSync"`` \| ``"argv"``\> & \{ `command`: (`command`: `string`[], `description`: `string` \| ``false``, `builder`: (`yargs`: `Argv`\<{}\>, `helpOrVersionSet`: `boolean`) => `Argv`\<{}\> \| `Record`\<`string`, `never`\>, `handler`: (`argv`: [`Arguments`](index.md#arguments)\<`CustomCliArguments`\>) => `Promisable`\<`void`\>, `middlewares`: [], `deprecated`: `string` \| `boolean`) => [`Program`](util.md#program)\<`CustomCliArguments`\> ; `command_deferred`: [`Program`](util.md#program)\<`CustomCliArguments`\>[``"command"``] ; `command_finalize_deferred`: () => `void` ; `showHelpOnFail`: (`enabled`: `boolean`) => [`Program`](util.md#program)\<`CustomCliArguments`\> } Represents a pre-configured yargs instance ready for argument parsing and execution. @@ -257,7 +257,7 @@ by yargs but with several differences and should be preferred. #### Defined in -[types/program.ts:41](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L41) +[types/program.ts:41](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L41) ___ @@ -269,7 +269,7 @@ Represents the three program types that comprise any Black Flag command. #### Defined in -[types/program.ts:136](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L136) +[types/program.ts:136](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L136) ___ @@ -295,7 +295,7 @@ corresponding [Configuration](index.md#configuration) object/file. #### Defined in -[types/program.ts:164](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L164) +[types/program.ts:164](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L164) ___ @@ -307,7 +307,7 @@ Represents valid [Configuration](index.md#configuration) module types that can b #### Defined in -[types/program.ts:131](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L131) +[types/program.ts:131](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L131) ___ @@ -326,7 +326,7 @@ aptly-named values in an object. #### Defined in -[types/program.ts:154](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L154) +[types/program.ts:154](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L154) ___ @@ -344,7 +344,7 @@ Represents an "router" [Program](util.md#program) instance. #### Defined in -[types/program.ts:124](https://github.com/Xunnamius/black-flag/blob/b6178c9/types/program.ts#L124) +[types/program.ts:124](https://github.com/Xunnamius/black-flag/blob/5438f60/types/program.ts#L124) ## Variables @@ -398,7 +398,7 @@ A collection of possible error and warning messages emitted by Black Flag. #### Defined in -[src/error.ts:187](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L187) +[src/error.ts:187](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L187) ___ @@ -411,7 +411,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/b6178c9/src/constant.ts#L19) +[src/constant.ts:19](https://github.com/Xunnamius/black-flag/blob/5438f60/src/constant.ts#L19) ___ @@ -423,7 +423,7 @@ Hard-coded default help option description text. #### Defined in -[src/constant.ts:24](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/constant.ts#L24) +[src/constant.ts:24](https://github.com/Xunnamius/black-flag/blob/5438f60/src/constant.ts#L24) ___ @@ -438,7 +438,7 @@ description (`description` export) respectively. #### Defined in -[src/constant.ts:13](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/constant.ts#L13) +[src/constant.ts:13](https://github.com/Xunnamius/black-flag/blob/5438f60/src/constant.ts#L13) ___ @@ -451,7 +451,7 @@ example: `--${defaultVersionOptionName}`. #### Defined in -[src/constant.ts:30](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/constant.ts#L30) +[src/constant.ts:30](https://github.com/Xunnamius/black-flag/blob/5438f60/src/constant.ts#L30) ___ @@ -463,7 +463,7 @@ Hard-coded default version option description text. #### Defined in -[src/constant.ts:35](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/constant.ts#L35) +[src/constant.ts:35](https://github.com/Xunnamius/black-flag/blob/5438f60/src/constant.ts#L35) ## Functions @@ -509,7 +509,7 @@ obj is Arguments #### Defined in -[src/util.ts:458](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L458) +[src/util.ts:458](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L458) ___ @@ -531,7 +531,7 @@ error is ErrnoException & Object #### Defined in -[src/util.ts:472](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L472) +[src/util.ts:472](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L472) ___ @@ -553,7 +553,7 @@ parameter is CommandNotImplementedError #### Defined in -[src/error.ts:53](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/error.ts#L53) +[src/error.ts:53](https://github.com/Xunnamius/black-flag/blob/5438f60/src/error.ts#L53) ___ @@ -575,7 +575,7 @@ obj is NullArguments #### Defined in -[src/util.ts:447](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L447) +[src/util.ts:447](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L447) ___ @@ -597,7 +597,7 @@ obj is PreExecutionContext #### Defined in -[src/util.ts:434](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L434) +[src/util.ts:434](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L434) ___ @@ -659,4 +659,4 @@ details. #### Defined in -[src/util.ts:50](https://github.com/Xunnamius/black-flag/blob/b6178c9/src/util.ts#L50) +[src/util.ts:50](https://github.com/Xunnamius/black-flag/blob/5438f60/src/util.ts#L50) diff --git a/package-lock.json b/package-lock.json index c7737be..02ab71f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@black-flag/core", - "version": "1.1.1", + "version": "1.1.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@black-flag/core", - "version": "1.1.1", + "version": "1.1.2", "license": "MIT", "dependencies": { "@types/debug": "^4.1.12", diff --git a/package.json b/package.json index c2ee431..e7d1e39 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@black-flag/core", - "version": "1.1.1", + "version": "1.1.2", "description": "A declarative framework for building fluent, deeply hierarchical command line interfaces with yargs", "keywords": [ "cli",