Add pre-commit

This is helpful to automate code style checks when commiting, avoiding
the need to remember to do this manually.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I138fcee1842e516caf65b57cce123397ef8128bc
This commit is contained in:
Stephen Finucane 2023-06-01 11:45:53 +01:00
parent 23e6493dee
commit 3d1641c2f7

39
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,39 @@
---
default_language_version:
# force all unspecified python hooks to run python3
python: python3
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: trailing-whitespace
- id: mixed-line-ending
args: ['--fix', 'lf']
exclude: '.*\.(svg)$'
- id: check-byte-order-marker
- id: check-executables-have-shebangs
- id: check-merge-conflict
- id: debug-statements
- id: check-yaml
files: .*\.(yaml|yml)$
exclude: '^(zuul.d|rally-jobs)/.*$'
- repo: https://github.com/PyCQA/doc8
rev: v1.1.1
hooks:
- id: doc8
args: ['--ignore', 'D001']
- repo: https://github.com/openstack/bashate
rev: 2.1.1
hooks:
- id: bashate
args: ['--ignore', 'E006,E042,E043']
- repo: local
hooks:
- id: flake8
name: flake8
additional_dependencies:
- hacking>=3.1.0,<3.2.0
language: python
entry: flake8
files: '^.*\.py$'
exclude: '^(doc|releasenotes|tools)/.*$'