lcov-total

Table of contents

- About
- Installation
- Usage
- Contributing
- License
- Contact
- Acknowledgements

About

> This module now uses ESM modules from v2.0.0, if you need to use CommonJS refer to v1.x.x

This simple package aim to parse lcov.info files and provide the total coverage Number without fancy formatting or anything else, either in stdout or programmatically.

Here's why:

- You need to assest coverage in your CI and fail below certain threshold
- you don't want to do unredable awk chains
- every other options outputs fancy colored output which is tediuous to parse and error prone

Installation

You can install locally

``sh
npm install lcov-total
`

You can install glocally

`sh
npm install -g lcov-total
`

Or use NPX

`sh
npx lcov-total
`

Usage

You can use lcov-total from command line providing lcov.info file location eg:

`sh
npx lcov-total lcov.info
# 100.00
`

If you pass the --gte=value flag you will get an exitCode 0 or 1 based on resulting coverage >= value expression, eg:

`sh
npx lcov-total lcov.info --gte=90
echo $?


0


`

Or programmatically

`js
import lcovTotal from "lcov-total";
lcovTotal("/path/to/lcov.info"); // this throws if any error
`

Contributing

Project is pretty simple and straight forward for what is my needs, but if you have any idea you're welcome.

This projects uses commitlint with Angular configuration so be sure to use standard commit format or PR won't be accepted.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat(scope): some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE` for more information.

Contact

Simone Corsi - @im_simonecorsi

Acknowledgements

- lcov parsing mega switch - from davglass