Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vannadii/gocovrpt

A simple, yet powerful coverage reporter for go
https://github.com/vannadii/gocovrpt

coverage coverage-report go golang

Last synced: 7 days ago
JSON representation

A simple, yet powerful coverage reporter for go

Awesome Lists containing this project

README

        

# GoCovRpt

A `go` coverage reporter.

## Install

```sh
go install github.com/giocirque/gocovrpt
```

## Uninstall

```sh
rm "$(command -v gocovrpt)"
```

## Example

```text
❯ gocovrpt -h

gocovrpt is a CLI application that creates code coverage reports in multiple
formats like HTML, JSON, XML, TEXT, etc. with convenience options for generating
summaries, badges, and an isolated value useful in CI/CD control.

The input file MUST always be the last argument, and can support multiples separated by a space.

Usage:
gocovrpt [flags]

Examples:
$ gocovrpt -f html -l [full|summary] -o ./coverage -i ./.build/coverage.raw
$ gocovrpt -f badge -o ./coverage.svg -i ./.build/coverage.raw
$ gocovrpt -f value -o ./covered -i ./.build/coverage.raw

Flags:
-f, --format string Report format. Available formats: html, badge, value (default "html")
-h, --help help for gocovrpt
-i, --input stringArray One or more coverage.raw files to read from. (default [./.build/coverage.raw])
-l, --level string Report level. Available levels: full, summary (default "full")
-o, --output string Output file or directory. For badges, the default is ./.build/coverage.svg. (default "./.build/coverage")
-p, --project string The name of the project.
-s, --source string The directory containing the covered source files. (default $PWD)
```