mirror of
https://github.com/github/codeql.git
synced 2025-12-16 16:53:25 +01:00
9f5782b67b
This introduces tooling and enforcement for formatting bazel files. The tooling is provided as a bazel run target from [keith/buildifier-prebuilt](https://github.com/keith/buildifier-prebuilt). This is used in a [`pre-commit`](https://pre-commit.com/) hook for those having that installed. In turn this is used in a CI check. Relying on a `pre-commit` action gives us easy checking that buildifying did not change anything in the files and printing the diff, without having to hand-roll the check ourselves. This enforcement will make usage of gazelle easier, as gazelle itself might reformat files, even outside of `go`. Having them properly formatted will allow gazelle to leave them unchanged, without needing to configure awkward exclude directives.
64 lines
1.9 KiB
YAML
64 lines
1.9 KiB
YAML
# See https://pre-commit.com for more information
|
|
# See https://pre-commit.com/hooks.html for more hooks
|
|
repos:
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
rev: v3.2.0
|
|
hooks:
|
|
- id: trailing-whitespace
|
|
exclude: /test/.*$(?<!\.ql)(?<!\.qll)(?<!\.qlref)|.*\.patch
|
|
- id: end-of-file-fixer
|
|
exclude: /test/.*$(?<!\.ql)(?<!\.qll)(?<!\.qlref)|.*\.patch
|
|
|
|
- repo: https://github.com/pre-commit/mirrors-clang-format
|
|
rev: v17.0.6
|
|
hooks:
|
|
- id: clang-format
|
|
|
|
- repo: https://github.com/pre-commit/mirrors-autopep8
|
|
rev: v1.6.0
|
|
hooks:
|
|
- id: autopep8
|
|
files: ^misc/codegen/.*\.py
|
|
|
|
- repo: local
|
|
hooks:
|
|
- id: buildifier
|
|
name: Format bazel files
|
|
files: \.(bazel|bzl)
|
|
language: system
|
|
entry: bazel run //:buildifier
|
|
pass_filenames: false
|
|
|
|
- id: codeql-format
|
|
name: Fix QL file formatting
|
|
files: \.qll?$
|
|
language: system
|
|
entry: codeql query format --in-place
|
|
|
|
- id: sync-files
|
|
name: Fix files required to be identical
|
|
files: \.(qll?|qhelp|swift)$|^config/identical-files\.json$
|
|
language: system
|
|
entry: python3 config/sync-files.py --latest
|
|
pass_filenames: false
|
|
|
|
- id: qhelp
|
|
name: Check query help generation
|
|
files: \.qhelp$
|
|
language: system
|
|
entry: python3 misc/scripts/check-qhelp.py
|
|
|
|
- id: swift-codegen
|
|
name: Run Swift checked in code generation
|
|
files: ^swift/(schema.py$|codegen/|.*/generated/|ql/lib/(swift\.dbscheme$|codeql/swift/elements)|ql/\.generated.list)
|
|
language: system
|
|
entry: bazel run //swift/codegen -- --quiet
|
|
pass_filenames: false
|
|
|
|
- id: swift-codegen-unit-tests
|
|
name: Run Swift code generation unit tests
|
|
files: ^swift/codegen/.*\.py$
|
|
language: system
|
|
entry: bazel test //misc/codegen/test
|
|
pass_filenames: false
|