codeql/.pre-commit-config.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/.*$(?<!\.qlref)|.*\.patch$|.*\.qll?$
      - id: end-of-file-fixer
        exclude: /test/.*$(?<!\.qlref)|.*\.patch$|.*\.qll?$

  - 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: v2.0.4
    hooks:
      - id: autopep8
        files: ^misc/codegen/.*\.py

  - repo: local
    hooks:
      - id: buildifier
        name: Format bazel files
        files: \.(bazel|bzl)
        language: system
        entry: bazel run //misc/bazel/buildifier
        pass_filenames: false

#      DISABLED: can be enabled by copying this config and installing `pre-commit` with `--config` on the copy
#      - id: go-gen
#        name: Check checked in generated files in go
#        files: ^go/.*
#        language: system
#        entry: bazel run //go:gen
#        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|toml)$|^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: ^misc/codegen/|^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

      - id: rust-codegen
        name: Run Rust checked in code generation
        files: ^misc/codegen/|^rust/(schema.py$|codegen/|.*/generated/|ql/lib/(rust\.dbscheme$|codeql/rust/elements)|\.generated.list)
        language: system
        entry: bazel run //rust/codegen -- --quiet
        pass_filenames: false

      - id: rust-lint
        name: Run fmt and clippy on Rust code
        files: ^rust/extractor/(.*rs|Cargo.toml)$
        language: system
        entry: python3 rust/lint.py
        pass_filenames: false
add pre-commit configuration This enables use of the `pre-commit` framework to run quick pre-commit checks. In particular this allows to automatically fix: * trailing white spaces * absence or multiple newlines at the end of files * QL code formatting * file sync More could be added in the future: anything that can be checked fast can be added in the configuration (for example well-formedness of `qldoc` files). This is a purely opt-in feature. Instructions for enabling it and possibly configuring its behaviour are in `pre-commit-hook-setup.md`. 2022-02-22 17:42:16 +03:00			`# See https://pre-commit.com for more information`
			`# See https://pre-commit.com/hooks.html for more hooks`
			`repos:`
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- repo: https://github.com/pre-commit/pre-commit-hooks`
add pre-commit configuration This enables use of the `pre-commit` framework to run quick pre-commit checks. In particular this allows to automatically fix: * trailing white spaces * absence or multiple newlines at the end of files * QL code formatting * file sync More could be added in the future: anything that can be checked fast can be added in the configuration (for example well-formedness of `qldoc` files). This is a purely opt-in feature. Instructions for enabling it and possibly configuring its behaviour are in `pre-commit-hook-setup.md`. 2022-02-22 17:42:16 +03:00			`rev: v3.2.0`
			`hooks:`
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- id: trailing-whitespace`
Rust: some basic extraction of function names (with locations!) 2024-08-29 18:03:19 +03:00			`exclude: /test/.$(?<!\.qlref)\|.\.patch$\|.*\.qll?$`
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- id: end-of-file-fixer`
Rust: some basic extraction of function names (with locations!) 2024-08-29 18:03:19 +03:00			`exclude: /test/.$(?<!\.qlref)\|.\.patch$\|.*\.qll?$`
pre-commit: add qhelp check Also the instructions on customizing `pre-commit`'s behaviour have been updated to use the `--config` option. 2022-02-24 12:55:53 +03:00
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- repo: https://github.com/pre-commit/mirrors-clang-format`
Swift: update formatting to `clang-format` 17.0.6 Also, added a format check in `swift.yml`. 2024-01-25 15:57:10 +03:00			`rev: v17.0.6`
add pre-commit configuration This enables use of the `pre-commit` framework to run quick pre-commit checks. In particular this allows to automatically fix: * trailing white spaces * absence or multiple newlines at the end of files * QL code formatting * file sync More could be added in the future: anything that can be checked fast can be added in the configuration (for example well-formedness of `qldoc` files). This is a purely opt-in feature. Instructions for enabling it and possibly configuring its behaviour are in `pre-commit-hook-setup.md`. 2022-02-22 17:42:16 +03:00			`hooks:`
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- id: clang-format`

Swift: autopep8 all python files Additionally set up a pre-commit hook and a CI check for that. 2022-06-23 18:05:21 +03:00			`- repo: https://github.com/pre-commit/mirrors-autopep8`
Pre-commit: bump up `autopep8` check version and fix formatting 2024-09-16 15:03:48 +03:00			`rev: v2.0.4`
Swift: autopep8 all python files Additionally set up a pre-commit hook and a CI check for that. 2022-06-23 18:05:21 +03:00			`hooks:`
			`- id: autopep8`
Codegen: fix autopep8 pre-commit hook 2023-03-29 16:57:45 +03:00			`files: ^misc/codegen/.*\.py`
Swift: autopep8 all python files Additionally set up a pre-commit hook and a CI check for that. 2022-06-23 18:05:21 +03:00
Bazel: introduce buildifier formatting 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. 2024-04-24 16:49:48 +03:00			`- repo: local`
Misc: add bazel buildifer pre-commit hook 2023-06-30 14:05:40 +03:00			`hooks:`
			`- id: buildifier`
Bazel: introduce buildifier formatting 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. 2024-04-24 16:49:48 +03:00			`name: Format bazel files`
			`files: \.(bazel\|bzl)`
			`language: system`
Address review. 2024-08-23 18:26:05 +03:00			`entry: bazel run //misc/bazel/buildifier`
Bazel: introduce buildifier formatting 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. 2024-04-24 16:49:48 +03:00			`pass_filenames: false`
Misc: add bazel buildifer pre-commit hook 2023-06-30 14:05:40 +03:00
Go: disable pre-commit hook 2024-05-13 10:27:35 +03:00			# DISABLED: can be enabled by copying this config and installing `pre-commit` with `--config` on the copy
			`# - id: go-gen`
			`# name: Check checked in generated files in go`
			`# files: ^go/.*`
			`# language: system`
			`# entry: bazel run //go:gen`
			`# pass_filenames: false`
Go: add gazelle-generated `BUILD` files 2024-04-24 18:04:57 +03:00
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- id: codeql-format`
add pre-commit configuration This enables use of the `pre-commit` framework to run quick pre-commit checks. In particular this allows to automatically fix: * trailing white spaces * absence or multiple newlines at the end of files * QL code formatting * file sync More could be added in the future: anything that can be checked fast can be added in the configuration (for example well-formedness of `qldoc` files). This is a purely opt-in feature. Instructions for enabling it and possibly configuring its behaviour are in `pre-commit-hook-setup.md`. 2022-02-22 17:42:16 +03:00			`name: Fix QL file formatting`
			`files: \.qll?$`
			`language: system`
			`entry: codeql query format --in-place`
pre-commit: add qhelp check Also the instructions on customizing `pre-commit`'s behaviour have been updated to use the `--config` option. 2022-02-24 12:55:53 +03:00
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- id: sync-files`
add pre-commit configuration This enables use of the `pre-commit` framework to run quick pre-commit checks. In particular this allows to automatically fix: * trailing white spaces * absence or multiple newlines at the end of files * QL code formatting * file sync More could be added in the future: anything that can be checked fast can be added in the configuration (for example well-formedness of `qldoc` files). This is a purely opt-in feature. Instructions for enabling it and possibly configuring its behaviour are in `pre-commit-hook-setup.md`. 2022-02-22 17:42:16 +03:00			`name: Fix files required to be identical`
Rust: reuse shared rust trap library 2024-08-30 17:08:37 +03:00			`files: \.(qll?\|qhelp\|swift\|toml)$\|^config/identical-files\.json$`
add pre-commit configuration This enables use of the `pre-commit` framework to run quick pre-commit checks. In particular this allows to automatically fix: * trailing white spaces * absence or multiple newlines at the end of files * QL code formatting * file sync More could be added in the future: anything that can be checked fast can be added in the configuration (for example well-formedness of `qldoc` files). This is a purely opt-in feature. Instructions for enabling it and possibly configuring its behaviour are in `pre-commit-hook-setup.md`. 2022-02-22 17:42:16 +03:00			`language: system`
			`entry: python3 config/sync-files.py --latest`
			`pass_filenames: false`
pre-commit: add qhelp check Also the instructions on customizing `pre-commit`'s behaviour have been updated to use the `--config` option. 2022-02-24 12:55:53 +03:00
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`- id: qhelp`
pre-commit: add qhelp check Also the instructions on customizing `pre-commit`'s behaviour have been updated to use the `--config` option. 2022-02-24 12:55:53 +03:00			`name: Check query help generation`
			`files: \.qhelp$`
			`language: system`
			`entry: python3 misc/scripts/check-qhelp.py`
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00
			`- id: swift-codegen`
			`name: Run Swift checked in code generation`
Rust: add codegen pre commit hook 2024-09-09 11:47:42 +03:00			`files: ^misc/codegen/\|^swift/(schema.py$\|codegen/\|.*/generated/\|ql/lib/(swift\.dbscheme$\|codeql/swift/elements)\|ql/\.generated.list)`
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`language: system`
Swift: add --quiet to codegen 2022-06-20 18:45:07 +03:00			`entry: bazel run //swift/codegen -- --quiet`
Swift: cleanup and some docstrings for codegen Also added code generation and clang formatting to the pre-commit configuration. 2022-04-14 12:15:19 +03:00			`pass_filenames: false`
Swift: add unit tests to code generation Tests can be run with ``` bazel test //swift/codegen:tests ``` Coverage can be checked installing `pytest-cov` and running ``` pytest --cov=swift/codegen swift/codegen/test ``` 2022-04-26 19:22:40 +03:00
			`- id: swift-codegen-unit-tests`
			`name: Run Swift code generation unit tests`
Swift: removed spurious `mock` import 2022-04-27 10:09:57 +03:00			`files: ^swift/codegen/.*\.py$`
Swift: add unit tests to code generation Tests can be run with ``` bazel test //swift/codegen:tests ``` Coverage can be checked installing `pytest-cov` and running ``` pytest --cov=swift/codegen swift/codegen/test ``` 2022-04-26 19:22:40 +03:00			`language: system`
Move `swift/codegen` to `misc/codegen` 2023-02-24 15:44:29 +03:00			`entry: bazel test //misc/codegen/test`
Swift: add unit tests to code generation Tests can be run with ``` bazel test //swift/codegen:tests ``` Coverage can be checked installing `pytest-cov` and running ``` pytest --cov=swift/codegen swift/codegen/test ``` 2022-04-26 19:22:40 +03:00			`pass_filenames: false`
Rust: add codegen pre commit hook 2024-09-09 11:47:42 +03:00
			`- id: rust-codegen`
			`name: Run Rust checked in code generation`
			`files: ^misc/codegen/\|^rust/(schema.py$\|codegen/\|.*/generated/\|ql/lib/(rust\.dbscheme$\|codeql/rust/elements)\|\.generated.list)`
			`language: system`
			`entry: bazel run //rust/codegen -- --quiet`
			`pass_filenames: false`
Rust: add linting pre-commit hook 2024-09-10 11:22:45 +03:00
			`- id: rust-lint`
			`name: Run fmt and clippy on Rust code`
			`files: ^rust/extractor/(.*rs\|Cargo.toml)$`
			`language: system`
			`entry: python3 rust/lint.py`
			`pass_filenames: false`