This tool is very useful to be running for CI/CD documentation. We use gitlab and generate documentation using Gitlab Pages. We also run this tool in the CI environment prior to generating the docs, verifying that there are no spelling mistakes.
To better improve how we work with the spellchecker, I wanted some integration with Gitlab utilizing Junit reports. As such, this implements Junit reports.
It also implements JSON reports, but only because they are an easy win. Additional report types can come later if they are wanted.
Here is a screenshot of the junit report's output displaying in Gitlab:
Note: I don't work with Javascript at all for my day job, and so my familiarity with the proper way to implement things, or the best approaches/practices is pretty much non existent. As such, there are probably issues with the implementation of this, but it works.
As far as testing goes, the two types of reports implemented here are generated by JSON.stringify() and generated by another package, so I'm not entirely sure if reports are necessary besides "It generates them". But if you require tests I will see what I can do. It has been manually tested, and is currently in "production" for us now (It's in use in our CI system).
This tool is very useful to be running for CI/CD documentation. We use gitlab and generate documentation using Gitlab Pages. We also run this tool in the CI environment prior to generating the docs, verifying that there are no spelling mistakes.
To better improve how we work with the spellchecker, I wanted some integration with Gitlab utilizing Junit reports. As such, this implements Junit reports.
It also implements JSON reports, but only because they are an easy win. Additional report types can come later if they are wanted.
Here is a screenshot of the junit report's output displaying in Gitlab:
As far as testing goes, the two types of reports implemented here are generated by
JSON.stringify()
and generated by another package, so I'm not entirely sure if reports are necessary besides "It generates them". But if you require tests I will see what I can do. It has been manually tested, and is currently in "production" for us now (It's in use in our CI system).