.pre-commit-config.yaml

---
minimum_pre_commit_version: 2.4.0
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - id: check-merge-conflict   # Check for files that contain merge conflict strings.
        args: [--assume-in-merge]
      - id: trailing-whitespace    # Trim trailing whitespace.
        args: [--markdown-linebreak-ext=md]
      - id: mixed-line-ending      # Ensure files use UNIX-style newlines only.
        args: [--fix=lf]
      - id: end-of-file-fixer      # Ensure files end with a newline.
      - id: check-ast              # Check whether files parse as valid Python.

  # ----- Formatting ---------------------------------------------------------------------------->
  - repo: https://github.com/saltstack/pre-commit-remove-import-headers
    rev: 1.1.0
    hooks:
      - id: remove-import-headers

  - repo: local
    hooks:
      - id: check-cli-examples
        name: Check CLI examples on execution modules
        entry: python .pre-commit-hooks/check-cli-examples.py
        language: python
        files: ^src/saltext/zfs/modules/.*\.py$

  - repo: local
    hooks:
      - id: check-docs
        name: Check rST doc files exist for modules/states
        entry: python .pre-commit-hooks/make-autodocs.py
        language: python
        pass_filenames: false

  - repo: https://github.com/saltstack/salt-rewrite
    # Automatically rewrite code with known rules
    rev: 2.5.2
    hooks:
      - id: salt-rewrite
        alias: rewrite-docstrings
        name: Salt extensions docstrings auto-fixes
        files: ^src/saltext/zfs/.*\.py$
        args: [--silent]

  - repo: https://github.com/saltstack/salt-rewrite
    # Automatically rewrite code with known rules
    rev: 2.5.2
    hooks:
      - id: salt-rewrite
        alias: rewrite-tests
        name: Rewrite the test suite
        files: ^tests/.*\.py$
        args: [--silent, -E, fix_docstrings]

  - repo: https://github.com/asottile/pyupgrade
    rev: v3.16.0
    hooks:
      - id: pyupgrade
        name: Rewrite Code to be Py3.8+
        args: [
          --py38-plus
        ]
        exclude: src/saltext/zfs/version.py

  - repo: https://github.com/PyCQA/isort
    rev: 5.13.2
    hooks:
      - id: isort
        args: [
          --py 38,
        ]
        exclude: src/saltext/zfs/(__init__|version).py

  - repo: https://github.com/psf/black
    rev: 24.8.0
    hooks:
      - id: black
        args: [-l 100]
        exclude: src/saltext/zfs/version.py

  - repo: https://github.com/adamchainz/blacken-docs
    rev: 1.18.0
    hooks:
      - id: blacken-docs
        args: [--skip-errors]
        files: ^(docs/.*\.rst|src/saltext/zfs/.*\.py)$
        additional_dependencies:
          - black==24.2.0
  # <---- Formatting -----------------------------------------------------------------------------

  # ----- Security ------------------------------------------------------------------------------>
  - repo: https://github.com/PyCQA/bandit
    rev: 1.7.9
    hooks:
      - id: bandit
        alias: bandit-salt
        name: Run bandit against the code base
        args: [--silent, -lll, --skip, B701]
        exclude: src/saltext/zfs/version.py
  - repo: https://github.com/PyCQA/bandit
    rev: 1.7.9
    hooks:
      - id: bandit
        alias: bandit-tests
        name: Run bandit against the test suite
        args: [--silent, -lll, --skip, B701]
        files: ^tests/.*
  # <---- Security -------------------------------------------------------------------------------

  # ----- Code Analysis ------------------------------------------------------------------------->

  - repo: local
    hooks:
      - id: nox
        alias: lint-src
        name: Lint Source Code
        language: python
        entry: nox -e lint-code-pre-commit --
        files: ^((setup|noxfile)|src/.*)\.py$
        require_serial: true
        additional_dependencies:
          - nox==2024.4.15
          - uv==0.4.0  # Makes this hook much faster

      - id: nox
        alias: lint-tests
        name: Lint Tests
        language: python
        entry: nox -e lint-tests-pre-commit --
        files: ^tests/.*\.py$
        require_serial: true
        additional_dependencies:
          - nox==2024.4.15
          - uv==0.4.0  # Makes this hook much faster

  - repo: https://github.com/Mateusz-Grzelinski/actionlint-py
    rev: 1ca29a1b5d949b3586800190ad6cc98317cb43b8  # v1.7.1.15
    hooks:
      - id: actionlint
        additional_dependencies:
          - shellcheck-py>=0.9.0.5
  # <---- Code Analysis --------------------------------------------------------------------------