tsd-extra-cli
v0.3.0
Published
Wrapper around tsd (TypeScript type definition checker) with extra CLI options.
Downloads
91
Readme
tsd-extra-cli
Wrapper around tsd (TypeScript type definition checker) that offsers some extra CLI options.
Installation
This library can be installed from the NPM package registry. Using NPM:
npm install --save-dev tsd-extra-cli
Or using Yarn:
yarn add -D tsd-extra-cli
Usage
See the documentation for tsd on how to write tests for your type definitions.
You can use the tsd-extra-cli
command as you would normally
use tsd
, i.e.
tsd-extra-cli [path]
Extra CLI options
In addition, tsd-extra-cli
offers the following CLI options:
--tests-only
: Only reports errors that come from the.test-d.ts(x)
files. In addition to those, tsd normally also reports TypeScript errors in the files loaded from the system under test. The--tests-only
option discards those. This can be useful in codebases where there are some known TypeScript errors that haven't been fixed yet, but you still want to enforce passing tsd tests.--report-checkstyle=<file>
: Writes a report in checkstyle format to<file>
. This can be useful to programmatically consume the results, e.g. on a CI server.
Versioning
This project adheres to Semantic Versioning.
Contributing
Contributions to this project are more than welcome.
License
This project is released under the MIT license.
Treeware
This package is Treeware. If you use it in production, then we'd appreciate it if you buy the world a tree to thank us for our work. By contributing to the Treeware forest you'll be creating employment for local families and restoring wildlife habitats.
Made with love, coffee and fun by the Moxio team from Delft, The Netherlands. Interested in joining our awesome team? Check out our vacancies (in Dutch).