codecheck-type-coverage

Track missing type coverage in TypeScript projects to ensure type safety

Usage no npm install needed!

<script type="module">
  import codecheckTypeCoverage from 'https://cdn.skypack.dev/codecheck-type-coverage';
</script>

README

codechecks.io

Type Coverage Watcher

Track missing type coverage in TypeScript projects to ensure type safety

Build Status Software License

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