-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy path.pre-commit-config.yaml
More file actions
149 lines (130 loc) · 3.9 KB
/
.pre-commit-config.yaml
File metadata and controls
149 lines (130 loc) · 3.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# Pre-commit hooks configuration
# See https://pre-commit.com for more information
default_language_version:
python: python3
repos:
# Pre-commit hooks for general file checks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
# File formatting
- id: trailing-whitespace
args: [--markdown-linebreak-ext=md]
- id: end-of-file-fixer
- id: check-yaml
- id: check-toml
- id: check-json
- id: check-added-large-files
args: [--maxkb=1000]
# Python-specific
- id: check-ast
- id: check-builtin-literals
- id: check-docstring-first
- id: debug-statements
- id: name-tests-test
args: [--pytest-test-first]
# Merge conflicts and syntax
- id: check-merge-conflict
- id: check-case-conflict
- id: mixed-line-ending
args: [--fix=lf]
# Security
- id: detect-private-key
# Ruff - Fast Python linter (replaces flake8, isort partially, and more)
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.1.15
hooks:
# Run the linter
- id: ruff
args: [--fix, --exit-non-zero-on-fix]
types_or: [python, pyi]
# Run the formatter (like black)
- id: ruff-format
types_or: [python, pyi]
# Black - Python code formatter (run after ruff-format for consistency)
- repo: https://github.com/psf/black
rev: 23.12.1
hooks:
- id: black
language_version: python3
args: [--line-length=100]
# isort - Sort Python imports
- repo: https://github.com/PyCQA/isort
rev: 5.13.2
hooks:
- id: isort
args: [--profile=black, --line-length=100]
# Prettier - Format YAML, JSON, Markdown, etc.
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v3.1.0
hooks:
- id: prettier
types_or: [yaml, markdown, json]
exclude: ^(CHANGELOG\.md|LICENSE)$
# Pyupgrade - Upgrade Python syntax for newer versions
- repo: https://github.com/asottile/pyupgrade
rev: v3.15.0
hooks:
- id: pyupgrade
args: [--py38-plus]
# Check docstrings
- repo: https://github.com/PyCQA/pydocstyle
rev: 6.3.0
hooks:
- id: pydocstyle
args:
- --convention=google
- --add-ignore=D100,D101,D102,D103,D104,D105,D107,D212
exclude: ^(tests/|setup\.py|docs/)
# MyPy - Static type checking
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.8.0
hooks:
- id: mypy
additional_dependencies:
- types-PyYAML
- types-setuptools
args: [--ignore-missing-imports, --check-untyped-defs]
exclude: ^(tests/|setup\.py|docs/)
# Bandit - Security linter
- repo: https://github.com/PyCQA/bandit
rev: 1.7.6
hooks:
- id: bandit
args: [-c, pyproject.toml]
additional_dependencies: ["bandit[toml]"]
exclude: ^tests/
# Check requirements.txt files are sorted
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: requirements-txt-fixer
files: requirements.*\.txt$
# Markdown linting
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.38.0
hooks:
- id: markdownlint-fix
args: [--disable, MD013, MD033, MD041, --]
# YAML linting
- repo: https://github.com/adrienverge/yamllint
rev: v1.33.0
hooks:
- id: yamllint
args:
[
-d,
"{extends: default, rules: {line-length: {max: 120}, document-start: disable}}",
]
# Shell script linting
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.9.0.6
hooks:
- id: shellcheck
# Conventional commits
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v3.0.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
# Configuration for specific hooks can also be in pyproject.toml