Support more lax changelog formats

[baronfel]

Is your feature request related to a problem? Please describe.

Fantomas' update to 0.3.0 ran into a bunch of rough edges with the new parser:

• It wants brackets around all version numbers (previously there were some versions in the change log that had brackets and some that didn't)
• It wants list entries to use '-' rather than '*'
• It doesn't like 'Miscellaneous' or 'Documentation' as section names
• It wants various uses of '#' to be escaped.
• It wants all releases to have at least one subsection heading (Changed/Fixed etc)
• The new changelog parser doesn't seem to like the nested lists here - it complains about there not being a dash at the start of the line - not sure what syntax needs to be used to keep that happy, whilst still rendering the child lists nicely in the Github formatted markdown view

We should

• allow the use of * for lists
• not require escaping #
• support section names that aren't explicitly called out in the KAC spec
• allow specifying no headings at all for a release (we could infer "changed" for this?)
• support nested lists

[baronfel]

Oof, we have virtually zero control over this behavior with the new parser. That's very unfortunate. Are there other parsers we could use, or expose some of the primitives from the one we currently use?

[Numpsy]

As it stands, it looks like the readme example at

KeepAChangelog/README.md

Line 38 in 784984a

## 1.0.0 - 2022-01-14

doesn't actually parse.

I haven't tried looking at if the parser could be tweaked to support things like alternate list characters or if there are other parsers available.

[MangelMaxime]

Here, we are encountering the issue that Ionide.KeepAChangelog respect the specs of KeepAChangelog, which is one of the issue which lead to the creation of EasyBuild.PackageReleaseNotes.Tasks (it is more permissive regarding the format)

For project that want to use Ionide.KeepAChangelog it means they need to fix the Changelog.md file to match with KeepAChangelog spec.

For Ionide.KeepAChangelog, we need to decide if we want to follow the spec or take inspiration from it.

[goswinr]

I think 0.3.0 fails even on the specs of https://keepachangelog.com/en/1.1.0/ . The links in the end don't parse.

[Numpsy]

I think 0.3.0 fails even on the specs of https://keepachangelog.com/en/1.1.0/ . The links in the end don't parse.

I notice that the changelog.md for keepachangelog itself - https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md - contains the same sort of entries containing (#1234) as the changelog for Fornax did which have now been changed, e.g.

- v1.1 Swedish translation (#590).

And the latest source for keepachangelogparser won't parse that either - its own UI test app won't parse the file - so if we assume that the changelog for keepachangelog is an example of a valid file as per the spec then maybe this is really a bug in keepachangelogparser rather than an issue over here? I'll ask about it over there.

[Numpsy]

The issue with # needing to be escaped should be fixed in the next release of keepachangelogparser - shuelsmeier/keepachangelogparser#195

[shuelsmeier]

Hi, I could integrate a non strict mode to support more lax changelog formats.

[shuelsmeier]

Hello, I have just released version 2.0.0, which incorporates most of your feature requests.