TheKevJames / coveralls-python / 7d46365f-9d1c-4a25-886b-73ec2a384017

95%

master: 97%

Build Type

Pull #759

circleci

Committed by TheKevJames

Commit Message

feat(cli): promote finish/save/upload verbs to subcommands

The CLI mixed two kinds of thing in one flat namespace: verbs (mutually
exclusive modes selected by --finish/--output/--submit) and modifiers that
tune a verb. Modelling verbs as independent flags left no guardrails -- e.g.
the debug subcommand inherited the full flag set and would silently ignore
--output/--submit/--finish, and conflicting verbs resolved by an undocumented
precedence ladder rather than erroring.

Promote the verbs to first-class subcommands alongside the existing debug:

  coveralls              collect + submit (unchanged bare invocation)
  coveralls finish       parallel-finish webhook       (was --finish)
  coveralls save FILE    write report to a file        (was --output FILE)
  coveralls upload FILE  upload a pre-generated report (was --submit FILE)
  coveralls debug        build report, dump to stdout, don't send

Each command declares only the options it uses, so options are still given
after the command name (e.g. `coveralls debug --rcfile=x`) and inapplicable
flag/verb combinations become clean usage errors instead of silent no-ops.

Backwards compatibility: --finish, --output and --submit remain as hidden,
deprecated aliases on the default command that dispatch to the new subcommands
and emit a deprecation warning in the same style as the existing
rcfile/config_file and --service/--service-name deprecations. These aliases
dispatch identically to the old flat CLI, including applying --merge before
the action (a no-op for submit/finish payloads, but preserved for fidelity).
All the modifiers the old flat namespace accepted alongside --finish/--submit
(--service-name/--rcfile/--base-dir/--src-dir/...) are still accepted on the
default command, so existing pipelines are unaffected. Passing a deprecated
verb flag together with a subcommand, or more than one verb flag at once, is
now rejected rather than silently resolved. Usage errors are rendered as a
message plus exi... (continued)

Pull Request Pull Request #759: feat(cli): promote finish/save/upload verbs to subcommands

Coverage Stats

157 of 168 branches covered (93.45%)

Branch coverage included in aggregate %.

96 of 98 new or added lines in 1 file covered. (97.96%)

3 existing lines in 1 file now uncovered.

543 of 571 relevant lines covered (95.1%)

5.71 hits per line