Skip to content

Commit 50f0beb

Browse files
committed
release: 1.2.7 [skip ci]
### [1.2.7](v1.2.6...v1.2.7) (2024-06-30) #### 🪄 Fixes * **types:** pass through `CustomExecutionContext` as context type in `ImportedConfigurationModule` ([cdc6af5](cdc6af5)) #### ⚙️ Build system * **spellcheck-commit:** fix commit spellchecker ([6e7a268](6e7a268))
1 parent cdc6af5 commit 50f0beb

Some content is hidden

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

53 files changed

+407
-322
lines changed

CHANGELOG.md

Lines changed: 94 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -4,156 +4,169 @@ All notable changes to this project will be documented in this auto-generated
44
file. The format is based on [Conventional Commits][1];
55
this project adheres to [Semantic Versioning][2].
66

7-
### [1.2.6][3] (2024-06-02)
7+
### [1.2.7][3] (2024-06-30)
88

99
#### 🪄 Fixes
1010

11-
- **src:** ignore --help and --version if they occur after -- in argv ([35f66cc][4])
11+
- **types:** pass through `CustomExecutionContext` as context type in `ImportedConfigurationModule` ([cdc6af5][4])
1212

13-
### [1.2.5][5] (2024-05-30)
13+
#### ⚙️ Build System
14+
15+
- **spellcheck-commit:** fix commit spellchecker ([6e7a268][5])
16+
17+
### [1.2.6][6] (2024-06-02)
18+
19+
#### 🪄 Fixes
20+
21+
- **src:** ignore --help and --version if they occur after -- in argv ([35f66cc][7])
22+
23+
### [1.2.5][8] (2024-05-30)
1424

1525
#### 🪄 Fixes
1626

17-
- **src:** permanently fix --version support regression in node\@22 ([c201c2f][6])
27+
- **src:** permanently fix --version support regression in node\@22 ([c201c2f][9])
1828

1929
#### ⚙️ Build System
2030

21-
- **package:** append node\@22 to supported node versions ([98815d1][7])
31+
- **package:** append node\@22 to supported node versions ([98815d1][10])
2232

23-
### [1.2.4][8] (2024-03-27)
33+
### [1.2.4][11] (2024-03-27)
2434

2535
#### 🪄 Fixes
2636

27-
- **src:** explicitly ignore .d.ts files within command dirs ([d6618d3][9])
37+
- **src:** explicitly ignore .d.ts files within command dirs ([d6618d3][12])
2838

29-
### [1.2.3][10] (2024-03-27)
39+
### [1.2.3][13] (2024-03-27)
3040

3141
#### 🪄 Fixes
3242

33-
- **package:** bump minimum node support to 20 LTS ([4b8c975][11])
34-
- **src:** ignore unknown file extension errors when discovering commands ([4babf12][12])
43+
- **package:** bump minimum node support to 20 LTS ([4b8c975][14])
44+
- **src:** ignore unknown file extension errors when discovering commands ([4babf12][15])
3545

36-
### [1.2.2][13] (2024-03-21)
46+
### [1.2.2][16] (2024-03-21)
3747

3848
#### 🪄 Fixes
3949

40-
- No longer include default command when listing subcommands ([be2960a][14])
50+
- No longer include default command when listing subcommands ([be2960a][17])
4151

4252
#### ⚙️ Build System
4353

44-
- **husky:** update to latest hooks ([75d5c66][15])
45-
- **src:** do not filter to own methods when proxying and rebinding ([8bb0254][16])
54+
- **husky:** update to latest hooks ([75d5c66][18])
55+
- **src:** do not filter to own methods when proxying and rebinding ([8bb0254][19])
4656

47-
### [1.2.1][17] (2024-03-19)
57+
### [1.2.1][20] (2024-03-19)
4858

4959
#### ⚙️ Build System
5060

51-
- **babel:** fix import specifier rewrite oversight ([2369534][18])
61+
- **babel:** fix import specifier rewrite oversight ([2369534][21])
5262

53-
## [1.2.0][19] (2024-03-18)
63+
## [1.2.0][22] (2024-03-18)
5464

5565
#### ✨ Features
5666

57-
- Add `showHelp` option to `CliError` ([b5a1e58][20])
67+
- Add `showHelp` option to `CliError` ([b5a1e58][23])
5868

59-
### [1.1.4][21] (2024-03-16)
69+
### [1.1.4][24] (2024-03-16)
6070

6171
#### 🪄 Fixes
6272

63-
- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][22])
73+
- **types:** allow exported types to specify custom `ExecutionContext` ([f66599b][25])
6474

65-
### [1.1.3][23] (2024-03-15)
75+
### [1.1.3][26] (2024-03-15)
6676

6777
#### 🪄 Fixes
6878

69-
- Add support for `export default X` syntax ([bad391d][24])
70-
- Ensure `demandOption` is properly supported ([2f205c1][25])
79+
- Add support for `export default X` syntax ([bad391d][27])
80+
- Ensure `demandOption` is properly supported ([2f205c1][28])
7181

72-
### [1.1.2][26] (2023-12-31)
82+
### [1.1.2][29] (2023-12-31)
7383

7484
#### 🪄 Fixes
7585

76-
- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][27])
86+
- **readme:** move parserConfiguration call out of dead zone in example ([f79c114][30])
7787

78-
### [1.1.1][28] (2023-12-31)
88+
### [1.1.1][31] (2023-12-31)
7989

8090
#### 🪄 Fixes
8191

82-
- Fix Node10 type resolution failure ([b6178c9][29])
92+
- Fix Node10 type resolution failure ([b6178c9][32])
8393

84-
## [1.1.0][30] (2023-12-31)
94+
## [1.1.0][33] (2023-12-31)
8595

8696
#### ✨ Features
8797

88-
- **src:** support file://-style URLs ([0e5067e][31])
98+
- **src:** support file://-style URLs ([0e5067e][34])
8999

90100
#### 🪄 Fixes
91101

92-
- **src:** ensure --version is included in help text output when relevant ([4f159dc][32])
102+
- **src:** ensure --version is included in help text output when relevant ([4f159dc][35])
93103

94104
#### ⚙️ Build System
95105

96-
- **babel:** fix ESM<=>CJS interop issue ([5470091][33])
106+
- **babel:** fix ESM<=>CJS interop issue ([5470091][36])
97107

98-
## [1.0.0][34] (2023-12-29)
108+
## [1.0.0][37] (2023-12-29)
99109

100110
#### ✨ Features
101111

102-
- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][35])
112+
- **src:** disallow creating commands with conflicting names/aliases ([78bf8ff][38])
103113

104114
#### 🪄 Fixes
105115

106-
- Rename package from "black-flag" to "[@black-][36]flag/core" npm typosquat workaround ([292ead5][37])
116+
- Rename package from "black-flag" to "[@black-][39]flag/core" npm typosquat workaround ([292ead5][40])
107117

108118
#### ⚙️ Build System
109119

110-
- Fix horrible decision by marked devs to break output for no reason ([036e350][38])
111-
- **jest:** ensure pkg-up is transformed ([c7f4aef][39])
112-
- **jest:** fix transformIgnorePatterns ([0548d34][40])
113-
- **jest:** transpile node\_modules ([5cf7a6c][41])
114-
- **tsconfig:** fix internal path resolution ([fbe3a69][42])
115-
- **tsconfig:** upgrade to NodeNext ([d3a499e][43])
120+
- Fix horrible decision by marked devs to break output for no reason ([036e350][41])
121+
- **jest:** ensure pkg-up is transformed ([c7f4aef][42])
122+
- **jest:** fix transformIgnorePatterns ([0548d34][43])
123+
- **jest:** transpile node\_modules ([5cf7a6c][44])
124+
- **tsconfig:** fix internal path resolution ([fbe3a69][45])
125+
- **tsconfig:** upgrade to NodeNext ([d3a499e][46])
116126

117127
[1]: https://conventionalcommits.org
118128
[2]: https://semver.org
119-
[3]: https://github.com/Xunnamius/black-flag/compare/v1.2.5...v1.2.6
120-
[4]: https://github.com/Xunnamius/black-flag/commit/35f66cc9d69f8434d03db49f067b4f7e03d4c58c
121-
[5]: https://github.com/Xunnamius/black-flag/compare/v1.2.4...v1.2.5
122-
[6]: https://github.com/Xunnamius/black-flag/commit/c201c2ff87c1119b9678e38acdc12918d2ed7fc2
123-
[7]: https://github.com/Xunnamius/black-flag/commit/98815d1ef218af56e07493a921c66294f91101cf
124-
[8]: https://github.com/Xunnamius/black-flag/compare/v1.2.3...v1.2.4
125-
[9]: https://github.com/Xunnamius/black-flag/commit/d6618d370bd9a7264dad240856dc989a61071986
126-
[10]: https://github.com/Xunnamius/black-flag/compare/v1.2.2...v1.2.3
127-
[11]: https://github.com/Xunnamius/black-flag/commit/4b8c9759bc09f9b07593ce89446d4ec0e614db71
128-
[12]: https://github.com/Xunnamius/black-flag/commit/4babf12308b7aab0ed319077701eb6f3a1fdf1d3
129-
[13]: https://github.com/Xunnamius/black-flag/compare/v1.2.1...v1.2.2
130-
[14]: https://github.com/Xunnamius/black-flag/commit/be2960a507c43b3db598157de4dcafe22ee8906e
131-
[15]: https://github.com/Xunnamius/black-flag/commit/75d5c66bcce8f0c2c139962f7ddd28aa0c9499d7
132-
[16]: https://github.com/Xunnamius/black-flag/commit/8bb025436d219c024a5d4a4a0ac59999440b7c13
133-
[17]: https://github.com/Xunnamius/black-flag/compare/v1.2.0...v1.2.1
134-
[18]: https://github.com/Xunnamius/black-flag/commit/2369534f63aa3858714bb81505d3fff4ed77c6b1
135-
[19]: https://github.com/Xunnamius/black-flag/compare/v1.1.4...v1.2.0
136-
[20]: https://github.com/Xunnamius/black-flag/commit/b5a1e58add31902fd9ec80b93dd37305b8fd0684
137-
[21]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4
138-
[22]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824
139-
[23]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3
140-
[24]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53
141-
[25]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8
142-
[26]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2
143-
[27]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271
144-
[28]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1
145-
[29]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c
146-
[30]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0
147-
[31]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98
148-
[32]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea
149-
[33]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8
150-
[34]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0
151-
[35]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842
152-
[36]: https://github.com/black-
153-
[37]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d
154-
[38]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87
155-
[39]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff
156-
[40]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72
157-
[41]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17
158-
[42]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f
159-
[43]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f
129+
[3]: https://github.com/Xunnamius/black-flag/compare/v1.2.6...v1.2.7
130+
[4]: https://github.com/Xunnamius/black-flag/commit/cdc6af55387aac92b7d9fc16a57790068e4b6d49
131+
[5]: https://github.com/Xunnamius/black-flag/commit/6e7a268bebe71f19120fd926b004f3cb9e490760
132+
[6]: https://github.com/Xunnamius/black-flag/compare/v1.2.5...v1.2.6
133+
[7]: https://github.com/Xunnamius/black-flag/commit/35f66cc9d69f8434d03db49f067b4f7e03d4c58c
134+
[8]: https://github.com/Xunnamius/black-flag/compare/v1.2.4...v1.2.5
135+
[9]: https://github.com/Xunnamius/black-flag/commit/c201c2ff87c1119b9678e38acdc12918d2ed7fc2
136+
[10]: https://github.com/Xunnamius/black-flag/commit/98815d1ef218af56e07493a921c66294f91101cf
137+
[11]: https://github.com/Xunnamius/black-flag/compare/v1.2.3...v1.2.4
138+
[12]: https://github.com/Xunnamius/black-flag/commit/d6618d370bd9a7264dad240856dc989a61071986
139+
[13]: https://github.com/Xunnamius/black-flag/compare/v1.2.2...v1.2.3
140+
[14]: https://github.com/Xunnamius/black-flag/commit/4b8c9759bc09f9b07593ce89446d4ec0e614db71
141+
[15]: https://github.com/Xunnamius/black-flag/commit/4babf12308b7aab0ed319077701eb6f3a1fdf1d3
142+
[16]: https://github.com/Xunnamius/black-flag/compare/v1.2.1...v1.2.2
143+
[17]: https://github.com/Xunnamius/black-flag/commit/be2960a507c43b3db598157de4dcafe22ee8906e
144+
[18]: https://github.com/Xunnamius/black-flag/commit/75d5c66bcce8f0c2c139962f7ddd28aa0c9499d7
145+
[19]: https://github.com/Xunnamius/black-flag/commit/8bb025436d219c024a5d4a4a0ac59999440b7c13
146+
[20]: https://github.com/Xunnamius/black-flag/compare/v1.2.0...v1.2.1
147+
[21]: https://github.com/Xunnamius/black-flag/commit/2369534f63aa3858714bb81505d3fff4ed77c6b1
148+
[22]: https://github.com/Xunnamius/black-flag/compare/v1.1.4...v1.2.0
149+
[23]: https://github.com/Xunnamius/black-flag/commit/b5a1e58add31902fd9ec80b93dd37305b8fd0684
150+
[24]: https://github.com/Xunnamius/black-flag/compare/v1.1.3...v1.1.4
151+
[25]: https://github.com/Xunnamius/black-flag/commit/f66599bfdbb70ada6ec662e0d220a0a2e7047824
152+
[26]: https://github.com/Xunnamius/black-flag/compare/v1.1.2...v1.1.3
153+
[27]: https://github.com/Xunnamius/black-flag/commit/bad391da3019a5743a76ca2e510903f34c84ca53
154+
[28]: https://github.com/Xunnamius/black-flag/commit/2f205c1e8c94d3e6683816e5bbc3ae152e3c83e8
155+
[29]: https://github.com/Xunnamius/black-flag/compare/v1.1.1...v1.1.2
156+
[30]: https://github.com/Xunnamius/black-flag/commit/f79c11476de47bee3fa01e139269393b604b4271
157+
[31]: https://github.com/Xunnamius/black-flag/compare/v1.1.0...v1.1.1
158+
[32]: https://github.com/Xunnamius/black-flag/commit/b6178c9670a95084bca34424e71498f2d29ac48c
159+
[33]: https://github.com/Xunnamius/black-flag/compare/v1.0.0...v1.1.0
160+
[34]: https://github.com/Xunnamius/black-flag/commit/0e5067e2b0913a19bdc6975b50b272bb5872ba98
161+
[35]: https://github.com/Xunnamius/black-flag/commit/4f159dc4b84223dd6b07456c0b50da16d2816bea
162+
[36]: https://github.com/Xunnamius/black-flag/commit/5470091e385ca344e12a280ff95be793742874b8
163+
[37]: https://github.com/Xunnamius/black-flag/compare/d3a499e7aeddf23d392479b2cf99cc98bce8226f...v1.0.0
164+
[38]: https://github.com/Xunnamius/black-flag/commit/78bf8ffb0a6931fb3b131c42ce4b84146bfec842
165+
[39]: https://github.com/black-
166+
[40]: https://github.com/Xunnamius/black-flag/commit/292ead5aa3f18c556d72d714830dcf07b9253e6d
167+
[41]: https://github.com/Xunnamius/black-flag/commit/036e3506edc863da86372163c91dd650d6ac1e87
168+
[42]: https://github.com/Xunnamius/black-flag/commit/c7f4aef48366dc13685fb9805086be52d3561eff
169+
[43]: https://github.com/Xunnamius/black-flag/commit/0548d34f559c3b8ba6d9514f1586aeeb3b382f72
170+
[44]: https://github.com/Xunnamius/black-flag/commit/5cf7a6c79bba3125ce47838e5cfd24a1a08bbd17
171+
[45]: https://github.com/Xunnamius/black-flag/commit/fbe3a699a9063ed7da08311a22fe798672583b0f
172+
[46]: https://github.com/Xunnamius/black-flag/commit/d3a499e7aeddf23d392479b2cf99cc98bce8226f

docs/index/classes/CliError.md

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ other context.
4747

4848
`AppError.constructor`
4949

50-
#### Source
50+
#### Defined in
5151

52-
[src/error.ts:101](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L101)
52+
[src/error.ts:101](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L101)
5353

5454
### new CliError()
5555

@@ -76,19 +76,19 @@ via `super`.
7676

7777
`AppError.constructor`
7878

79-
#### Source
79+
#### Defined in
8080

81-
[src/error.ts:106](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L106)
81+
[src/error.ts:106](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L106)
8282

8383
## Properties
8484

8585
### \[$type\]
8686

8787
> **\[$type\]**: `string`[]
8888
89-
#### Source
89+
#### Defined in
9090

91-
[src/error.ts:96](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L96)
91+
[src/error.ts:96](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L96)
9292

9393
***
9494

@@ -100,7 +100,7 @@ via `super`.
100100

101101
`AppError.cause`
102102

103-
#### Source
103+
#### Defined in
104104

105105
node\_modules/typescript/lib/lib.es2022.error.d.ts:24
106106

@@ -114,7 +114,7 @@ node\_modules/typescript/lib/lib.es2022.error.d.ts:24
114114

115115
`AppError.message`
116116

117-
#### Source
117+
#### Defined in
118118

119119
node\_modules/typescript/lib/lib.es5.d.ts:1077
120120

@@ -128,7 +128,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1077
128128

129129
`AppError.name`
130130

131-
#### Source
131+
#### Defined in
132132

133133
node\_modules/typescript/lib/lib.es5.d.ts:1076
134134

@@ -138,13 +138,23 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076
138138

139139
> **showHelp**: `boolean` = `false`
140140
141+
If `true`, help text will be sent to stderr _before this exception finishes
142+
bubbling_. Where the exception is thrown will determine which instance is
143+
responsible for error text generation.
144+
145+
#### Default
146+
147+
```ts
148+
false
149+
```
150+
141151
#### Implementation of
142152

143153
`NonNullable.showHelp`
144154

145-
#### Source
155+
#### Defined in
146156

147-
[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L94)
157+
[src/error.ts:94](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L94)
148158

149159
***
150160

@@ -156,7 +166,7 @@ node\_modules/typescript/lib/lib.es5.d.ts:1076
156166

157167
`AppError.stack`
158168

159-
#### Source
169+
#### Defined in
160170

161171
node\_modules/typescript/lib/lib.es5.d.ts:1078
162172

@@ -166,13 +176,22 @@ node\_modules/typescript/lib/lib.es5.d.ts:1078
166176

167177
> **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError`
168178
179+
The exit code that will be returned when the application exits, given
180+
nothing else goes wrong in the interim.
181+
182+
#### Default
183+
184+
```ts
185+
FrameworkExitCode.DefaultError
186+
```
187+
169188
#### Implementation of
170189

171190
`NonNullable.suggestedExitCode`
172191

173-
#### Source
192+
#### Defined in
174193

175-
[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/35f66cc9d69f8434d03db49f067b4f7e03d4c58c/src/error.ts#L93)
194+
[src/error.ts:93](https://github.com/Xunnamius/black-flag/blob/cdc6af55387aac92b7d9fc16a57790068e4b6d49/src/error.ts#L93)
176195

177196
***
178197

@@ -200,7 +219,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
200219

201220
`AppError.prepareStackTrace`
202221

203-
#### Source
222+
#### Defined in
204223

205224
node\_modules/@types/node/globals.d.ts:28
206225

@@ -214,7 +233,7 @@ node\_modules/@types/node/globals.d.ts:28
214233

215234
`AppError.stackTraceLimit`
216235

217-
#### Source
236+
#### Defined in
218237

219238
node\_modules/@types/node/globals.d.ts:30
220239

@@ -240,6 +259,6 @@ Create .stack property on a target object
240259

241260
`AppError.captureStackTrace`
242261

243-
#### Source
262+
#### Defined in
244263

245264
node\_modules/@types/node/globals.d.ts:21

0 commit comments

Comments
 (0)