.pre-commit-config.yaml 3.33 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# To use:
#
#     pre-commit run -a
#
# Or:
#
#     pre-commit install  # (runs every time you commit in git)
#
# To update this file:
#
#     pre-commit autoupdate
#
# See https://github.com/pre-commit/pre-commit

15
repos:
16
# Standard hooks
17
- repo: https://github.com/pre-commit/pre-commit-hooks
18
  rev: v4.0.1
19
20
21
  hooks:
  - id: check-added-large-files
  - id: check-case-conflict
22
  - id: check-docstring-first
23
24
  - id: check-merge-conflict
  - id: check-symlinks
25
  - id: check-toml
26
27
28
29
30
31
32
  - id: check-yaml
  - id: debug-statements
  - id: end-of-file-fixer
  - id: mixed-line-ending
  - id: requirements-txt-fixer
  - id: trailing-whitespace
  - id: fix-encoding-pragma
33
    exclude: ^noxfile.py$
34

35
- repo: https://github.com/asottile/pyupgrade
36
  rev: v2.29.0
37
38
39
  hooks:
  - id: pyupgrade

40
41
42
43
44
- repo: https://github.com/PyCQA/isort
  rev: 5.9.3
  hooks:
  - id: isort

45
46
# Black, the code formatter, natively supports pre-commit
- repo: https://github.com/psf/black
47
  rev: 21.10b0 # Keep in sync with blacken-docs
48
49
  hooks:
  - id: black
50
51
52
53
54
55

- repo: https://github.com/asottile/blacken-docs
  rev: v1.11.0
  hooks:
  - id: blacken-docs
    additional_dependencies:
56
    - black==21.10b0 # keep in sync with black hook
57
58

# Changes tabs to spaces
59
- repo: https://github.com/Lucas-C/pre-commit-hooks
60
  rev: v1.1.10
61
62
63
  hooks:
  - id: remove-tabs

64
65
66
67
68
69
70
71
72
73
- repo: https://github.com/pre-commit/pygrep-hooks
  rev: v1.9.0
  hooks:
  - id: python-check-blanket-noqa
  - id: python-check-blanket-type-ignore
  - id: python-no-log-warn
  - id: rst-backticks
  - id: rst-directive-colons
  - id: rst-inline-touching-normal

74
# Flake8 also supports pre-commit natively (same author)
75
- repo: https://github.com/PyCQA/flake8
76
  rev: 4.0.1
77
78
  hooks:
  - id: flake8
79
80
81
    additional_dependencies: &flake8_dependencies
      - flake8-bugbear
      - pep8-naming
82
    exclude: ^(docs/.*|tools/.*)$
83

84
- repo: https://github.com/asottile/yesqa
85
  rev: v1.3.0
86
87
88
89
  hooks:
  - id: yesqa
    additional_dependencies: *flake8_dependencies

90
# CMake formatting
91
- repo: https://github.com/cheshirekow/cmake-format-precommit
Henry Schreiner's avatar
Henry Schreiner committed
92
  rev: v0.6.13
93
94
95
  hooks:
  - id: cmake-format
    additional_dependencies: [pyyaml]
Henry Schreiner's avatar
Henry Schreiner committed
96
97
    types: [file]
    files: (\.cmake|CMakeLists.txt)(.in)?$
98

99
100
# Check static types with mypy
- repo: https://github.com/pre-commit/mirrors-mypy
101
  rev: v0.910-1
102
103
104
105
  hooks:
  - id: mypy
    # Running per-file misbehaves a bit, so just run on all files, it's fast
    pass_filenames: false
106
    additional_dependencies: [typed_ast]
107

108
109
# Checks the manifest for missing files (native support)
- repo: https://github.com/mgedmin/check-manifest
110
  rev: "0.47"
111
112
113
114
115
116
  hooks:
  - id: check-manifest
    # This is a slow hook, so only run this if --hook-stage manual is passed
    stages: [manual]
    additional_dependencies: [cmake, ninja]

117
118
119
120
- repo: https://github.com/codespell-project/codespell
  rev: v2.1.0
  hooks:
  - id: codespell
121
122
    exclude: ".supp$"
    args: ["-L", "nd,ot,thist"]
123

124
125
126
127
- repo: https://github.com/shellcheck-py/shellcheck-py
  rev: v0.7.2.1
  hooks:
  - id: shellcheck
128

129
# The original pybind11 checks for a few C++ style items
130
131
132
133
134
- repo: local
  hooks:
  - id: disallow-caps
    name: Disallow improper capitalization
    language: pygrep
135
    entry: PyBind|Numpy|Cmake|CCache|PyTest
136
137
    exclude: .pre-commit-config.yaml

138
139
140
141
142
143
144
145
- repo: local
  hooks:
  - id: check-style
    name: Classic check-style
    language: system
    types:
    - c++
    entry: ./tools/check-style.sh