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

NAME

6       diff-quality - manual page for diff-quality 7.3.2
7

DESCRIPTION

9       usage: diff-quality [-h] --violations TOOL [--html-report FILENAME]
10
11       [--json-report FILENAME] [--markdown-report FILENAME]
12              [--external-css-file  FILENAME] [--compare-branch BRANCH] [--op‐
13              tions [OPTIONS]] [--fail-under SCORE]  [--ignore-staged]  [--ig‐
14              nore-unstaged] [--include-untracked] [--exclude EXCLUDE [EXCLUDE
15              ...]]  [--include INCLUDE [INCLUDE ...]]  [--diff-range-notation
16              RANGE_NOTATION]  [--version] [--ignore-whitespace] [-q] [-c CON‐
17              FIG_FILE] [--report-root-path ROOT_PATH] [input_reports ...]
18
19       Automatically find diff lines with quality violations.
20
21   positional arguments:
22       input_reports
23              Which violations reports to use
24
25   options:
26       -h, --help
27              show this help message and exit
28
29       --violations TOOL
30              Which code quality tool to  use  (checkstyle/checkstylex  ml/cp‐
31              pcheck/eslint/findbugs/flake8/jshint/pmd/pycodest     yle/pydoc‐
32              style/pyflakes/pylint)
33
34       --html-report FILENAME
35              Diff coverage HTML output
36
37       --json-report FILENAME
38              Diff coverage JSON output
39
40       --markdown-report FILENAME
41              Diff coverage Markdown output
42
43       --external-css-file FILENAME
44              Write CSS into an external file
45
46       --compare-branch BRANCH
47              Branch to compare
48
49       --options [OPTIONS]
50              Options to be passed to the violations tool
51
52       --fail-under SCORE
53              Returns an error code if coverage or quality score is below this
54              value
55
56       --ignore-staged
57              Ignores staged changes
58
59       --ignore-unstaged
60              Ignores unstaged changes
61
62       --include-untracked
63              Include untracked files
64
65       --exclude EXCLUDE [EXCLUDE ...]
66              Exclude files, more patterns supported
67
68       --include INCLUDE [INCLUDE ...]
69              Files to include (glob pattern)
70
71       --diff-range-notation RANGE_NOTATION
72              Git diff range notation to use when comparing branches, defaults
73              to '...'
74
75       --version
76              show program's version number and exit
77
78       --ignore-whitespace
79              When getting a diff ignore any and all whitespace
80
81       -q, --quiet
82              Only print errors and failures
83
84       -c CONFIG_FILE, --config-file CONFIG_FILE
85              The configuration file to use
86
87       --report-root-path ROOT_PATH
88              The root path used to generate a report
89
90
91
92diff-quality 7.3.2                 July 2023                   DIFF-QUALITY(1)
Impressum