TheKevJames / coveralls-python / ff6674c3-a49c-41eb-bfc8-9d7ece5e0d76

96%

push

circleci

refactor(cli): consistent setting names across every interface (#756)

Give each setting one spelling across the interfaces on which it is exposed:
a setting foo_bar is --foo-bar (CLI), COVERALLS_FOO_BAR (env), and foo_bar
(config file / kwarg). Expose host/skip_ssl_verify/parallel as CLI flags and
add COVERALLS_RCFILE/COVERALLS_BASE_DIR/COVERALLS_SRC_DIR env vars so the
convention holds on the env interface too. Define the CLI once via shared
Annotated option specs with debug as a thin wrapper over a shared dispatch.

config_file was renamed to rcfile, kept as a deprecated (warned) alias. host
is the canonical name (matching COVERALLS_HOST/--host), but coveralls_host is
kept as a permanent, non-deprecated alias since it reads more clearly in a
.coveralls.yml. The deprecated CLI flags (--service/--basedir/--srcdir) still
work with a warning. Logging is configured before any deprecation warning
fires so the CLI and config-layer warnings share one handler.

Dropping --rcfile's literal '.coveragerc' default also changes coverage config
discovery (see changelog).

changelog:
Every setting now uses one consistent name on the interfaces where it is
available: a setting ``foo_bar`` is ``--foo-bar`` on the CLI,
``COVERALLS_FOO_BAR`` as an environment variable, and ``foo_bar`` in
``.coveralls.yml`` or as a ``Coveralls()`` keyword. ``--host``,
``--skip-ssl-verify`` and ``--parallel`` are now available as CLI flags, and
``COVERALLS_RCFILE``, ``COVERALLS_BASE_DIR`` and ``COVERALLS_SRC_DIR`` as
environment variables. The config key ``config_file`` was renamed to
``rcfile``, and the CLI flags ``--service``, ``--basedir`` and ``--srcdir`` to
``--service-name``, ``--base-dir`` and ``--src-dir``; the old spellings still
work but emit a deprecation warning and will be removed in a future release.
``coveralls_host`` and ``host`` are both permanently supported spellings of the
same setting.

``--rcfile`` now defaults to coverage.py's own config auto-discovery instead of
... (continued)

146 of 156 branches covered (93.59%)

Branch coverage included in aggregate %.

62 of 62 new or added lines in 3 files covered. (100.0%)

491 of 518 relevant lines covered (94.79%)

5.69 hits per line