.pre-commit-config.yaml

# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.4.0
    hooks:
      - id: trailing-whitespace
        exclude: ansible_collections/arista/avd/molecule
      - id: end-of-file-fixer
        exclude_types: [svg, json]
        exclude: ansible_collections/arista/avd/molecule
      - id: check-added-large-files
        exclude: (ansible_collections/arista/avd/molecule|pickle$)
      - id: check-merge-conflict
        exclude: ansible_collections/arista/avd/molecule

  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.5.4
    hooks:
      - name: Check and insert license on Python files
        id: insert-license
        exclude: ansible_collections/arista/avd/(plugins/module_utils|tests/unit(/module_utils|/modules|))/__init__.py
        files: .*\.py$
        args:
          - --license-filepath
          - development/license-short.txt
          - --use-current-year
          - --allow-past-years
          - --fuzzy-match-generates-todo
          - --no-extra-eol

      - name: Check and insert license on select YAML files
        id: insert-license
        files: ansible_collections/arista/avd/roles/.*/(handlers|schemas|tasks)/.*\.yml$
        args:
          - --license-filepath
          - development/license-short.txt
          - --use-current-year
          - --allow-past-years
          - --fuzzy-match-generates-todo
          - --no-extra-eol

      - name: Check and insert license on Jinja2 files
        id: insert-license
        files: .*\.j2$
        exclude: ansible_collections/arista/avd/molecule.*
        args:
          - --license-filepath
          - development/license-short.txt
          - --use-current-year
          - --allow-past-years
          - --fuzzy-match-generates-todo
          - --comment-style
          - '{#||#}'
          - --no-extra-eol

      - name: Check and insert license on Markdown files
        id: insert-license
        files: .*\.md$
        exclude: (ansible_collections/arista/avd/molecule|.github|ansible_collections/arista/avd/examples/.+/documentation/).*
        args:
          - --license-filepath
          - development/license-short.txt
          - --use-current-year
          - --allow-past-years
          - --fuzzy-match-generates-todo
          - --comment-style
          - '<!--|  ~|  -->'

  # - repo: https://github.com/pre-commit/mirrors-autopep8
  #   rev: 'v1.5.6'  # Use the sha / tag you want to point at
  #   hooks:
  #   -   id: autopep8

  - repo: https://github.com/pycqa/isort
    rev: 5.13.2
    hooks:
      - id: isort
        name: Check for changes when running isort on all python files

  - repo: https://github.com/psf/black
    rev: 23.12.1
    hooks:
      - id: black
        name: Check for changes when running Black on all python files

  - repo: https://github.com/pycqa/flake8
    rev: 4.0.1 # Note ansible-test uses pycodestyle 2.8.0 which is part of this tagged release of flake8
    hooks:
      - id: flake8
        name: Check for Flake8 errors on Python files
        # ignoring errors and selecting line length as per
        # https://github.com/ansible/ansible/blob/devel/test/lib/ansible_test/_util/controller/sanity/pep8/current-ignore.txt
        types: [python]
        # The cv_client api is generated from proto files, so it should not be linted.
        exclude: ^ansible_collections/arista/avd/plugins/plugin_utils/cv_client/api/

  - repo: https://github.com/pycqa/pylint
    rev: "v2.16.1"
    hooks:
      - id: pylint # Use pylintrc file in repository
        name: Check for Linting errors on Python files
        description: This hook runs pylint.
        types: [python]
        args:
          # Suppress duplicate code for modules header
          - -d duplicate-code

  - repo: https://github.com/adrienverge/yamllint.git
    rev: "v1.23.0"
    hooks:
      - id: yamllint
        name: Check for Linting errors on YAML files
        description: This hook runs yamllint.
        entry: yamllint
        language: python
        types: [file, yaml]
        args: [--strict, -c=.github/yamllintrc]

  - repo: https://github.com/aristanetworks/j2lint.git
    rev: "742a25e"
    hooks:
      - id: j2lint
        name: Check for Linting errors on Jinja2 files

  - repo: local
    hooks:

      - id: docs-plugin-modules
        name: Build documentation for collection modules and action plugins
        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/"
        language: system
        types: [python]
        files: ansible_collections/arista/avd/plugins/modules/

      - id: docs-plugin-filter
        name: Build documentation for collection filter plugins
        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Filter_plugins/"
        language: system
        types: [python]
        files: ansible_collections/arista/avd/plugins/filter/

      - id: docs-plugin-test
        name: Build documentation for collection test plugins
        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Test_plugins/"
        language: system
        types: [python]
        files: ansible_collections/arista/avd/plugins/test/

      - id: docs-plugin-vars
        name: Build documentation for collection var plugins
        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Vars_plugins/"
        language: system
        types: [python]
        files: ansible_collections/arista/avd/plugins/vars/

      - id: schemas
        name: Build AVD Schemas and Docs
        entry: sh -c 'exec python-avd/scripts/build-schemas.py'
        language: system
        files: ansible_collections/arista/avd/roles/[a-z_]+/schemas
        pass_filenames: false

  - repo: https://github.com/igorshubovych/markdownlint-cli
    rev: v0.32.1
    hooks:
      - id: markdownlint
        name: Check for Linting errors on MarkDown files
        args:
          - --config=.github/.markdownlint.yaml
          - --ignore-path=.github/.markdownlintignore
          - --fix