lint-diffs is a simple command line tool for running a set of arbitrarty linters on a set of 'unified diffs'.
Errors on diff-lines will always be reported. Errors on non-diff lines can also be reported, depending on severity.
First you need some diffs, then you pipe it to lint-diffs:
git diff -U0 origin/master | lint-diffs
... or in mercurial: hg outgoing -p | lint-diffs
-
default linter configuration is on for pylint (.py), rubocop (.rb), and clang (.cpp, .hpp)
-
flake8, eslint and other linters need to be enabled (see below) explicitly.
lint-diffs will read a config files from ~/.config/lint-diffs and/or ./.lint-diffs.
Example:
[pylint]
always_report=E.*
[flake8]
extensions=.py
[rubocop]
extensions=.rb
always_report=(E.*|W.*)
[eslint]
extensions=.js
[shellcheck]
extensions=.shIn this example, a flake8 and pylint are run on every diff file ending in .py.
Additionally, ruby, eslint and shell script linters have been enabled. The
ruby linter has been modified to always report warnings, on any changed file,
not just changed lines.
Config files are merged using python's ConfigParser system. Therefore, to disable pylint you will need to add this config:
[pylint]
extensions=
-
The linter has to report to stdout
-
The linter has to have a regex that produces a full file path, a line number and an error class
-
The line numbers and file paths have to match diff target file paths
To enable or disable linters change the 'extensions' config.
To get "clang-tidy" to work, add something like this to your lint script:
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_BUILD_TYPE=Release -S . -B lint
cp lint/compile_commands.json .... that way clang-tidy will figure out all the includes needed to compile.
Goals:
- Runs with good defaults for many people
- Should be easy to modify the config for any linter
- Should be easy to use with any vcs
This project uses Flit to build its packages. That might answer your question in case you are wondering why there is no setup.py here.