.pre-commit-config.yaml

# To use:
#
#     pre-commit run -a
#
# Or:
#
#     pre-commit install  # (runs every time you commit in git)
#
# To update this file:
#
#     pre-commit autoupdate
#
# See https://pre-commit.com for more information

# Do not check/format anything from third parties
exclude: '^share/openPMD/thirdParty'

# See https://pre-commit.com/hooks.html for more hooks
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
    - id: trailing-whitespace
      args: [--markdown-linebreak-ext=md]
    - id: end-of-file-fixer
      exclude: '.json$'
    - id: mixed-line-ending
    - id: check-json
    - id: check-toml
    - id: check-yaml
    - id: check-added-large-files
      args: ['--maxkb=40']
    - id: requirements-txt-fixer
#  - id: fix-encoding-pragma
#    exclude: ^noxfile.py$

# documentation files: .rst
-   repo: https://github.com/pre-commit/pygrep-hooks
    rev: v1.10.0
    hooks:
#    - id: rst-backticks
    - id: rst-directive-colons
    - id: rst-inline-touching-normal

#- repo: https://github.com/asottile/pyupgrade
#  rev: v2.29.0
#  hooks:
#  - id: pyupgrade

# Changes tabs to spaces
- repo: https://github.com/Lucas-C/pre-commit-hooks
  rev: v1.5.5
  hooks:
  - id: remove-tabs
    exclude: 'Make.WarpX|Make.package|Makefile|GNUmake'

# CMake formatting
#- repo: https://github.com/cheshirekow/cmake-format-precommit
#  rev: v0.6.13
#  hooks:
#  - id: cmake-format
#    additional_dependencies: [pyyaml]
#    types: [file]
#    files: (\.cmake|CMakeLists.txt)(.in)?$

# C++ formatting
# clang-format

# Python: Ruff linter & formatter
#   https://docs.astral.sh/ruff/
- repo: https://github.com/astral-sh/ruff-pre-commit
  rev: v0.6.7
  hooks:
    # Run the linter
    - id: ruff
      args: [--fix, --exit-non-zero-on-fix]
    # Run the formatter
    - id: ruff-format

# Jupyter Notebooks: clean up all cell outputs
- repo: https://github.com/roy-ht/pre-commit-jupyter
  rev: v1.2.1
  hooks:
  - id: jupyter-notebook-cleanup
    args:
      - --pin-patterns
      - "[pin];[donotremove]"
      # - --remove-kernel-metadata

# Checks the manifest for missing files (native support)
- repo: https://github.com/mgedmin/check-manifest
  rev: "0.49"
  hooks:
  - id: check-manifest
    # This is a slow hook, so only run this if --hook-stage manual is passed
    stages: [manual]
    additional_dependencies: [cmake, ninja]