D-Pow / MockRequests / 205 / 1

100%

master: 100%

push

travis-ci

Replace tsd-jsdoc with typescript for better types.d.ts accuracy

tsd-jsdoc was relatively okay, but there were some minor issues with the resulting .d.ts declaration structures, comments, etc. that didn't produce the expected output (some of which may possibly have been caused by the jsdoc package itself, as it has some known bugs). Replacing tsd-jsdoc with direct typescript usage fixed all those issues and preserved the JSDocs so the user has IDE autocompletion.

TODO:

* Ensure resulting `docs/` dir is correctly generated.
    - May require removing or updating JSDoc tags' `@module` usage (uncertain if it's needed or not).
* Fix the src's index.js default export as it seems to not preserve documentation when using the default export. Some ideas:
    - Don't use named exports (requires checking if the functions can be spread in users' repos).
    - Try inlining the index.js/MockRequests.js into one types.d.ts output file.
    - Find a way to add `export as namespace "mock-requests";` to .d.ts output
* MockRequestsWebpackPlugin:
    - Add refs to imported webpack types.
    - Make the constructor JSDoc appear when calling `new MockRequestsWebpackPlugin()`.
    - Mark methods/fields as `@private`.

84 of 84 branches covered (100.0%)

Branch coverage included in aggregate %.

131 of 131 relevant lines covered (100.0%)

63.48 hits per line