TheKevJames / coveralls-python / 29813910377

95%

master: 96%

Build Type

Pull #759

github

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:
finish/upload no longer advertise the report-building modifiers they ignore,
and the debug subcommand no longer accepts the verb flags it used to swallow.

Backwards compatibility is preserved: --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. Passing a
deprecated verb flag together with a subcommand, or more than one verb flag at
once, is now rejected rather than silently resolved by precedence. Usage
errors are rendered as a message plus exit code rather than a traceback.

Docs are updated to teach the subcommands, and CLI tests cover the new
surface, the deprecated aliases (warning plus identical dispatch), and the
guardrails.

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

Coverage Stats

153 of 164 branches covered (93.29%)

Branch coverage included in aggregate %.

92 of 94 new or added lines in 1 file covered. (97.87%)

2 existing lines in 1 file now uncovered.

539 of 567 relevant lines covered (95.06%)

4.75 hits per line