test-reporter icon indicating copy to clipboard operation
test-reporter copied to clipboard

format-coverage Usage

Open pbrisbin opened this issue 7 years ago • 1 comments

Current help

Locate, parse, and re-format supported coverage sources.

Usage:
  cc-test-reporter format-coverage [flags]

Flags:
  -t, --input-type string   type of input source to use [simplecov, lcov, coverage.py, clover, gocov]
  -o, --output string       output path (default "coverage/codeclimate.json")
  -p, --prefix string       the root directory where the coverage analysis was performed (default "/home/patrick")

Global Flags:
  -d, --debug   run in debug mode

Proposed Changes:

  • Don't show Global Flags
  • Use consistent case
  • Always require --input-type
  • Change --input-type description (slightly)
  • Change --prefix description (slightly)
  • Accept path as arg, Default to stdin if missing
  • Default to stdout if --output not given
  • Can we get the text wrapping?

Updated help

Locate, parse, and re-format supported coverage sources.

Usage:
  cc-test-reporter format-coverage [flags] [path]

Flags:
  -t, --input-type string   Type of input source [simplecov, lcov, coverage.py,
                            clover, gocov]
  -o, --output string       Output path (default stdout)
  -p, --prefix string       Root directory where the coverage analysis was
                            performed (default "/home/patrick")

pbrisbin avatar May 19 '17 12:05 pbrisbin

This moves inference of type/path out of format-coverage and to after-build exclusively. I think this is overall simpler. So far, folks using format-coverage directly often need to (and I think are always OK with having to) pass the type/path explicitly.

If we're good with that, I'll go back and propose an update to the description to drop the "Locate, " part.

pbrisbin avatar May 19 '17 13:05 pbrisbin