Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 243 Commits
.github		.github
.vscode		.vscode
__mocks__		__mocks__
assets		assets
docs		docs
images		images
src		src
.all-contributorsrc		.all-contributorsrc
.editorconfig		.editorconfig
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.grenrc.js		.grenrc.js
.npmignore		.npmignore
.prettierrc.js		.prettierrc.js
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
babel.config.js		babel.config.js
commitlint.config.js		commitlint.config.js
jest.config.js		jest.config.js
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Repository files navigation

TypeScript Coverage Report

Node command line tool for generating TypeScript coverage reports ✨

Overview

This package fills the gap of a missing type coverage reporting tool which is present in the Flow ecosystem, strongly inspired by the amazing work done byflow-coverage-report and using data generated bytype-coverage.

See an example of the coverage report.

Background

To learn more about the reasoning behind this project and its roadmap, please refer to the following article:How I built a TS coverage report tool

Install

typescript-coverage-report can be installed locally or globally.

Users are advised to install it as a project(dev) dependency and create a script inpackage.json.

$ yarn add --dev typescript-coverage-report# OR$ npm install --save-dev typescript-coverage-report

Usage

If installed locally, add the following to thescripts section ofpackage.json.

"scripts": {"ts-coverage":"typescript-coverage-report"}

Then run:

$ yarn ts-coverage# OR$ npm run ts-coverage

To set the minimum threshold(80% by default), use the--threshold option.

$ yarn ts-coverage --threshold=99

As an alternative, options may be provided through thetype-coverageconfiguration, specified inpackage.json.

"typeCoverage": {"atLeast":90}

Options

The CLI accepts a list of arguments:

Option	Description	Default value
`-t, --threshold [number]`	The minimum percentage of coverage required.	80
`-o, --outputDir [string]`	The output directory where to generate the report.	coverage-ts
`-s, --strict [boolean]`	Run the check in strict mode.	false
`-d, --debug [boolean]`	Show debug information.	false
`-c, --cache [boolean]`	Save and reuse type check result from cache.	false
`-p, --project [string]`	File path to tsconfig file, eg: --project "./app/tsconfig.app.json"	.
`-i, --ignore-files [boolean]`	Ignore specified files, eg: --ignore-files "demo1/*.ts" --ignore-files "demo2/foo.ts"	false
`-u, --ignore-unread [boolean]`	Allow writes to variables with implicit any types	false

Maintainers

@alexcanessa

Contributing

Feel free to dive in!Open an issue or submit PRs.

On this project we follow theContributor Covenant Code of Conduct.

Developing

Thanks for contributing!

Remember to run the following commands to link your version of this package and build the TypeScript files.

# Link the package globally, so you'll be able to test it in other projects.$ yarn link# Builds the TypeScript files and watches for changes$ yarn build --watch

Commit messages

This project follows theAngular commit messages, but it's very open to emojis 🤯.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{David Tsai} 📖🐛	_{Alexis Tyler} 🐛	_{Dan Vanderkam} 💻	_{Daniel Edholm Ignat} 💻	_{Kyℓe Hensel} 💻	_{Danilo Cabello} 💻	_{Sanjay Guruprasad} 🐛
_{Luis Helder} 🐛	_{Tom Ardern} 🐛💻	_lroskoshin 💻	_{Max Burmagin} 💻	_{Alexander Skvortsov} 💻	_{Adi Cucolaș} 💻	_{Stanislav Golyshev} 💻
_roikoren755 💻	_jinphic 💻	_{Brandon Barker} 💻	_{Stanyslas Bres} 💻