type-coverage
Advanced tools
A CLI tool to check type coverage for typescript code
This tool will check type of all identifiers, the type coverage rate = the count of identifiers whose type is not any / the total count of identifiers, the higher, the better.
yarn global add type-coverage
run type-coverage
| name | type | description |
|---|---|---|
-p, --project | string? | tell the CLI 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? | strict mode |
--cache | boolean? | enable cache |
If the identifiers' type arguments exist and contain at least one any, like any[], ReadonlyArray<any>, Promise<any>, Foo<number, any>, it will be considered as any too
Also, future minor release may introduce stricter type check in this mode, which may lower the type coverage rate
save and reuse type check result of files that is unchanged and independent of changed files in .type-coverage directory, to improve speed
"typeCoverage": {
"atLeast": 99 // same as --at-least
},
Use type-coverage:ignore-next-line or type-coverage:ignore-line in comment(// or /* */) to ignore any in a line.
try {
// type-coverage:ignore-next-line
} catch (error) { // type-coverage:ignore-line
}
https://marketplace.visualstudio.com/items?itemName=york-yao.vscode-type-coverage
Use your own project url:
[](https://github.com/plantain-00/type-coverage)
export function lint(
project: string,
detail: boolean,
debug: boolean,
files?: string[],
oldProgram?: ts.Program,
strict = false,
enableCache = false
): Promise<{
correctCount: number
totalCount: number
anys: {
file: string
line: number
character: number
text: string
}[]
program: ts.Program
}>
Q: Does this count JavaScript files?
Yes, This package calls Typescript API, Typescript can parse Javascript file(with allowJs), then this package can too.
1.11.0 (2019-03-28)
FAQs
A CLI tool to check type coverage for typescript code
The npm package type-coverage receives a total of 44,474 weekly downloads. As such, type-coverage popularity was classified as popular.
We found that type-coverage demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.