codecheck-type-coverage
v0.0.5
Published
Track missing type coverage in TypeScript projects to ensure type safety
Downloads
10
Maintainers
Readme
Install
npm add --save-dev @codechecks/type-coverage-watcher
or
yarn add --dev @codechecks/type-coverage-watcher
Usage
Add to your codechecks.js
file:
import { typeCoverageWatcher } from "@codechecks/type-coverage-watcher";
export async function main() {
await typeCoverageWatcher();
// ...
}
API
typeCoverageWatcher(options: Options): Promise<void>
options
interface Options {
tsconfigPath?: string;
}
tsconfigPath
optional string
Default: tsconfig.json
Path to typescript project configuration
Contributing
All contributions are welcomed. Read more in CONTRIBUTING.md
Licence
MIT @ codechecks.io