Skip to content

Commit ff2706b

Browse files
c4sparc4spar
committed
docs(changelog): v1.0.0-rc.1
1 parent 01e5fd8 commit ff2706b

File tree

1 file changed

+236
-0
lines changed

1 file changed

+236
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,239 @@
1+
# [v1.0.0-rc.1](https://github.com/c4spar/deno-cliffy/compare/v0.25.7...v1.0.0-rc.1) (Jul 2, 2023)
2+
3+
### BREAKING CHANGES
4+
5+
- **ansi:** rename `.toBuffer()` method to `.bytes()` (#606)
6+
([853c2a6](https://github.com/c4spar/deno-cliffy/commit/853c2a6))
7+
- **ansi:** rename `stdin` and `stdout` options to `reader` and `writer` (#570)
8+
([8980c53](https://github.com/c4spar/deno-cliffy/commit/8980c53))
9+
- **flags:** remove `requiredValue` option and rename
10+
`option.args[].optionalValue` to `option.args[].optional` (#496)
11+
([f381e56](https://github.com/c4spar/deno-cliffy/commit/f381e56))
12+
13+
before:
14+
15+
```ts
16+
parseFlags(Deno.args, {
17+
flags: [{
18+
name: "foo",
19+
type: "boolean",
20+
requiredValue: true,
21+
}, {
22+
name: "bar",
23+
args: [{
24+
type: "string",
25+
optionalValue: true,
26+
}],
27+
}],
28+
});
29+
```
30+
31+
after:
32+
33+
```ts
34+
parseFlags(Deno.args, {
35+
flags: [{
36+
name: "foo",
37+
type: "boolean",
38+
optionalValue: false,
39+
}, {
40+
name: "bar",
41+
args: [{
42+
type: "string",
43+
optional: true,
44+
}],
45+
}],
46+
});
47+
```
48+
49+
- **prompt:** remove default indentation (#495)
50+
([16790ac](https://github.com/c4spar/deno-cliffy/commit/16790ac))
51+
52+
To restore the old behavior, you can use the indent option:
53+
54+
```ts
55+
await Input.prompt({
56+
message: "What's your name?",
57+
indent: " ",
58+
});
59+
```
60+
61+
### DEPRECATIONS
62+
63+
- **prompt:** deprecate `SelectValueOptions` and `CheckboxValueOptions` types
64+
(#526) ([20ba587](https://github.com/c4spar/deno-cliffy/commit/20ba587))
65+
66+
- `SelectValueOptions` -> Use `Array<string | SelectOption>` instead.
67+
- `CheckboxValueOptions` -> Use `Array<string | CheckboxOption>` instead.
68+
- **table:** refactor table types (#559)
69+
([2b1ea19](https://github.com/c4spar/deno-cliffy/commit/2b1ea19))
70+
71+
- `IBorder` -> Use `Border` instead.
72+
- `ICell` -> Use `CellType` instead.
73+
- `IRow` -> Use `RowType` instead.
74+
- `IDataRow` -> Use `DataRow` instead.
75+
- `IBorderOptions` -> Use `BorderOptions` instead.
76+
- `ITable` -> Use `TableType` instead.
77+
78+
### Features
79+
80+
- **ansi:** add `.toArray()` method to `ansi` module (#543)
81+
([ca2e7f6](https://github.com/c4spar/deno-cliffy/commit/ca2e7f6))
82+
- **command:** show required options in help usage (#598)
83+
([bd08f4b](https://github.com/c4spar/deno-cliffy/commit/bd08f4b))
84+
- **command:** add `--name` option to completion commands (#587)
85+
([f9368eb](https://github.com/c4spar/deno-cliffy/commit/f9368eb))
86+
- **command:** add `reader` & `writer` options to `prompt()` function (#574)
87+
([72536ea](https://github.com/c4spar/deno-cliffy/commit/72536ea))
88+
- **command:** support multiple option actions (#567)
89+
([4fb4f9a](https://github.com/c4spar/deno-cliffy/commit/4fb4f9a))
90+
- **command:** add `.globalAction()` method (#555)
91+
([b76524f](https://github.com/c4spar/deno-cliffy/commit/b76524f))
92+
- **prompt:** add format option to select and checkbox prompt (#626)
93+
([5b8bc2d](https://github.com/c4spar/deno-cliffy/commit/5b8bc2d))
94+
- **prompt:** allow any type as value for select and checkbox prompt (#625)
95+
([20b59ec](https://github.com/c4spar/deno-cliffy/commit/20b59ec))
96+
- **prompt:** add support for multi level options for select and checkbox prompt
97+
(#445) ([880d472](https://github.com/c4spar/deno-cliffy/commit/880d472))
98+
- **prompt:** refactor and export un-exported `prompt()` types and update docs
99+
(#578) ([9487d8d](https://github.com/c4spar/deno-cliffy/commit/9487d8d))
100+
- **prompt:** add `reader` and `writer` options (#569)
101+
([8923a6f](https://github.com/c4spar/deno-cliffy/commit/8923a6f))
102+
- **table:** implement `Column` class (#554)
103+
([738355a](https://github.com/c4spar/deno-cliffy/commit/738355a))
104+
- **table:** set default value for `.border()` method to `true` (#557)
105+
([a43d845](https://github.com/c4spar/deno-cliffy/commit/a43d845))
106+
- **testing:** add testing module (#581)
107+
([5db0f6e](https://github.com/c4spar/deno-cliffy/commit/5db0f6e),
108+
[36c8dbe](https://github.com/c4spar/deno-cliffy/commit/36c8dbe),
109+
[6a8ad25](https://github.com/c4spar/deno-cliffy/commit/6a8ad25),
110+
[d20d31c](https://github.com/c4spar/deno-cliffy/commit/d20d31c))
111+
112+
### Bug Fixes
113+
114+
- **ansi:** use `opts.stdin.setRaw` instead of `Deno.stdin.setRaw` in`tty`
115+
module and `getCursorPosition` method and fiy stdin option types (#564)
116+
([0bc4cca](https://github.com/c4spar/deno-cliffy/commit/0bc4cca))
117+
- **ansi:** color methods ignore an empty string argument (#558)
118+
([39eb048](https://github.com/c4spar/deno-cliffy/commit/39eb048))
119+
- **command:** use `Array<unknown>` for arguments in `.globalAction()` action
120+
handler (#607)
121+
([de75995](https://github.com/c4spar/deno-cliffy/commit/de75995))
122+
- **command:** global parent action handlers are executed if noGlobals is
123+
enabled (#603)
124+
([b7e34fa](https://github.com/c4spar/deno-cliffy/commit/b7e34fa))
125+
- **command:** enum type not always inferred correctly (#573)
126+
([31ba2ff](https://github.com/c4spar/deno-cliffy/commit/31ba2ff))
127+
- **command:** incorrect validation when parsing global options with default
128+
values mixed with non-global options (#548)
129+
([ddd3e53](https://github.com/c4spar/deno-cliffy/commit/ddd3e53))
130+
- **command:** error handler not triggered with `.useRawArgs()` enabled (#549)
131+
([ecdb98e](https://github.com/c4spar/deno-cliffy/commit/ecdb98e))
132+
- **flags:** `OptionType` is exported as type (#636)
133+
([45890b9](https://github.com/c4spar/deno-cliffy/commit/45890b9))
134+
- **flags:** default value for no-value-flag cannot be overridden (#551)
135+
([456eb41](https://github.com/c4spar/deno-cliffy/commit/456eb41))
136+
- **table:** more accurate cell width for unicode chars (#632)
137+
([d29dce4](https://github.com/c4spar/deno-cliffy/commit/d29dce4))
138+
- **table:** apply column options only to table body (#608)
139+
([a7db939](https://github.com/c4spar/deno-cliffy/commit/a7db939))
140+
- **table:** fix hasBodyBorder method (#560)
141+
([36d3d5d](https://github.com/c4spar/deno-cliffy/commit/36d3d5d))
142+
- **table:** full width characters are not aligned correctly (#542)
143+
([9fea2ac](https://github.com/c4spar/deno-cliffy/commit/9fea2ac))
144+
- **table:** japanese characters are not aligned correctly (#541)
145+
([44e48ea](https://github.com/c4spar/deno-cliffy/commit/44e48ea))
146+
147+
### Code Refactoring
148+
149+
- remove main mod.ts (#638)
150+
([7de3ddc](https://github.com/c4spar/deno-cliffy/commit/7de3ddc))
151+
- **ansi:** use explicit exports in mod.ts (#610)
152+
([7e7063a](https://github.com/c4spar/deno-cliffy/commit/7e7063a))
153+
- **command:** move checkVersion method to separate file (#623)
154+
([a7a2d10](https://github.com/c4spar/deno-cliffy/commit/a7a2d10))
155+
- **command:** remove indentation from help output (#605)
156+
([e9ab46a](https://github.com/c4spar/deno-cliffy/commit/e9ab46a))
157+
- **command:** re-organize types (#602)
158+
([277fb27](https://github.com/c4spar/deno-cliffy/commit/277fb27))
159+
- **command:** use exit code `2` as default for validation errors (#601)
160+
([6394f89](https://github.com/c4spar/deno-cliffy/commit/6394f89))
161+
- **command:** improve error message for duplicate option names (#600)
162+
([1ef9e68](https://github.com/c4spar/deno-cliffy/commit/1ef9e68))
163+
- **command:** throw an error if the command name is missing when generating
164+
shell completions (#599)
165+
([fa804b5](https://github.com/c4spar/deno-cliffy/commit/fa804b5))
166+
- **command:** switch to `Deno.Command` api (#596)
167+
([90d9565](https://github.com/c4spar/deno-cliffy/commit/90d9565))
168+
- **command:** set default value for ignore and only in snapshotTest method
169+
(#588) ([7f0ec49](https://github.com/c4spar/deno-cliffy/commit/7f0ec49))
170+
- **flags:** use explicit exports in mod.ts (#609)
171+
([dd857d7](https://github.com/c4spar/deno-cliffy/commit/dd857d7))
172+
- **keycode:** use explicit exports in mod.ts (#611)
173+
([eb4d7a0](https://github.com/c4spar/deno-cliffy/commit/eb4d7a0))
174+
- **prompt:** remove GenericPrompt, GenericInput & GenericList exports (#627)
175+
([19a19f4](https://github.com/c4spar/deno-cliffy/commit/19a19f4))
176+
- **prompt:** remove unnecessary border arguments (#617)
177+
([ca6c705](https://github.com/c4spar/deno-cliffy/commit/ca6c705))
178+
- **prompt:** remove `GenericInputPromptSettings` export from mod.ts (#614)
179+
([ad8be98](https://github.com/c4spar/deno-cliffy/commit/ad8be98))
180+
- **prompt:** use explicit exports in mod.ts (#612)
181+
([f5dead8](https://github.com/c4spar/deno-cliffy/commit/f5dead8))
182+
- **prompt:** change default search icon to 🔎 (#577)
183+
([52830a8](https://github.com/c4spar/deno-cliffy/commit/52830a8))
184+
- **prompt:** remove windows encoding workaround (#566)
185+
([11e379f](https://github.com/c4spar/deno-cliffy/commit/11e379f))
186+
- **prompt:** change default label of secret prompt from `Password` to `Secret`
187+
(#494) ([ed49579](https://github.com/c4spar/deno-cliffy/commit/ed49579))
188+
189+
### Chore
190+
191+
- fmt (#591) ([6950b5f](https://github.com/c4spar/deno-cliffy/commit/6950b5f))
192+
- remove all `--unstable` flags from tests and examples (#550)
193+
([b8bd612](https://github.com/c4spar/deno-cliffy/commit/b8bd612))
194+
- **ci:** refactor tests (#637)
195+
([0c950cf](https://github.com/c4spar/deno-cliffy/commit/0c950cf))
196+
- **ci:** adapt check examples step (#572)
197+
([95374cc](https://github.com/c4spar/deno-cliffy/commit/95374cc))
198+
- **ci:** enable doc tests (#556)
199+
([35f1329](https://github.com/c4spar/deno-cliffy/commit/35f1329))
200+
- **deno:** use top-level exclude option and fmt (#593)
201+
([184e2ee](https://github.com/c4spar/deno-cliffy/commit/184e2ee))
202+
- **license:** update copyright year
203+
([9918d43](https://github.com/c4spar/deno-cliffy/commit/9918d43))
204+
- **upgrade:** deno/std@0.192.0 (#639)
205+
([01e5fd8](https://github.com/c4spar/deno-cliffy/commit/01e5fd8))
206+
207+
### Unit/Integration Tests
208+
209+
- **prompt:** test also stderr in integration tests (#565)
210+
([6fa7ef5](https://github.com/c4spar/deno-cliffy/commit/6fa7ef5))
211+
- **prompt:** improve integration tests (#544)
212+
([986168f](https://github.com/c4spar/deno-cliffy/commit/986168f))
213+
214+
### Documentation Updates
215+
216+
- fix discussions link in `CONTRIBUTING.md` (#633)
217+
([d5d29d9](https://github.com/c4spar/deno-cliffy/commit/d5d29d9))
218+
- **ansi:** documentation improvements (#621)
219+
([2928a6f](https://github.com/c4spar/deno-cliffy/commit/2928a6f))
220+
- **ansi:** update examples (#571)
221+
([82af874](https://github.com/c4spar/deno-cliffy/commit/82af874))
222+
- **command:** documentation improvements (#622)
223+
([e8b7da5](https://github.com/c4spar/deno-cliffy/commit/e8b7da5))
224+
- **flags:** documentation improvements (#620)
225+
([46392b1](https://github.com/c4spar/deno-cliffy/commit/46392b1))
226+
- **keypress:** documentation improvements (#619)
227+
([385b483](https://github.com/c4spar/deno-cliffy/commit/385b483))
228+
- **keypress:** documentation improvements (#618)
229+
([2070858](https://github.com/c4spar/deno-cliffy/commit/2070858))
230+
- **prompt:** update select & checkbox docs (#628)
231+
([02949d6](https://github.com/c4spar/deno-cliffy/commit/02949d6))
232+
- **prompt:** documentation improvements (#616)
233+
([51dd46b](https://github.com/c4spar/deno-cliffy/commit/51dd46b))
234+
- **table:** documentation improvements (#615)
235+
([c67e441](https://github.com/c4spar/deno-cliffy/commit/c67e441))
236+
1237
# [v0.25.7](https://github.com/c4spar/deno-cliffy/compare/v0.25.6...v0.25.7) (Jan 5, 2023)
2238

3239
### Bug Fixes

0 commit comments

Comments
 (0)