.pre-commit-config.yaml

ci:
  autofix_prs: true
  autoupdate_schedule: quarterly

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - id: debug-statements
      - id: mixed-line-ending
        args: [--fix=lf]
      - id: file-contents-sorter
        files: |
          (?x)^(
              .github/workflows/script/formatScan/nlp_dict.txt
          )$
        args: [--unique]
      - id: end-of-file-fixer
        files: (.*\.(py|md|rst|yaml|yml))$
        exclude: |
          (?x)^(
              examples/.+
          )$
      - id: check-json
      - id: check-yaml
        exclude: |
          (?x)^(
            conda_meta/meta.yaml|
            docker/chart/templates/pytorchjob.yaml|
            docker/chart/templates/pvc.yaml|
            workflows/compression_aware_training/chart/templates/workflowTemplate.yaml|
            .gitpod.yml
          )$
      - id: requirements-txt-fixer
        exclude: |
          (?x)^(
              examples/.+
          )$
      - id: trailing-whitespace
        files: (.*\.(py|rst|cmake|yaml|yml))$
        exclude: |
          (?x)^(
              examples/.+
          )$

  - repo: https://github.com/codespell-project/codespell
    rev: v2.3.0
    hooks:
      - id: codespell
        args: [-w, --ignore-words=.github/workflows/script/formatScan/nlp_dict.txt]
        exclude: |
          (?x)^(
              .+.po|.+.map|.+.js.map|.+.css.map|
              .github/workflows/script/formatScan/nlp_dict.txt|
              docker/third_party_programs_docker.txt|
              intel_extension_for_transformers/transformers/llm/evaluation/hf_eval/datasets/cnn_validation.json|
              examples/huggingface/pytorch/text-generation/inference/prompt.json|
              intel_extension_for_transformers/transformers/runtime/oneDNN-THIRD-PARTY-PROGRAMS|
              docker/intel-tensorflow-third-party-programs.txt|
              .github/workflows/sample_data/alpaca_data_sample_45.json
          )$

  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.5.5
    hooks:
      - id: insert-license
        files: |
          (?x)^(
            (intel_extension_for_transformers|workflows|tests)/.*(py|yaml|yml|sh)
          )$
        args:
          [
            --license-filepath=.github/license_template.txt,
            --use-current-year,
            --detect-license-in-X-top-lines=40,
            --skip-license-insertion-comment=Copyright,
          ]
      - id: insert-license
        files: |
          (?x)^(
            (intel_extension_for_transformers|workflows|tests)/.*(ts|js|cpp|hpp)
          )$
        args:
          [
            --license-filepath=.github/license_template.txt,
            --use-current-year,
            --detect-license-in-X-top-lines=40,
            --skip-license-insertion-comment=Copyright,
            --comment-style=//,
          ]
      - id: insert-license
        files: |
          (?x)^(
            (intel_extension_for_transformers|workflows|tests)/.*(html|svelte)
          )$
        args:
          [
            --license-filepath=.github/license_template.txt,
            --use-current-year,
            --detect-license-in-X-top-lines=40,
            --skip-license-insertion-comment=Copyright,
            --comment-style=<!--| |-->,
          ]

  - repo: https://github.com/asottile/yesqa
    rev: v1.5.0
    hooks:
      - id: yesqa
        name: Unused noqa

  # - repo: https://github.com/pycqa/isort
  #   rev: 5.13.2
  #   hooks:
  #     - id: isort
  #       args: [--profile=black, --line-length=120]
  #       exclude: |
  #         (?x)^(
  #             examples/.+|
  #             .*\__init__.py
  #         )$

  # - repo: https://github.com/pre-commit/mirrors-prettier
  #   rev: "v4.0.0-alpha.8" # Use the sha / tag you want to point at
  #   hooks:
  #     - id: prettier
  #       args: [--print-width=120]
  #       types_or: [yaml, html, css, scss, javascript, json, ts]
  #       additional_dependencies:
  #         - prettier@3.2.5

  - repo: https://github.com/PyCQA/docformatter
    rev: v1.7.5
    hooks:
      - id: docformatter
        args: [
            --in-place,
            --wrap-summaries=0, # 0 means disable wrap
            --wrap-descriptions=0, # 0 means disable wrap
            --black,
            --style=google,
          ]
        exclude: |
          (?x)^(
              examples/.+
          )$

  # - repo: https://github.com/psf/black.git
  #   rev: 24.3.0
  #   hooks:
  #     - id: black
  #       files: (.*\.py)$
  #       args: [--line-length=120]
  #       exclude: |
  #         (?x)^(
  #             examples/.+
  #         )$

  # - repo: https://github.com/asottile/blacken-docs
  #   rev: 1.16.0
  #   hooks:
  #     - id: blacken-docs
  #       args: [--line-length=120, --skip-errors]
  #       additional_dependencies:
  #         - black==24.3.0
  #       exclude: |
  #         (?x)^(
  #             examples/.+|
  #             docs/source-app
  #         )$

  # - repo: https://github.com/astral-sh/ruff-pre-commit
  #   rev: v0.3.5
  #   hooks:
  #     - id: ruff
  #       args: [--fix, --exit-non-zero-on-fix, --no-cache]
  #       exclude: |
  #         (?x)^(
  #             examples/.+
  #         )$