Write your own linting rules using regular expressions.
Project description
reLint
Regular Expression Linter
Write your own linting rules using regular expressions.
Installation
python3 -m pip install relint
Usage
You can write your own regular rules in a YAML file, like so:
- name: No ToDo
pattern: '(?i)todo' # case insensitive flag
hint: Get it done right away!
filePattern: .*\.(py|js)
error: false
The 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 filePattern
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.yml
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]
or --git-diff [-g]
:
git diff --unified=0 | relint my_file.py --diff
Custom message format
Customize the output message format with the --msg-template=<format string>
option.
Python format syntax
is suported for the message template and the following fields are available:
-
filename
The name of the file being linted.
-
line_no
The line number of the match.
-
match
The matched text.
-
test.*
Any attribute of the test rule, e.g.
test.name
ortest.hint
.
pre-commit
You can automate the linting process by adding a
pre-commit hook to your project. Add the
following entry to your .pre-commit-config.yaml
:
- repo: https://github.com/codingjoe/relint
rev: 1.4.0
hooks:
- id: relint
args: [-W] # optional, if you want to fail on warnings during commit
Samples
- name: db fixtures
pattern: 'def test_[^(]+\([^)]*(customer|product)(, |\))'
hint: Use model_bakery recipes instead of db fixtures.
filePattern: test_.*\.py
- name: model_bakery recipes
pattern: baker\.make\(
hint: Please use baker.make_recipe instead of baker.make.
filePattern: (test_.*|conftest)\.py
- name: the database is lava
pattern: '@pytest.fixture.*\n[ ]*def [^(]+\([^)]*(db|transactional_db)(, |\))'
hint: Please do not create db fixtures but model_bakery recipes instead.
filePattern: .*\.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.
filePattern: \/management\/commands\/.*\.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.