/
.pre-commit-config.yaml
134 lines (122 loc) · 4.46 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
---
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
# Files that should not be checked
exclude: |
(?x)^(
nilearn/datasets/tests/data/localizer_behavioural.tsv
| nilearn/externals/.*
| nilearn/plotting/data/js/.*js
| nilearn/_version.py
)$
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: check-ast
- id: check-case-conflict
- id: check-json
- id: check-merge-conflict
- id: check-toml
- id: check-yaml
- id: end-of-file-fixer
- id: mixed-line-ending
- id: trailing-whitespace
# Sorts Python imports alphabetically and by section with `isort`.
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
args: [--profile, black, --settings-path, pyproject.toml]
# Automatically upgrade syntax for newer versions of the language.
- repo: https://github.com/asottile/pyupgrade
rev: v3.15.2
hooks:
- id: pyupgrade
args: [--py38-plus]
# Checks for .rst files
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
- id: rst-directive-colons
- id: rst-inline-touching-normal
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
- id: rst-backticks
# Aplly black formatting to python code
# https://github.com/psf/black
- repo: https://github.com/psf/black-pre-commit-mirror
rev: 24.4.2
hooks:
- id: black
args: [--config, pyproject.toml]
# exclude files that
# - are skipped for other hooks
# - are still involved in some PR
exclude: |
(?x)^(
nilearn/datasets/tests/data/localizer_behavioural.tsv
| nilearn/externals/.*
| nilearn/plotting/data/js/.*js
| nilearn/_version.py
| examples/01_plotting/plot_3d_map_to_surface_projection.py
| examples/01_plotting/plot_surf_atlas.py
| examples/01_plotting/plot_surf_stat_map.py
| examples/01_plotting/plot_surface_projection_strategies.py
| examples/04_glm_first_level/plot_localizer_surface_analysis.py
| examples/07_advanced/plot_surface_bids_analysis.py
| nilearn/_utils/helpers.py
| nilearn/plotting/html_surface.py
| nilearn/plotting/js_plotting_utils.py
| nilearn/plotting/surf_plotting.py
| nilearn/plotting/tests/test_html_surface.py
| nilearn/plotting/tests/test_surf_plotting.py
| nilearn/surface/surface.py
| nilearn/surface/tests/test_surface.py
)$
# Apply black formatting to doc strings
- repo: https://github.com/adamchainz/blacken-docs
rev: 1.16.0
hooks:
- id: blacken-docs
additional_dependencies:
- black==23.9.1
# Checks for spelling errors
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
args: [--toml, pyproject.toml]
additional_dependencies: [tomli]
# Format YAML files
- repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt
rev: 0.2.3
hooks:
- id: yamlfmt
args: [--mapping, '4', --sequence, '4', --offset, '0']
# Format TOML files
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.13.0
hooks:
- id: pretty-format-toml
args: [--autofix, --indent, '4']
# Check formatting of CSS and HTML
# prettier: https://prettier.io/
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v4.0.0-alpha.8
hooks:
- id: prettier
types_or: [css, html]
# Check that Python code complies with PEP8 guidelines
# flake8 uses pydocstyle to check docstrings: https://flake8.pycqa.org/en/latest/
# flake8-docstrings: https://pypi.org/project/flake8-docstrings/
# flake8-use-fstring forces to use fstrings: https://pypi.org/project/flake8-use-fstring/
# flake8-functions checks functions quality: https://pypi.org/project/flake8-functions/
# flake8-bugbear detects some common bugs: https://github.com/PyCQA/flake8-bugbear
- repo: https://github.com/pyCQA/flake8
rev: 7.0.0
hooks:
- id: flake8
args: [--config, .flake8, --verbose, nilearn, examples, maint_tools]
additional_dependencies: [flake8-docstrings, flake8-use-fstring, flake8-functions, flake8-bugbear]