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

NAME

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

DESCRIPTION

9       usage: diff-quality [-h] --violations TOOL [--html-report FILENAME]
10
11       [--external-css-file FILENAME] [--compare-branch BRANCH]
12              [--options  [OPTIONS]]  [--fail-under  SCORE]  [--ignore-staged]
13              [--ignore-unstaged] [--exclude EXCLUDE  [EXCLUDE  ...]]   [--in‐
14              clude INCLUDE [INCLUDE ...]]  [--diff-range-notation RANGE_NOTA‐
15              TION] [--version] [--ignore-whitespace] [-q] [input_reports ...]
16
17       Automatically find diff lines with quality violations.
18
19   positional arguments:
20       input_reports
21              Which violations reports to use
22
23   options:
24       -h, --help
25              show this help message and exit
26
27       --violations TOOL
28              Which code quality tool to  use  (checkstyle/checkstylex  ml/cp‐
29              pcheck/eslint/findbugs/flake8/jshint/pmd/pycodest     yle/pydoc‐
30              style/pyflakes/pylint)
31
32       --html-report FILENAME
33              Diff coverage HTML output
34
35       --external-css-file FILENAME
36              Write CSS into an external file
37
38       --compare-branch BRANCH
39              Branch to compare
40
41       --options [OPTIONS]
42              Options to be passed to the violations tool
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       --include INCLUDE [INCLUDE ...]
58              Files to include (glob pattern)
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-quality 5.2.0                 July 2021                   DIFF-QUALITY(1)
Impressum