test-reporter
test-reporter copied to clipboard
Finalize Usage
I went through all existing --help
and thought about what I'd like to see changed before we stabilize 1.0. I anticipate a pretty detailed ~~bikeshed~~ discussion to ensue, so I'm going to open a separate Issue per command. This one represents the top-level usage and is where we should discuss the sub-command description strings.
One of the broader changes is that this idea of the magic coverage/codeclimate.json
path goes away, which I think is a good sign. With the new proposed usage, commands will use stdin
/stdout
when they're not given flags to put data to, or read data from, a file.
Current help
Report information about tests to Code Climate
Usage:
cc-test-reporter [flags]
cc-test-reporter [command]
Available Commands:
after-build Locate, parse, and re-format supported coverage sources. Upload pre-formatted coverage payloads to Code Climate servers.
before-build To be run before a build
env Infer and output information about the environment the reporter is running in.
format-coverage Locate, parse, and re-format supported coverage sources.
help Help about any command
sum-coverage Combine (sum) multiple pre-formatted coverage payloads into one.
upload-coverage Upload pre-formatted coverage payloads to Code Climate servers.
Flags:
-d, --debug run in debug mode
-v, --version Show version information
Use "cc-test-reporter [command] --help" for more information about a command.
Proposed Changes
- One line of Usage
- Show
[command flags]
in Usage - Use consistent case
- Update
after-build
description - Update
before-build
description - Wrap long text at 80 columns
- Update final line to use
help
(even though the other way works too) and remove it from the Commands list.
Updated help
Report information about tests to Code Climate
Usage:
cc-test-reporter [flags] [command] [command flags]
Available Commands:
after-build Locate and upload information about a completed build to Code
Climate servers.
before-build Notify Code Climate that a build is starting.
env Infer and output information about the environment the
reporter is running in.
format-coverage Locate, parse, and re-format supported coverage sources.
sum-coverage Combine (sum) multiple pre-formatted coverage payloads into
one.
upload-coverage Upload pre-formatted coverage payloads to Code Climate
servers.
Flags:
-d, --debug Run in debug mode
-v, --version Show version information
Use "cc-test-reporter help [command]" for more information about a command.