Your company here ā€” click to reach over 10,000 unique daily visitors

diff-quality - Man Page

manual page for diff-quality 7.3.2


usage: diff-quality [-h] --violations TOOL [--html-report FILENAME]

[--json-report FILENAME] [--markdown-report FILENAME]

[--external-css-file FILENAME] [--compare-branch BRANCH] [--options [OPTIONS]] [--fail-under SCORE] [--ignore-staged] [--ignore-unstaged] [--include-untracked] [--exclude EXCLUDE [EXCLUDE ...]] [--include INCLUDE [INCLUDE ...]] [--diff-range-notation RANGE_NOTATION] [--version] [--ignore-whitespace] [-q] [-c CONFIG_FILE] [--report-root-path ROOT_PATH] [input_reports ...]

Automatically find diff lines with quality violations.

positional arguments


Which violations reports to use


-h, --help

show this help message and exit

--violations TOOL

Which code quality tool to use (checkstyle/checkstylex ml/cppcheck/eslint/findbugs/flake8/jshint/pmd/pycodest yle/pydocstyle/pyflakes/pylint)

--html-report FILENAME

Diff coverage HTML output

--json-report FILENAME

Diff coverage JSON output

--markdown-report FILENAME

Diff coverage Markdown output

--external-css-file FILENAME

Write CSS into an external file

--compare-branch BRANCH

Branch to compare

--options [OPTIONS]

Options to be passed to the violations tool

--fail-under SCORE

Returns an error code if coverage or quality score is below this value


Ignores staged changes


Ignores unstaged changes


Include untracked files

--exclude EXCLUDE [EXCLUDE ...]

Exclude files, more patterns supported

--include INCLUDE [INCLUDE ...]

Files to include (glob pattern)

--diff-range-notation RANGE_NOTATION

Git diff range notation to use when comparing branches, defaults to '...'


show program's version number and exit


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

--report-root-path ROOT_PATH

The root path used to generate a report


June 2024 diff-quality 7.3.2