TheKevJames / coveralls-python / 29765844783

95%

master: 96%

Pull #756

github

refactor(cli): consistent setting names across every interface

Give each setting one spelling across the interfaces on which it is exposed.
Rename coveralls_host->host and config_file->rcfile, expose
host/skip_ssl_verify/parallel as CLI flags, and define the CLI once via shared
Annotated option specs with debug as a thin wrapper over a shared dispatch.
Old CLI flags and config keys keep working as deprecated aliases that emit 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. The
config keys ``coveralls_host`` and ``config_file`` were renamed to ``host`` and
``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.

``--rcfile`` now defaults to coverage.py's own config auto-discovery instead of
a hard-coded ``.coveragerc``. A project whose coverage settings live in
``pyproject.toml``, ``setup.cfg`` or ``tox.ini`` (with no ``.coveragerc``) is
now picked up automatically; pass ``--rcfile`` explicitly to force a file.

144 of 154 branches covered (93.51%)

Branch coverage included in aggregate %.

57 of 60 new or added lines in 3 files covered. (95.0%)

489 of 516 relevant lines covered (94.77%)

4.74 hits per line