Is there some tests available to check if a tool is valid to the spec?

[laedit]

I made a tool which can parse and format a semantic release notes and I wanted to verify if it respect the spec.

I have made some unit test with the syntax and examples available on the website, but is there any available tests to confirm if a tool respect the spec?

Also, is there a list of the tools using or promoting Semantic Release Notes?
If not it could be great to spread the word.

[avanderhoorn]

WOW!!! I've been meaning to do this forever but just never had the time to be able to get around to it. Looks amazing. As a thought, it would be interesting if people could have other formatters that you tool pickups/detects and could use - don't this that this is at all a priority, just an interesting thought. Also was the JS "parser" that I hacked together any help for you?

[laedit]

Absolutely, right now my tool is a simple port of your JS parser 😃
I plan to use Sprache later.

Right now my tool support a custom liquid template which allow to format the release notes as you want, I just need to make a doc.
Or did you have something else in mind?

[avanderhoorn]

Makes sense on all fronts. Had nothing specific in mind - having access to the providing custom liquid templates is probably enough for now and way more than what we currently have :D

[laedit]

If that's ok with you I want to propose a couple of PRs for this issue:

• one with a new page "tools" which list all semantic release notes tools (for now only GitReleaseNotes and SemanticReleaseNotesParser but if you know other I will add them)
• another one with:
  • a spec.txt which contains a list of examples of semantic release notes, including a title, an input, an expected result in JSON and an expected output in HTML for example:

An item must be a markdown list item
.
 - This is a release item +new
.
{
    items:
    [
        { summary: "This is a release item", categories: ["new"] }
    ]
}
.
<ul>
<li>{New} This is a release item</li>
</ul>
.

• a test page for the javascript parser based on the spec.txt page
• a refactoring of the javascript parser (still with regex for now) in order to make the future modification easier. I think to use TypeScript, since it is (at least for me) more understandable than pure javascript and it is supported by a bunch of editor (Atom, Sublime, Vim, Visual Studio...).

The spec.txt file will allow anyone to test his tool / parser / other.
This is based on the spec.txt of CommonMark.

[avanderhoorn]

+1 I agree on all fronts! Feel free to send in the PRs. I think we are making great progress on this.