@zokugun/extract-changelog
v0.1.1
Published
Extract specific changelog entries from your `CHANGELOG.md` by version number.
Readme
@zokugun/extract-changelog
Parse your CHANGELOG.md to list all available versions or pull specific entries based on version numbers. Clean, fast, and easy to integrate.
Features
- Version Extraction: Retrieve content for a specific version number.
- Full List Generation: Generate a complete list of all versions and entries.
- JSON Support: Export extracted data in structured JSON format.
- Custom File Paths: Specify any changelog file using the command line.
- Markdown Compatibility: Automatically parse standard Markdown header styles.
- CLI Tooling: Execute commands directly from your terminal or CI/CD pipeline.
Installation
npm add @zokugun/extract-changelogRequirements
- Node.js:
v18.20or higher - Modules: ECMAScript Modules (
ESM)
Quick Start
You can extract versions or list all entries directly from the terminal without writing code.
Extract a specific version:
# Extract notes for version 1.2.0 (defaults to ./CHANGELOG.md)
npx extract-changelog get 1.2.0
# Extract as JSON from a custom file path
npx extract-changelog get 1.2.0 --file ./docs/CHANGELOG.md --jsonList all versions:
# List all detected versions and their entries
npx extract-changelog listContributions
Contributions are most welcome. Please:
- Open issues and feature requests under the repository discussions.
- Follow the
CONTRIBUTING.md.
Donations
Support this project by becoming a financial contributor.
License
Copyright © 2026-present Baptiste Augrain
Licensed under the MIT license.
