ungoldman / changelog-parser

🪵 Change log parser for node.
ISC License
75 stars 33 forks source link

changelog-parser doesn't parse my changelog correctly #53

Open farz4n3hhl opened 4 months ago

farz4n3hhl commented 4 months ago

My change is like this:

## [2.3.4]
### bugfix
- something 1
  - desc 1
  - desc 2
- something 2
  - desc 1
  - desc 2

But It is parsed like this:

## [2.3.4]
### bugfix
- something 1
- something 2

As you can see, it ignores subtitles and removes them!

jgravois commented 4 months ago

this library only attempts to parse the lines/entities described in https://keepachangelog.com and its own readme. the subtitles you mention being ignored could be considered 'by design'.

you could fork this code for your own use case but my own personal opinion is that you'd be better off attempting to describe individual changes in your own code using a single line of text.