.pre-commit-config.yaml

ci:
  autoupdate_schedule: quarterly
  autoupdate_branch: 'trunk-patch'
  autofix_prs: false

exclude: (?x)(
        ^hoomd/extern/|
        ^sphinx-doc/tutorial/
        )

repos:
- repo: local
  hooks:
  - id: make_workflows
    name: make_workflows
    language: python
    entry: python3 .github/workflows/make_workflows.py
    pass_filenames: false
    always_run: true
    additional_dependencies: [jinja2==3.1.2, pyyaml==6.0.1]
  - id: check-maintainer
    name: Check for maintainer comments
    description: 'Enforce that `maintainer` comments are removed.'
    entry: '(# Maintainer:|\/\/ Maintainer:)'
    language: pygrep
    types_or: [python, c, c++, cuda, inc]
- repo: https://github.com/pre-commit/pre-commit-hooks
  rev: 'v4.4.0'
  hooks:
  - id: end-of-file-fixer
    exclude_types: [svg]
  - id: trailing-whitespace
    exclude_types: [svg]
  - id: check-json
  - id: check-yaml
    exclude: (?:^.github/workflows/templates) # templates are not properly formatted yaml
  - id: check-case-conflict
  - id: fix-encoding-pragma
    args:
    - --remove
  - id: mixed-line-ending
- repo: https://github.com/glotzerlab/fix-license-header
  rev: v0.2.0
  hooks:
  - id: fix-license-header
    name: Fix license headers (Python)
    exclude: |
      (?x)(
          ^hoomd/extern/|
          ^sphinx-doc/tutorial/|
          ^sphinx-doc/howto/
          )
    types_or: [python]
    args:
    - --license-file=LICENSE
    - --add=Part of HOOMD-blue, released under the BSD 3-Clause License.
    - --keep-before=#!
  - id: fix-license-header
    name: Fix license headers (C)
    types_or: [c, c++, cuda, inc]
    args:
    - --license-file=LICENSE
    - --add=Part of HOOMD-blue, released under the BSD 3-Clause License.
    - --comment-prefix=//
  - id: fix-license-header
    name: Fix license headers (reStructuredText)
    types_or: [rst]
    args:
    - --license-file=LICENSE
    - --add=Part of HOOMD-blue, released under the BSD 3-Clause License.
    - --keep-after=.. include
    - --comment-prefix=..
- repo: https://github.com/kynan/nbstripout
  rev: 0.6.1
  hooks:
    - id: nbstripout
- repo: https://github.com/google/yapf
  rev: 'v0.40.0'
  hooks:
  - id: yapf
- repo: https://github.com/PyCQA/flake8
  rev: '6.0.0'
  hooks:
  - id: flake8
    additional_dependencies:
    - pep8-naming==0.13.3
    - pydocstyle==6.3.0
    - flake8-docstrings==1.7.0
    - flake8-rst-docstrings==0.3.0
    # Exclude components not yet ported to hoomd v3
    # TODO: Remove these exclusions as components are ported
    # These also need to be removed in setup.cfg
    exclude: |
      (?x)(
        ^hoomd/extern/|
        ^hoomd/mpcd/|
        ^hoomd/metal/
      )
- repo: https://github.com/pre-commit/mirrors-clang-format
  rev: v16.0.6
  hooks:
  - id: clang-format
    types_or: [c, c++, cuda, inc]
    exclude: |
      (?x)(
        ^CMake/|
        ^hoomd/extern/|
        ^hoomd/hpmc/UpdaterClusters\.h|
        ^hoomd/hpmc/IntegratorHPMCMono\.h
      )