Testing the doctool

[silverwind]

Both the JSON and HTML output of the doctool are currently untested while tests could have prevented these recent issues:

• The order of end tags of list after heading in HTML doc is wrong #5873
• Error found when generating JSON doc #5942

As a start, a test could include JSON.parse and possibly some lightweight HTML validation triggered by make test-doc / vcbuild test-doc.

[eljefedelrodeodeljefe]

Yeah, I am 100% +1 on this and started discussion here also nodejs/docs#93

[silverwind]

I wouldn't go all out with selenium and similar browser-based tools. Just some very basic validation with lightweight tools that can live inside the repo.

[eljefedelrodeodeljefe]

Yeah for this purpose here I agree. Maybe it's enough in general. At the time of opening the issue I didn't think that simple.
We could have the selenium stuff also, but outside of CI. Don't know how to proceed there, but starting with this here would be step in the same direction.

[firedfox]

Also +1 on this. I just made another PR #5966 about doc. Testing the doctool would surely help a lot to prevent bugs in future.

[iankronquist]

Hey, I'd like to take a look at this.