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

NAME

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

DESCRIPTION

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