type-coverage

type-coverage

A CLI tool to check type coverage for typescript code

This tool will check type of all identifiers, the code coverage = the count of identifiers whose type is not any / the total count of identifiers, the higher, the better.

install

yarn global add type-coverage

usage

run type-coverage

arguments

name	type	description
-p, --project	string?	show where is the tsconfig.json
--detail	boolean?	show detail
--at-least	number?	fail if coverage rate < this value
--debug	boolean?	show debug info
--strict	boolean?	if the identifiers' type arguments exist and contain at least one any, like any[], ReadonlyArray<any>, Promise<any>, Foo<number, any>, is will considered as any too; also, future minor release may introduce stricter type check in this mode, which may lower the code coverage

config in package.json

  "typeCoverage": {
    "atLeast": 99 // same as --at-least
  },

vscode plugin

https://marketplace.visualstudio.com/items?itemName=york-yao.vscode-type-coverage

add dynamic badges of type coverage

Use your own project url:

[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fplantain-00%2Ftype-coverage%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/type-coverage)

FAQ

Q: Does this count JavaScript files?

Yes, This package calls Typescript API, Typescript can parse Javascript file(with allowJs), then this package can too.