-
Notifications
You must be signed in to change notification settings - Fork 36
/
.pre-commit-config.yaml
217 lines (200 loc) · 7.4 KB
/
.pre-commit-config.yaml
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
---
default_language_version:
python: python3
exclude: ^(doc/_static/.*|doc/_themes/.*)$
minimum_pre_commit_version: 3.6.0
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: check-merge-conflict # Check for files that contain merge conflict strings.
- id: trailing-whitespace # Trims trailing whitespace.
args: [--markdown-linebreak-ext=md]
exclude: >
(?x)^(
pkg/macos/pkg-resources/.*\.rtf
)$
- id: mixed-line-ending # Replaces or checks mixed line ending.
args: [--fix=auto]
- id: end-of-file-fixer # Makes sure files end in a newline and only a newline.
exclude: changelog/.*
- id: check-merge-conflict # Check for files that contain merge conflict strings.
- id: check-ast # Simply check whether files parse as valid python.
exclude: >
(?x)^(
templates/.*
)$
- id: check-case-conflict # Check for files with names that would conflict on a
# case-insensitive filesystem like MacOS HFS+ or Windows FAT.
- id: check-json # Attempts to load all json files to verify syntax.
- id: check-symlinks # Checks for symlinks which do not point to anything.
- id: debug-statements # Check for debugger imports and py37+ breakpoint() calls in python source.
exclude: >
(?x)^(
templates/.*
)$
- id: fix-byte-order-marker # removes UTF-8 byte order marker
- id: forbid-submodules # forbids any submodules in the repository.
- id: fix-encoding-pragma # Remove `# -*- coding: utf-8 -*-` from the top of python files.
args:
- --remove
exclude: >
(?x)^(
salt/ext/.*
)$
# ----- Formatting ---------------------------------------------------------------------------->
- repo: https://github.com/asottile/pyupgrade
rev: v3.17.0
hooks:
- id: pyupgrade
name: Rewrite Code to be Py3.10+, drop six usage and Py2 support
args: [--py310-plus, --keep-mock]
exclude: src/saltext/vcenter/version.py
- repo: https://github.com/saltstack/pre-commit-remove-import-headers
rev: 1.1.0
hooks:
- id: remove-import-headers
- repo: local
hooks:
- id: check-cli-examples
name: Check CLI examples on execution modules
entry: python .pre-commit-hooks/check-cli-examples.py
language: system
files: ^src/saltext/vcenter/modules/.*\.py$
- repo: local
hooks:
- id: check-docs
name: Check rST doc files exist for modules/states
entry: python .pre-commit-hooks/make-autodocs.py
language: system
pass_filenames: false
- repo: https://github.com/saltstack/salt-rewrite
# Automatically rewrite code with known rules
rev: 2.5.2
hooks:
- id: salt-rewrite
alias: rewrite-docstrings
name: Salt extensions docstrings auto-fixes
files: ^src/saltext/vcenter/.*\.py$
args: [--silent, -F, fix_docstrings]
- id: salt-rewrite
alias: rewrite-tests
name: Rewrite Salt's Test Suite
files: ^tests/.*\.py$
args: [--silent, -E, fix_asserts, -E, fix_docstrings]
## - repo: https://github.com/asottile/reorder_python_imports
## rev: v3.13.0
## hooks:
## - id: reorder-python-imports
## args: [
## --py310-plus,
## ]
## exclude: src/saltext/vcenter/version.py
- repo: https://github.com/psf/black
rev: 24.8.0
hooks:
- id: black
args: [-tpy310]
exclude: ^src/saltext/vcenter/version.py
- repo: https://github.com/asottile/blacken-docs
rev: 1.18.0
hooks:
- id: blacken-docs
args: [--skip-errors]
files: ^docs/.*\.rst
additional_dependencies: [black==24.8.0]
- repo: https://github.com/myint/rstcheck
rev: v5.0.0
hooks:
- id: rstcheck
name: Check reST files using rstcheck
args: [--report=warning, --ignore-directives=automodule]
additional_dependencies: [sphinx]
# <---- Formatting -----------------------------------------------------------------------------
# ----- Security ------------------------------------------------------------------------------>
- repo: https://github.com/PyCQA/bandit
rev: "1.7.9"
hooks:
- id: bandit
alias: bandit-salt
name: Run bandit against the code base
args: [--silent, -lll, --skip, "B701,B324"]
exclude: src/saltext/vcenter/version.py
additional_dependencies: ['importlib_metadata<5']
- repo: https://github.com/PyCQA/bandit
rev: "1.7.9"
hooks:
- id: bandit
alias: bandit-tests
name: Run bandit against the test suite
args: [--silent, -lll, --skip, "B701,B324"]
files: ^tests/.*
additional_dependencies: ['importlib_metadata<5']
# <---- Security -------------------------------------------------------------------------------
# ----- Code Analysis ------------------------------------------------------------------------->
# forget you, lint.
# - repo: https://github.com/saltstack/mirrors-nox
# rev: v2020.8.22
# hooks:
# - id: nox
# alias: lint-src
# name: Lint Source Code
# files: ^((setup|noxfile)|src/.*)\.py$
# require_serial: True
# args:
# - -e
# - lint-code-pre-commit
# - --
#
# - repo: https://github.com/saltstack/mirrors-nox
# rev: v2020.8.22
# hooks:
# - id: nox
# alias: lint-tests
# name: Lint Tests
# files: ^tests/.*\.py$
# require_serial: True
# args:
# - -e
# - lint-tests-pre-commit
# - --
# <---- Code Analysis --------------------------------------------------------------------------
# ----- Static Test Requirements -------------------------------------------------------------->
- repo: https://github.com/saltstack/pip-tools-compile-impersonate
rev: '4.8'
hooks:
- id: pip-tools-compile
alias: compile-3.10-test-requirements
name: Py3.10 Test Requirements
files: ^requirements/tests.in$
pass_filenames: false
args:
- -v
- --py-version=3.10
- --platform=linux
- requirements/tests.in
# <---- Static Test Requirements ---------------------------------------------------------------
# ----- Static Lint Requirements -------------------------------------------------------------->
- id: pip-tools-compile
alias: compile-3.10-test-requirements
name: Py3.10 Lint Requirements
files: ^requirements/lint.in$
pass_filenames: false
args:
- -v
- --py-version=3.10
- --platform=linux
- requirements/lint.in
# <---- Static Lint Requirements ---------------------------------------------------------------
# ----- Static Docs Requirements -------------------------------------------------------------->
- id: pip-tools-compile
alias: compile-3.10-test-requirements
name: Py3.10 Docs Requirements
files: ^requirements/docs.in$
pass_filenames: false
args:
- -v
- --py-version=3.10
- --platform=linux
- requirements/docs.in
# <---- Static Docs Requirements ---------------------------------------------------------------