1DIFF-COVER(1)                    User Commands                   DIFF-COVER(1)
2
3
4

NAME

6       diff-cover - manual page for diff-cover 6.5.0
7

DESCRIPTION

9       usage:  diff-cover  [-h]  [--html-report FILENAME] [--json-report FILE‐
10       NAME]
11
12              [--markdown-report   FILENAME]   [--show-uncovered]    [--exter‐
13              nal-css-file  FILENAME]  [--compare-branch BRANCH] [--fail-under
14              SCORE]  [--ignore-staged]   [--ignore-unstaged]   [--include-un‐
15              tracked]  [--exclude EXCLUDE [EXCLUDE ...]]  [--src-roots DIREC‐
16              TORY [DIRECTORY  ...]]   [--diff-range-notation  RANGE_NOTATION]
17              [--version]  [--ignore-whitespace]  [-q] [-c CONFIG_FILE] cover‐
18              age_xml [coverage_xml ...]
19
20       Automatically find diff lines that need test coverage.
21
22   positional arguments:
23       coverage_xml
24              XML coverage report
25
26   options:
27       -h, --help
28              show this help message and exit
29
30       --html-report FILENAME
31              Diff coverage HTML output
32
33       --json-report FILENAME
34              Diff coverage JSON output
35
36       --markdown-report FILENAME
37              Diff coverage Markdown output
38
39       --show-uncovered
40              Show uncovered lines on the console
41
42       --external-css-file FILENAME
43              Write CSS into an external file
44
45       --compare-branch BRANCH
46              Branch to compare
47
48       --fail-under SCORE
49              Returns an error code if coverage or quality score is below this
50              value
51
52       --ignore-staged
53              Ignores staged changes
54
55       --ignore-unstaged
56              Ignores unstaged changes
57
58       --include-untracked
59              Include untracked files
60
61       --exclude EXCLUDE [EXCLUDE ...]
62              Exclude files, more patterns supported
63
64       --src-roots DIRECTORY [DIRECTORY ...]
65              List of source directories (only for jacoco coverage reports)
66
67       --diff-range-notation RANGE_NOTATION
68              Git diff range notation to use when comparing branches, defaults
69              to '...'
70
71       --version
72              show program's version number and exit
73
74       --ignore-whitespace
75              When getting a diff ignore any and all whitespace
76
77       -q, --quiet
78              Only print errors and failures
79
80       -c CONFIG_FILE, --config-file CONFIG_FILE
81              The configuration file to use
82
83
84
85diff-cover 6.5.0                   July 2022                     DIFF-COVER(1)
Impressum