.pre-commit-config.yaml

##
## Copyright 2019-2025 the orix developers
##
## This file is part of orix.
##
## orix 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.
##
## orix 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 orix. If not, see <http://www.gnu.org/licenses/>.
##
repos:
  - repo: https://github.com/psf/black
    rev: 24.10.0
    hooks:
      - id: black
      - id: black-jupyter
        files: \.ipynb
        args: [--line-length=77]
  - repo: https://github.com/pycqa/isort
    rev: 5.13.2
    hooks:
      - id: isort
        name: isort (python)
        args:
          [--profile=black, --filter-files, --force-sort-within-sections]
  - repo: https://github.com/johann-petrak/licenseheaders.git
    rev: 'v0.8.8'
    hooks:
        - id: licenseheaders
          args: ["-t", ".license.tmpl", "-cy", "-n", "orix", "-f"]
# https://pre-commit.ci/#configuration
ci:
  # Don't run automatically on PRs, instead add the comment
  # "pre-commit.ci autofix" on a pull request to manually trigger auto-fixing
  autofix_prs: false
  # TODO: Remove skip once (nearly) all files are formatted with the license template
  skip: [licenseheaders]