cliverage/README.md

1022 B

cliverage

go_package: git.xdrm.io/go/cliverage
author: xdrm-brackets

Command-line tool to highlight code coverage in the terminal.

Requirements

You need a recent system with golang installed.

It has not been tested under go 1.12.4

Installation

You need to fetch and install the package with :

go get git.xdrm.io/go/cliverage

It should create the executable cliverage into the folder $GOPATH/bin (or $GOBIN if set).

Usage

In order for the cliverage tool to run successfully, you need :

  • a path to your code's repository
  • the coverage file path (see this documentation)

Command usage :

cliverage <path-to-code> <coverage-file> <file-path>

Arguments :

  • <path-to-code> - path to where your code lives
  • coverage-file - path to the coverage file
  • <file-path> - path to a single file. You can use go package wildcards : ./... prints every file, ./a/b/... prints every file located into ./a/b.