Scroll to navigation

DIFF-QUALITY(1) User Commands DIFF-QUALITY(1)

NAME

diff-quality - find diff lines with quality violations

DESCRIPTION

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

options:

show this help message and exit
Which code quality tool to use (checkstyle/checkstylex ml/cppcheck/eslint/findbugs/flake8/jshint/pmd/pycodest yle/pydocstyle/pyflakes/pylint)
Diff coverage HTML output
Diff coverage JSON output
Diff coverage Markdown output
Write CSS into an external file
Branch to compare
Options to be passed to the violations tool
Returns an error code if coverage or quality score is below this value
Ignores staged changes
Ignores unstaged changes
Include untracked files
Exclude files, more patterns supported
Files to include (glob pattern)
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
Only print errors and failures
The configuration file to use
The root path used to generate a report
February 2023 diff-quality 7.4.0