-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
.pre-commit-config.yaml
103 lines (94 loc) · 2.85 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
repos:
# Ruff mne
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.8.3
hooks:
- id: ruff
name: ruff lint mne
args: ["--fix"]
files: ^mne/|^tools/
exclude: vulture_allowlist.py
- id: ruff
name: ruff lint mne preview
args: ["--fix", "--preview", "--select=NPY201"]
files: ^mne/|^tools/
- id: ruff
name: ruff lint doc, tutorials, and examples
# D103: missing docstring in public function
# D400: docstring first line must end with period
args: ["--ignore=D103,D400", "--fix"]
files: ^doc/|^tutorials/|^examples/
- id: ruff-format
files: ^mne/|^doc/|^tutorials/|^examples/|^tools/
# Codespell
- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
additional_dependencies:
- tomli
files: ^mne/|^doc/|^examples/|^tutorials/|^tools/
types_or: [python, bib, rst, inc]
# yamllint
- repo: https://github.com/adrienverge/yamllint.git
rev: v1.35.1
hooks:
- id: yamllint
args: [--strict, -c, .yamllint.yml]
# rstcheck
- repo: https://github.com/rstcheck/rstcheck.git
rev: v6.2.4
hooks:
- id: rstcheck
additional_dependencies:
- tomli
files: ^doc/.*\.(rst|inc)$
# Credit is problematic because we generate an include on the fly
exclude: ^doc/credit.rst$
# sorting
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: file-contents-sorter
files: ^doc/changes/names.inc|^.mailmap
args: ["--ignore-case"]
- repo: https://github.com/pappasam/toml-sort
rev: v0.24.2
hooks:
- id: toml-sort-fix
files: pyproject.toml
# dependencies
- repo: local
hooks:
- id: update-env-file
name: Copy dependency changes from pyproject.toml to environment.yml
language: python
entry: ./tools/hooks/update_environment_file.py
files: pyproject.toml
- repo: local
hooks:
- id: dependency-sync
name: Copy core dependencies from pyproject.toml to README.rst
language: python
entry: ./tools/hooks/sync_dependencies.py
files: pyproject.toml
additional_dependencies: ["mne"]
# zizmor
- repo: https://github.com/woodruffw/zizmor-pre-commit
rev: v0.9.2
hooks:
- id: zizmor
# these should *not* be run on CIs:
ci:
skip: [dependency-sync] # needs MNE to work, which exceeds the free tier space alloc.
# The following are too slow to run on local commits, so let's only run on CIs:
#
# - repo: https://github.com/pre-commit/mirrors-mypy
# rev: v1.9.0
# hooks:
# - id: mypy
#
# - repo: https://github.com/jendrikseipp/vulture
# rev: 'v2.11' # or any later Vulture version
# hooks:
# - id: vulture