.pre-commit-hooks.yaml

- id: dbg-check
  name: Check for `dbg`
  description: Ensure no `dbg` statements, macros or expressions included in source files.
  entry: ./validate-dbg.sh
  language: script
  types: [text]

- id: pragma-once
  name: Check for `#pragma once`
  description: Ensure all header files have `#pragma once` before any other imports.
  entry: ./validate-pragma.sh
  language: script
  types_or: [c++, file]
  files: \.(hpp|h\+\+|hxx|cuh)$

- id: mypy
  name: Run MyPy
  description: MyPy
  entry: ./run-mypy.sh
  language: script
  types: [python]
  require_serial: true

- id: todo-check
  name: Check for `todo`s
  description: Check for 'todo' or 'fixme' left in source files.
  entry: ./validate-todo.sh
  language: script
  types: [text]
  exclude: \.pre-commit-config\.yaml$

- id: spell-check-commit-msgs
  name: Spell check commit message
  description: Check for spelling errors in commit messages.
  entry: run-spell-check.sh
  language: python
  stages: [commit-msg]
  additional_dependencies: [codespell]

- id: version-txt-auto-msg
  name: Write automated message when version.txt is changed
  description: Format commit messages to version.txt as "Bump version X.X.X -> Y.Y.Y".
  entry: version-txt-auto-msg.sh
  language: script
  stages: [prepare-commit-msg]

- id: mirror-auto-msg
  name: Write automated message when .mirror.lock is changed
  description: Add the message "Install mirror" or "Sync mirror" when mirror files are updated.
  entry: mirror-auto-msg.sh
  language: script
  stages: [prepare-commit-msg]

- id: absolute-imports-check
  name: Check for absolute imports
  language: script
  entry: validate-absolute-imports.sh
  types: [python]
  exclude: __main__\.py$

- id: list-untracked-files
  name: List untracked files
  description: List untracked files if any, and exit with code 0 (unless an internal error occurs).
  always_run: true
  pass_filenames: false
  language: script
  entry: list-untracked-files.sh
  verbose: true