diff-cover - Man Page
manual page for diff-cover 10.5.1
Description
usage: diff-cover [-h] [--format FORMAT] [--show-uncovered] [--show-covered]
[--expand-coverage-report] [--branch-coverage] [--external-css-file FILENAME] [--compare-branch BRANCH] [--fail-under SCORE] [--ignore-staged] [--ignore-unstaged] [--include-untracked] [--exclude EXCLUDE [EXCLUDE ...]] [--include INCLUDE [INCLUDE ...]] [--src-roots DIRECTORY [DIRECTORY ...]] [--diff-range-notation RANGE_NOTATION] [--version] [--ignore-whitespace] [-q] [-c CONFIG_FILE] [--diff-file DIFF_FILE] [--total-percent-float] coverage_files [coverage_files ...]
Automatically find diff lines that need test coverage.
positional arguments
- coverage_files
coverage report (XML or lcov.info)
options
- -h, --help
show this help message and exit
- --format FORMAT
Format to use
- --show-uncovered
Show uncovered lines on the console
- --show-covered
Also highlight covered diff lines (in green) in the HTML coverage report, in addition to the existing missing-line (red) highlighting.
- --expand-coverage-report
Append missing lines in coverage reports based on the hits of the previous line.
- --branch-coverage
Treat partially covered branches as uncovered. Requires a coverage report with branch coverage data (Cobertura branch="true" condition-coverage).
- --external-css-file FILENAME
Write CSS into an external file
- --compare-branch BRANCH
Branch to compare
- --fail-under SCORE
Returns an error code if coverage or quality score is below this value
- --ignore-staged
Ignores staged changes
- --ignore-unstaged
Ignores unstaged changes
- --include-untracked
Include untracked files
- --exclude EXCLUDE [EXCLUDE ...]
Exclude files, more patterns supported
- --include INCLUDE [INCLUDE ...]
Files to include (glob pattern)
- --src-roots DIRECTORY [DIRECTORY ...]
List of source directories (only for jacoco coverage reports)
- --diff-range-notation RANGE_NOTATION
Git diff range notation to use when comparing branches, defaults to '...'
- --version
show program's version number and exit
- --ignore-whitespace
When getting a diff ignore any and all whitespace
- -q, --quiet
Only print errors and failures
- -c, --config-file CONFIG_FILE
The configuration file to use
- --diff-file DIFF_FILE
The diff file to use
- --total-percent-float
Show total coverage/quality as a float rounded to 2 decimal places