.pre-commit-config.yaml

# Configuration file for pre-commit (https://pre-commit.com/).
# Please run `pre-commit run --all-files` when adding or changing entries.

repos:
  - repo: local
    hooks:
      - id: alejandra
        name: alejandra
        entry: alejandra
        files: \.nix$
        language: system
        stages: [commit]

      # TODO: Reintroduce once https://github.com/NixOS/nixpkgs/pull/273831 is in use
      #      - id: check-github-workflows
      #        name: check-github-workflows
      #        description: Validate GitHub Workflows
      #        entry: check-jsonschema
      #        args: [--builtin-schema=vendor.github-workflows]
      #        files: ^\.github/workflows/[^/]+$
      #        types: [yaml]
      #        language: system
      #        stages: [commit]

      - id: deadnix
        name: deadnix
        entry: deadnix
        args: [--edit, --fail]
        files: \.nix$
        language: system
        stages: [commit]

      - id: gitlint
        name: gitlint
        entry: gitlint
        args: [--staged, --msg-filename]
        language: system
        stages: [commit-msg]

      - id: jupyter-clean
        name: jupyter-clean
        entry: jupyter
        args:
          [nbconvert, --clear-output, --ClearMetadataPreprocessor.enabled=True]
        types: [jupyter]
        language: system
        stages: [commit]

      - id: nbqa-black
        name: nbqa-black
        description: Run 'black' on Jupyter notebooks
        entry: nbqa
        args: [black]
        require_serial: true
        types_or: [jupyter, markdown]
        language: system
        stages: [commit]

      - id: nbqa-isort
        name: nbqa-isort
        description: Run 'isort' on Jupyter notebooks
        entry: nbqa
        args: [isort]
        require_serial: true
        types_or: [jupyter, markdown]
        language: system
        stages: [commit]

      - id: nbqa-mypy
        name: nbqa-mypy
        description: Run 'mypy' on Jupyter notebooks
        entry: nbqa
        args: [mypy]
        require_serial: true
        types_or: [jupyter, markdown]
        language: system
        stages: [commit]

      - id: nbqa-pydocstyle
        name: nbqa-pydocstyle
        description: Run 'pydocstyle' on Jupyter notebooks
        entry: nbqa
        args: [pydocstyle]
        require_serial: true
        types_or: [jupyter, markdown]
        language: system
        stages: [commit]

      - id: nbqa-pylint
        name: nbqa-pylint
        description: Run 'pylint' on Jupyter notebooks
        entry: nbqa
        args: [pylint, --include-naming-hint=y]
        require_serial: true
        types_or: [jupyter, markdown]
        language: system
        stages: [commit]

      - id: pathchk
        name: pathchk
        entry: pathchk
        args: [--portability]
        types: [file]
        exclude: ^([a-zA-Z0-9._][a-zA-Z0-9._-]+)(/[a-zA-Z0-9._][a-zA-Z0-9._-]+)*$ # https://lists.gnu.org/archive/html/coreutils/2023-01/msg00006.html
        language: system
        stages: [commit]

      - id: prettier
        name: prettier
        entry: prettier
        args: [--ignore-unknown, --list-different, --write]
        types: [text]
        language: system
        stages: [commit]

      - id: shellcheck
        name: shellcheck
        entry: shellcheck
        types: [shell]
        language: system
        stages: [commit]

      # TODO: Kill if https://github.com/pre-commit/identify/issues/350 is fixed
      - id: shellcheck_other
        name: shellcheck other
        entry: shellcheck
        files: ^\.envrc$
        language: system
        stages: [commit]

      - id: shfmt
        name: Format shell scripts
        entry: shfmt
        args: [--case-indent, --indent=4, --list, --space-redirects, --write]
        types: [shell]
        language: system
        stages: [commit]

      # TODO: Kill if https://github.com/pre-commit/identify/issues/350 is fixed
      - id: shfmt_other
        name: Format other shell scripts
        entry: shfmt
        args: [--case-indent, --indent=4, --list, --space-redirects, --write]
        files: ^\.envrc$
        language: system
        stages: [commit]

      - id: statix
        name: statix
        entry: statix
        args: [check]
        files: \.nix$
        pass_filenames: false
        language: system
        stages: [commit]
# TODO: Re-enable when https://github.com/NixOS/nixpkgs/issues/270805 is fixed
#  - repo: meta
#    hooks:
#      - id: check-useless-excludes