Regular Expression Linter
Write your own linting rules using regular expressions.
pip install relint
You can write your own regular rules in a YAML file, like so:
- name: No ToDo pattern: "[tT][oO][dD][oO]" hint: Get it done right away! filename: - "*.py" - "*.js" error: false
name attribute is the name of your linter, the
pattern can be
any regular expression. The linter does lint entire files, therefore your
expressions can match multiple lines and include newlines.
You can narrow down the file types your linter should be working with, by
providing the optional
filename attribute. The default is
The optional error attribute allows you to only show a warning but not exit with a bad (non-zero) exit code. The default is true.
The following command will lint all files in the current directory:
relint -c .relint.yml **
The default configuration file name is .relint.yaml within your working directory, but you can provide any YAML or JSON file.
If you prefer linting changed files (cached on git) you can use the option --diff [-d]:
git diff | relint my_file.py --diff
This option is useful for pre-commit purposes. Here an example of how to use it with pre-commit framework:
- repo: local hooks: - id: relint name: relint entry: bin/relint-pre-commit.sh language: system
You can find an example of relint-pre-commit.sh in this repository.
- name: db fixtures pattern: "def test_[^(]+\\([^)]*(customer|product)(, |\\))" hint: Use model_mommy recipies instead of db fixtures. filename: - "**/test_*.py" - name: model_mommy recipies pattern: "mommy\\.make\\(" hint: Please use mommy.make_recipe instead of mommy.make. filename: - "**/test_*.py" - "conftest.py" - "**/conftest.py" - name: the database is lava pattern: "@pytest.fixture.*\\n[ ]*def [^(]+\\([^)]*(db|transactional_db)(, |\\))" hint: Please do not create db fixtures but model_mommy recipies instead. filename: - "*.py" - name: No logger in management commands pattern: "(logger|import logging)" hint: "Please write to self.stdout or self.stderr in favor of using a logger." filename: - "*/management/commands/*.py"