Ignore HTML comments

[binyamin]

I have markdown comments in my changelog to remind me of the format. This module accidentally parses it as a release. I assume this behavior is unwanted.

[ungoldman]

I don't know of anything in any markdown specs called markdown comments, are you talking about HTML comments? Like <!-- your comment here -->?

If you can provide an example of the text that that's causing an issue for you that would be very helpful.

[binyamin]

I did mean HTML comments. I use them in markdown so often that I didn't realize that they weren't part of the specs.

[ungoldman]

If you can provide an example of the text that that's causing an issue for you that would be very helpful.

[binyamin]

https://raw.githubusercontent.com/GreenhouseTech/DevMe/master/CHANGELOG.md (relevant changelog)

[ungoldman]

Thank you! That makes the issue much clearer.

This parser currently has no support for ignoring single or multiline HTML comments -- ignoring single line comments would be fairly simple, while ignoring multiline comments would require a bit more thought.

You can see how the parser currently functions for handling lines in these places:

• https://github.com/ungoldman/changelog-parser/blob/main/index.js#L76
• https://github.com/ungoldman/changelog-parser/blob/main/index.js#L96
• https://github.com/ungoldman/changelog-parser/blob/main/index.js#L101-L163

This repository is largely in maintenance mode, but a pull request to add the required functionality would be welcome.