Comments (3)
not sure why this library only supports passing a file path
it's because that's what was needed when this was written 😄
I'm trying to parse a changelog I've fetched from GitHub instead of a file
that sounds fine, please feel free to open a PR adding text as an option
https://github.com/hypermodules/changelog-parser#options
from changelog-parser.
in the course of working on this I also discovered that some packages use the other heading style in their changelogs (e.g. Sinon):
7.3.2 / 2019-04-17
==================
* Update Lolex to bring in fix for sinonjs/lolex#232 (queueMicrotask warning)
7.3.1 / 2019-03-27
==================
* Fix security issues
* Update @sinonjs/samsam to v3.3.1
There's a lot of variation in dates too (Material UI uses Apr 29, 2019
style)
So I wrote some simple parsing code of my own for the time being, but I'll go ahead and PR the changes I started working on to this package
from changelog-parser.
Yes, there are a lot of different changelog flavors out there! This parser doesn't attempt to cover all of them, and mostly targets the standard provided by https://keepachangelog.com.
An exception was made in the past to cover a variation introduced by conventional-changelog
. A pull request was merged to make that generator more semantic and conformant to the standard, but its release has been stalled for some time.
As the primary maintainer of this small package, I currently have no intention of further modifying the parser to accept all possible variations. This package exists mainly to support a couple of release utilities (primarily gh-release
) (though I'm surprised to see changelog-parser
has about 5k more downloads per month than its parent package!).
Maintaining support for a wide variety of changelog variations that don't respect a basic standard is not something I can do in my limited spare time as an open source maintainer. If some enterprising person is willing to take that on and shows some ability to follow through long-term, I would welcome them :)
Alternately, if this is a strong requirement of yours for a project you're working on, you're welcome to fork this project and publish an alternative supporting more changelog formats. Best of luck, whichever path you choose!
from changelog-parser.
Related Issues (19)
- resources HOT 3
- use mdast to parse markdown? HOT 4
- Extract date into seperate key HOT 7
- move instance variables into function
- Library doesn't respect file changes HOT 1
- update parser to be compatible with standard-version HOT 4
- Update `README.md` example to include 'date' keys
- Add Promise support HOT 3
- Add parsed/sorted data to changelog entry objects HOT 9
- support for parsing a string HOT 2
- Inconsistent title and body across platforms HOT 9
- Ignore HTML comments HOT 5
- Cross-platform issues caused by different changelog line endings HOT 3
- Hi. I made changelog-parser-action HOT 2
- [feature request] write changelog HOT 1
- `[]` in changelog isn't parsed correctly HOT 1
- Long term plans and support HOT 8
- changelog-parser doesn't parse my changelog correctly HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from changelog-parser.