使用正则表达式编写您自己的linting规则。
项目描述
reLint
正则表达式Lint
使用正则表达式编写您自己的linting规则。
安装
python3 -m pip install relint
# or, if you have super advanced linting expressions
python3 -m pip install relint[regex]
示例 & 烹饪书 – reLint食谱
用法
您可以在YAML文件中编写自己的正则规则,如下所示
- name: No ToDo
pattern: '(?i)todo' # case insensitive flag
hint: Get it done right away!
filePattern: .*\.(py|js)
error: false
“name”属性是您的lint的名称,“pattern”可以是任何正则表达式。lint会检查整个文件,因此您的表达式可以匹配多行,并包括换行符。
您可以通过提供可选的“filePattern”属性来缩小您的lint应处理的文件类型范围。默认为“.*”。
可选的“error”属性允许您只显示警告,而不是以错误(非零)退出代码退出。默认为“true”。
以下命令将检查当前目录中的所有文件
relint -c .relint.yml FILE FILE2 ...
默认配置文件名为您工作目录中的“.relint.yml”,但您可以提供任何YAML或JSON文件。
如果您更喜欢检查已更改的文件(git上的缓存),可以使用选项“--diff [-d]”或“--git-diff [-g]”
git diff --unified=0 | relint my_file.py --diff
pre-commit
您可以通过向项目中添加一个pre-commit钩子来自动化代码风格检查过程。请在您的.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
项目详情
下载文件
下载适用于您平台文件的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。
源代码分发
relint-3.2.0.tar.gz (6.5 kB 查看哈希值)
构建分发
relint-3.2.0-py3-none-any.whl (7.8 kB 查看哈希值)
关闭
relint-3.2.0.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 0c0cb1bae850496a5eac9b2982e65becb1ff9a7f4487a8242243e0f7b3ca20fe |
|
MD5 | a368f8a1ca8f92de17f0f3650eaa3270 |
|
BLAKE2b-256 | 208393e611629f1485d5af660c2ec0917025a7645849c6764ad831130d419f83 |
关闭
relint-3.2.0-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 14e7df098f29dc9be533339e0b8b8092f9d2e1e8a33f6c06b2607e6414a4eb81 |
|
MD5 | c72e5665f21d9bb7fc561a9d9c6f9dc4 |
|
BLAKE2b-256 | da483b9e7e62cf4a65ceb2b7359709e33350c1a246c28b9cfa9eea6feab80380 |