redot/.pre-commit-config.yaml at master · redotengine/redot · GitHub

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
default_language_version:
  python: python3

exclude: |
  (?x)^(
    .*thirdparty/.*|
    .*-(dll|dylib|so)_wrap\.[ch]|
    platform/android/java/editor/src/main/java/com/android/.*|
    platform/android/java/lib/src/main/java/com/google/.*
  )$

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: check-executables-have-shebangs
      - id: check-shebang-scripts-are-executable
        exclude: (SConstruct|SCsub)$ # SCons files use shebangs for syntax highlighting only.

  - repo: https://github.com/pre-commit/mirrors-clang-format
    rev: v21.1.7
    hooks:
      - id: clang-format
        files: \.(c|h|cpp|hpp|cc|hh|cxx|hxx|m|mm|inc|java)$
        types_or: [text]
      - id: clang-format
        name: clang-format-glsl
        files: \.glsl$
        types_or: [text]
        args: [-style=file:misc/utility/clang_format_glsl.yml]

  # Not automatically triggered (because it requires compile_commands.json to be up-to-date).
  # Invoke it manually via `pre-commit run --hook-stage manual clang-tidy`
  - repo: https://github.com/pocc/pre-commit-hooks
    rev: v1.3.5
    hooks:
      - id: clang-tidy
        # TODO .inc ignored for now because they don't include their parent header.
        # TODO Platform-specific subfolders currently fail, we should try to include them
        files: ^(core|main|scene)/.*\.(c|h|cpp|hpp|cc|hh|cxx|hxx|m|mm|java)$
        # No unknown warning suppression used for easier compatibility with gcc
        args: [--fix, --quiet, --use-color, -p=compile_commands.json, -extra-arg=-Wno-unknown-warning-option]
        types_or: [text]
        additional_dependencies: [clang-tidy==21.1.6]
        require_serial: false
        stages: [manual]

  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.15.0
    hooks:
      - id: ruff-check
        args: [--color=always]
        files: (\.py|SConstruct|SCsub)$
        types_or: [text]
      - id: ruff-format
        args: [--color=always]
        files: (\.py|SConstruct|SCsub)$
        types_or: [text]

  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v1.19.1
    hooks:
      - id: mypy
        files: \.py$
        types_or: [text]

  - repo: https://github.com/codespell-project/codespell
    rev: v2.4.1
    hooks:
      - id: codespell
        additional_dependencies: [tomli]

  - repo: https://github.com/python-jsonschema/check-jsonschema
    rev: 0.34.1
    hooks:
      - id: check-jsonschema
        files: ^core/extension/gdextension_interface\.json$
        args: ["--schemafile", "core/extension/gdextension_interface.schema.json"]

  - repo: local
    hooks:
      - id: make-rst
        name: make-rst
        language: python
        entry: python doc/tools/make_rst.py
        args: [doc/classes, modules, platform, --dry-run, --color]
        pass_filenames: false
        files: ^(doc/classes|.*/doc_classes)/.*\.xml$

      - id: doc-status
        name: doc-status
        language: python
        entry: python doc/tools/doc_status.py
        args: [doc/classes, modules/*/doc_classes, platform/*/doc_classes, -c]
        pass_filenames: false
        files: ^(doc/classes|.*/doc_classes)/.*\.xml$

      - id: validate-builders
        name: validate-builders
        language: python
        entry: python tests/python_build/validate_builders.py
        pass_filenames: false
        files: ^(gles3|glsl)_builders\.py$

      - id: validate-xml
        name: validate-xml
        language: python
        entry: python misc/scripts/validate_xml.py
        files: ^(doc/classes|.*/doc_classes)/.*\.xml$
        additional_dependencies: [xmlschema]

      - id: eslint
        name: eslint
        language: node
        entry: eslint
        files: ^(platform/web/js/|modules/|misc/dist/html/).*\.(js|html)$
        args:
          - --fix
          - --no-warn-ignored
          - --no-config-lookup
          - --config
          - platform/web/eslint.config.cjs
        additional_dependencies:
          - "@eslint/js@^9.3.0"
          - "@html-eslint/eslint-plugin@^0.24.1"
          - "@html-eslint/parser@^0.24.1"
          - "@stylistic/eslint-plugin@^2.1.0"
          - eslint@^9.3.0
          - eslint-plugin-html@^8.1.1
          - globals@^15.3.0
          - espree@^10.0.1

      - id: jsdoc
        name: jsdoc
        language: node
        entry: jsdoc
        files: ^platform/web/js/engine/(engine|config|features)\.js$
        args:
          - --template
          - platform/web/js/jsdoc2rst/
          - platform/web/js/engine/engine.js
          - platform/web/js/engine/config.js
          - platform/web/js/engine/features.js
          - --destination
          - ""
          - -d
          - dry-run
        pass_filenames: false
        additional_dependencies: [jsdoc@^4.0.3]

      - id: svgo
        name: svgo
        language: node
        entry: svgo
        files: \.svg$
        args: [--quiet, --config, misc/utility/svgo.config.mjs]
        additional_dependencies: [svgo@3.3.2]

      - id: copyright-headers
        name: copyright-headers
        language: python
        entry: python misc/scripts/copyright_headers.py
        files: \.(c|h|cpp|hpp|cc|hh|cxx|hxx|m|mm|inc|java)$
        exclude: |
          (?x)^(
            core/math/bvh_.*\.inc|
            platform/(?!android|ios|linuxbsd|macos|web|windows)\w+/.*|
            platform/android/java/lib/src/main/java/org/godotengine/godot/gl/GLSurfaceView\.java|
            platform/android/java/lib/src/main/java/org/godotengine/godot/gl/EGLLogWrapper\.java|
            platform/android/java/lib/src/main/java/org/godotengine/godot/utils/ProcessPhoenix\.java
          )$

      - id: header-guards
        name: header-guards
        language: python
        entry: python misc/scripts/header_guards.py
        files: \.(h|hpp|hh|hxx)$

      - id: file-format
        name: file-format
        language: python
        entry: python misc/scripts/file_format.py
        types_or: [text]
        exclude: |
          (?x)^(
            .*\.test\.txt|
            .*\.svg|
            .*\.patch|
            .*\.out|
            modules/gdscript/tests/scripts/parser/features/mixed_indentation_on_blank_lines\.gd|
            modules/gdscript/tests/scripts/parser/warnings/empty_file_newline_comment\.norun\.gd|
            modules/gdscript/tests/scripts/parser/warnings/empty_file_newline\.norun\.gd|
            tests/data/.*\.bin
          )$

      - id: dotnet-format
        name: dotnet-format
        language: python
        entry: python misc/scripts/dotnet_format.py
        types_or: [c#]
#
# End of upstream Godot pre-commit hooks.
#
# Keep this separation to let downstream forks add their own hooks to this file,
# without running into merge conflicts when rebasing on latest upstream.
#
# Start of downstream pre-commit hooks.
#
# This is still the "repo: local" scope, so new local hooks can be defined directly at this indentation:
#     - id: new-local-hook
# To add external repo hooks, bring the indentation back to:
# - repo: my-remote-hook