7 releases (4 breaking)
0.9.1 | Oct 25, 2023 |
---|---|
0.9.0 | Oct 24, 2023 |
0.8.1 | Oct 16, 2020 |
0.8.0 | Jul 28, 2020 |
0.5.0 | Feb 7, 2020 |
#1306 in Text processing
Used in cl
30KB
528 lines
clparse
clparse
is a command line tool for parsing CHANGELOG files that use the Keep
A Changelog format. The CHANGELOG file can be Markdown, JSON, or YAML format
and can also be output into any of those formats once parsed.
Installation
Homebrew (macOS)
$ brew install marcaddeo/clsuite/clparse
Linux
$ curl -LO https://github.com/marcaddeo/clparse/releases/download/0.9.1/clparse-0.9.1-x86_64-unknown-linux-musl.tar.gz
$ tar czvf clparse-0.9.1-x86_64-unknown-linux-musl.tar.gz
$ sudo mv clparse /usr/local/bin/clparse
Cargo
$ cargo install clparse
Usage
clparse 0.9.1
Marc Addeo <hi@marc.cx>
A command line tool for parsing CHANGELOG.md files that use the Keep A Changelog format.
USAGE:
clparse [FLAGS] [OPTIONS] <FILE>
FLAGS:
-h, --help Prints help information
-n, --no-wrap Disable wrapping of change entries of a release. By default, change entries are wrapped at 80
characters.
-V, --version Prints version information
OPTIONS:
-f, --format <format> Sets the output format of the parsed CHANGELOG [default: markdown] [possible values:
json, yaml, yml, markdown, md]
-s, --separator <separator> Sets the separator character used between version and date in a release heading
[default: -]
-w, --wrap-at <wrap-at> Specify how many characters to wrap change entries at [default: 80]
ARGS:
<FILE> The CHANGELOG file to parse. This should be either a Markdown, JSON, or Yaml representation of a
changelog. Use '-' to read from stdin.
Examples
By default, clparse
will parse the input file, and output the changelog in
markdown format.
$ clparse CHANGELOG.md
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Fixed
- Fix a bug that caused undefined behavior
## [1.0.0] - 2019-06-20
### Added
- Add a cool new feature
### Changed
- Change something that was notable
## [0.0.1] - 2019-05-31
### Added
- Add the initial features
We can transform the markdown into a format that can be easily used in scripts:
$ clparse -f json CHANGELOG.md
{
"title": "Changelog",
"description": "All notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n",
"releases": [
{
"version": null,
"link": "https://github.com/example/example/compare/v1.0.0...HEAD",
"date": null,
"changes": [
{
"fixed": "Fix a bug that caused undefined behavior"
}
],
"yanked": false
},
{
"version": "1.0.0",
"link": "https://github.com/example/example/compare/v0.0.1...v1.0.0",
"date": "2019-06-20",
"changes": [
{
"added": "Add a cool new feature"
},
{
"changed": "Change something that was notable"
}
],
"yanked": false
},
{
"version": "0.0.1",
"link": "https://github.com/example/example/releases/tag/v0.0.1",
"date": "2019-05-31",
"changes": [
{
"added": "Add the initial features"
}
],
"yanked": false
}
]
}
clparse
can also parse JSON and YAML representations of the changelog:
$ clparse CHANGELOG.json
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Fixed
- Fix a bug that caused undefined behavior
## [1.0.0] - 2019-06-20
### Added
- Add a cool new feature
### Changed
- Change something that was notable
## [0.0.1] - 2019-05-31
### Added
- Add the initial features
And finally, we can read from stdin by passing -
as the FILE
argument:
$ clparse -f json CHANGELOG.md | clparse -
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Fixed
- Fix a bug that caused undefined behavior
## [1.0.0] - 2019-06-20
### Added
- Add a cool new feature
### Changed
- Change something that was notable
## [0.0.1] - 2019-05-31
### Added
- Add the initial features
Dependencies
~9MB
~166K SLoC