.pre-commit-config.yaml 3.14 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.28.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.9b0 # Keep in sync with blacken-docs
48
49
  hooks:
  - id: black
50
51
52
53
54
55
56

- repo: https://github.com/asottile/blacken-docs
  rev: v1.11.0
  hooks:
  - id: blacken-docs
    additional_dependencies:
    - black==21.9b0 # 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
# Autoremoves unused imports
- repo: https://github.com/hadialqattan/pycln
  rev: v1.0.3
  hooks:
  - id: pycln

70
# Flake8 also supports pre-commit natively (same author)
71
- repo: https://github.com/PyCQA/flake8
72
  rev: 3.9.2
73
74
  hooks:
  - id: flake8
75
    additional_dependencies: [flake8-bugbear, pep8-naming]
76
    exclude: ^(docs/.*|tools/.*)$
77

78
# CMake formatting
79
- repo: https://github.com/cheshirekow/cmake-format-precommit
Henry Schreiner's avatar
Henry Schreiner committed
80
  rev: v0.6.13
81
82
83
  hooks:
  - id: cmake-format
    additional_dependencies: [pyyaml]
Henry Schreiner's avatar
Henry Schreiner committed
84
85
    types: [file]
    files: (\.cmake|CMakeLists.txt)(.in)?$
86

87
88
# Check static types with mypy
- repo: https://github.com/pre-commit/mirrors-mypy
89
  rev: v0.910
90
91
92
93
94
95
96
  hooks:
  - id: mypy
    # The default Python type ignores .pyi files, so let's rerun if detected
    types: [text]
    files: ^pybind11.*\.pyi?$
    # Running per-file misbehaves a bit, so just run on all files, it's fast
    pass_filenames: false
97
    additional_dependencies: [typed_ast]
98

99
100
# Checks the manifest for missing files (native support)
- repo: https://github.com/mgedmin/check-manifest
101
  rev: "0.47"
102
103
104
105
106
107
  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]

108
109
110
111
- repo: https://github.com/codespell-project/codespell
  rev: v2.1.0
  hooks:
  - id: codespell
112
113
    exclude: ".supp$"
    args: ["-L", "nd,ot,thist"]
114

115
116
117
118
- repo: https://github.com/shellcheck-py/shellcheck-py
  rev: v0.7.2.1
  hooks:
  - id: shellcheck
119

120
# The original pybind11 checks for a few C++ style items
121
122
123
124
125
- repo: local
  hooks:
  - id: disallow-caps
    name: Disallow improper capitalization
    language: pygrep
126
    entry: PyBind|Numpy|Cmake|CCache|PyTest
127
128
    exclude: .pre-commit-config.yaml

129
130
131
132
133
134
135
136
- repo: local
  hooks:
  - id: check-style
    name: Classic check-style
    language: system
    types:
    - c++
    entry: ./tools/check-style.sh