Download the PHP package vdhicts/keepachangelog-parser without Composer
On this page you can find all versions of the php package vdhicts/keepachangelog-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vdhicts/keepachangelog-parser
More information about vdhicts/keepachangelog-parser
Files in vdhicts/keepachangelog-parser
Package keepachangelog-parser
Short Description Parser for the Keep A Changelog standard
License MIT
Homepage https://github.com/vdhicts/keepachangelog-parser
Informations about the package keepachangelog-parser
keepachangelog-parser
Parser for the Keep A Changelog standard.
Requirements
This package requires at least PHP 8.1 or newer.
Installation
You can install the package via composer:
composer require vdhicts/keepachangelog-parser
Usage
This package is intended to be easy to use.
Parsing the changelog
Using a different date format
The parser will parse the releases with the Y-m-d
format by default.
If you would like to use another format, you can just pass the format to the setDateFormat
function.
Accessing the changelog
The parser will return a Changelog
models, with contains a collection of Release
models. The Release
model
contains a collection of Section
models.
The changelog has several methods the retrieve information:
When all releases are retrieved, the newest will be the first and the unreleased will be the last one when present.
The release has several methods to get information about the release:
The section consists of a type (like Added, etc.) and an array of entries:
Tests
Unit tests are available in the tests
folder. Run with:
composer test
When you want a code coverage report which will be generated in the build/report
folder. Run with:
composer test-coverage
Contribution
Any contribution is welcome, but it should meet the PSR-12 standard and please create one pull request per feature/bug. In exchange, you will be credited as contributor on this page.
Security
If you discover any security related issues in this or other packages of Vdhicts, please email [email protected] instead of using the issue tracker.
Support
If you encounter a problem with this parser or has a question about it, feel free to open an issue on GitHub.
License
This package is open-sourced software licensed under the MIT license.
About Vdhicts
Vdhicts is the name of my personal company for which I work as freelancer. Vdhicts develops and implements IT solutions for businesses and educational institutions.
All versions of keepachangelog-parser with dependencies
illuminate/support Version ^9.0|^10.0|^11.0
laravel/pint Version ^1.7
league/commonmark Version ^2.2
symfony/css-selector Version ^6.0|^7.0
symfony/dom-crawler Version ^6.0|^7.0