plantain-00 / type-coverage

A CLI tool to check type coverage for typescript code
MIT License
1.26k stars 44 forks source link

Unclear documentation for CLI arguments #113

Open izi-p opened 2 years ago

izi-p commented 2 years ago

Hello,

Thanks for the tool which is pretty cool. 👍

yarn type-coverage --no-detail-when-failed does not work (detail is still displayed)

yarn type-coverage --no-detail-when-failed=true does work (detail is hidden)

This is not clear enough. It took me a bit to dig in the source code to understand it and I think the documentation is not clear enough on this point. 🥹

Thanks

plantain-00 commented 2 years ago

It seems upstream minimist's bug: https://github.com/substack/minimist/issues/123

plantain-00 commented 2 years ago

I updated the document.

deongroenewald commented 1 year ago

It seems like this is an intended feature of minimist rather than a bug: https://github.com/minimistjs/minimist/issues/38