At the moment, there is no available documentation for this testing framework. Even if it is xUnit based, there are a few JavaScript-specific and TypeScript-specific nuances that ought to be reported in an organized manner to make it actually useful to others. Also, this will lead to a more definite API and help me decide whether changing something will or will not break backward compatibility. This won't be an issue until v1.0, but the goal is to move as fast as possible toward that.
The docs should explain:
- how to install the package from npm
- how to setup a script in package.json to run the tests
- how to write tests (how the name of the file should be, write only one class that extends TestCase in it, export the extended class to allow runtests.js to execute the tests, how to name test methods, implement setUp() and tearDown(), use assertion methods...)
- how to use the runtests.js facility (i.e. the syntax for the arguments)
- what we consider public API, what not, and the basic rules to interpret our versions (i.e., a reference to Semantic Versioning)
I'll extend the list if more stuff comes to my mind.
Since writing docs is time consuming, I'll do this when I'll judge the API to be more or less stable, and it will lead to v1.0. Also, I expect to break down this issue in smaller ones.
At the moment, there is no available documentation for this testing framework. Even if it is xUnit based, there are a few JavaScript-specific and TypeScript-specific nuances that ought to be reported in an organized manner to make it actually useful to others. Also, this will lead to a more definite API and help me decide whether changing something will or will not break backward compatibility. This won't be an issue until v1.0, but the goal is to move as fast as possible toward that.
The docs should explain:
I'll extend the list if more stuff comes to my mind.
Since writing docs is time consuming, I'll do this when I'll judge the API to be more or less stable, and it will lead to v1.0. Also, I expect to break down this issue in smaller ones.