gocovrpt

command module
v0.0.0-...-92b3af4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2023 License: MIT Imports: 1 Imported by: 0

README

GoCovRpt

A go coverage reporter.

Install

go install github.com/giocirque/gocovrpt

Uninstall

rm "$(command -v gocovrpt)"

Example

❯ 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)

Documentation

Overview

Copyright © 2023 Gio Palacino <gio@palacino.net> This file is part of CLI application gocovrpt.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL