Skip to content

Commit 58660b0

Browse files
committed
Add a changelog
1 parent 7ac45d6 commit 58660b0

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CHANGELOG.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# CHANGELOG
2+
3+
<!--
4+
Add new items at the end of the relevant section under **Unreleased**.
5+
-->
6+
7+
This project follows semantic versioning. While still in major version `0`,
8+
source-stability is only guaranteed within minor versions (e.g. between
9+
`0.0.3` and `0.0.4`). If you want to guard against potentially source-breaking
10+
package updates, you can specify your package dependency using
11+
`.upToNextMinor(from: "0.0.1")` as the requirement.
12+
13+
## [Unreleased]
14+
15+
### Additions
16+
17+
- The `EX_USAGE` exit code is now used for validation errors.
18+
- The parser provides near-miss suggestions when a user provides an unknown
19+
option.
20+
- `ArgumentParser` now builds on Windows.
21+
- You can throw an `ExitCode` error to exit without printing any output.
22+
23+
### Fixes
24+
25+
- Cleaned up a wide variety of documentation typos and shortcomings.
26+
- Improved different kinds of error messages:
27+
- Duplicate exclusive flags now show the duplicated arguments.
28+
- Subcommand validation errors print the correct usage string.
29+
- In the help screen:
30+
- Removed the extra space before the default value for arguments without
31+
descriptions.
32+
- Removed the default value note when the default value is an empty string.
33+
- Default values are now shown for Boolean options.
34+
35+
## [0.0.1] - 2020-02-27
36+
37+
- `ArgumentParser` initial release.
38+
39+
40+
41+
42+
[Unreleased]: https://github.com/apple/swift-argument-parser/compare/0.0.1...HEAD
43+
[0.0.1]: https://github.com/apple/swift-argument-parser/releases/tag/0.0.1
44+

0 commit comments

Comments
 (0)