Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
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:
[![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)
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.
FAQs
A CLI tool to check type coverage for typescript code
The npm package type-coverage receives a total of 49,636 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 1 open source maintainer 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
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.