.pre-commit-config.yaml

##
## Copyright 2019-2025 the kikuchipy developers
##
## This file is part of kikuchipy.
##
## kikuchipy is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## kikuchipy is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.
##
repos:
  # https://docs.astral.sh/ruff/configuration
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.9.1
    hooks:
      - id: ruff
      - id: ruff-format
  # https://black.readthedocs.io/en/stable/index.html
  - repo: https://github.com/psf/black-pre-commit-mirror
    rev: 24.10.0
    hooks:
      - id: black-jupyter
        files: \.ipynb
        args: [--line-length=77]
  - repo: https://github.com/johann-petrak/licenseheaders.git
    rev: v0.8.8
    hooks:
      - id: licenseheaders
        args: ["-t", ".license.tmpl", "-cy", "-n", "kikuchipy", "-f"]

# https://pre-commit.ci/#configuration
ci:
  autofix_prs: false
  # TODO: Remove skip once (nearly) all files are formatted with the license template
  skip: [licenseheaders]