Skip to content

Commit cac2ffe

Browse files
committed
docs: add CHANGELOG.md
1 parent 9980cd3 commit cac2ffe

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
6+
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
- `Local` field on `FlagMetadata` for granular flag inheritance control
13+
- Short flag aliases via `FlagMetadata.Short`
14+
- `ParseAndRun` convenience function
15+
16+
### Changed
17+
18+
- Enhance usage output with type hints, required markers, and zero-default suppression
19+
- Inline `xflag` package and improve `ParseToEnd`
20+
- Decompose `Parse` into focused helpers and fix edge cases
21+
- Update Go module path and references
22+
23+
### Fixed
24+
25+
- Default nil context to `context.Background` in `Run`
26+
27+
## [v0.3.0] - 2025-11-22
28+
29+
### Added
30+
31+
- Top-level `graceful` package for signal handling
32+
- Comprehensive edge case tests for CLI library
33+
34+
### Changed
35+
36+
- Use sync.Once to get module name from runtime
37+
- Improve panic location reporting
38+
39+
## [v0.2.1] - 2025-02-01
40+
41+
### Changed
42+
43+
- Update name regex to allow underscore and dash in command names
44+
45+
## [v0.2.0] - 2025-01-07
46+
47+
### Removed
48+
49+
- Remove `ParseAndRun` in favor of separate parse and run steps
50+
51+
## [v0.1.0] - 2025-01-06
52+
53+
### Added
54+
55+
- Initial release of the CLI library
56+
- Command tree with subcommands and flag parsing
57+
- `Path` method on `*Command` for full command path
58+
- Flag metadata with required flag support
59+
- Command name typo suggestions (Levenshtein distance)
60+
- Boolean flag handling
61+
- `textutil` and `suggest` helper packages
62+
- GitHub Actions CI
63+
64+
[Unreleased]: https://github.com/pressly/cli/compare/v0.3.0...HEAD
65+
[v0.3.0]: https://github.com/pressly/cli/compare/v0.2.1...v0.3.0
66+
[v0.2.1]: https://github.com/pressly/cli/compare/v0.2.0...v0.2.1
67+
[v0.2.0]: https://github.com/pressly/cli/compare/v0.1.0...v0.2.0
68+
[v0.1.0]: https://github.com/pressly/cli/releases/tag/v0.1.0

0 commit comments

Comments
 (0)