.pre-commit-config.yaml.jinja

{# We cannot use the same pre-commit config as MQT's because paths don't match
   and it's designed only for Odoo 13.0+, so we design our own version, which
   should be as close as possible to MQT's -#}

{#- This namespace holds repo versions #}
{%- set proj_rev = namespace() %}
{%- set proj_rev.ruff = "v0.1.3" %}
{%- set proj_rev.pre_commit_hooks = "v4.5.0" %}
{%- set proj_rev.odoo_pre_commit_hooks = "v0.0.29" %}
{%- if odoo_version < 16 %}
  {%- set proj_rev.pylint_odoo = "v8.0.0" %}
{%- elif odoo_version < 17 %}
  {%- set proj_rev.pylint_odoo = "v8.0.20" %}
{%- elif odoo_version < 18 %}
  {%- set proj_rev.pylint_odoo = "v9.0.4" %}
{%- else %}
  {%- set proj_rev.pylint_odoo = "v9.1.3" %}
  {%- set proj_rev.ruff = "v0.6.8" %}
  {%- set proj_rev.pre_commit_hooks = "v4.6.0" %}
  {%- set proj_rev.odoo_pre_commit_hooks = "v0.0.33" %}
{%- endif -%}

exclude: |
  (?x)
  # NOT INSTALLABLE ADDONS
  # END NOT INSTALLABLE ADDONS
  # Files and folders generated by bots, to avoid loops
  /static/description/index\.html$|
  # Files that fail if changed manually
  .*\.(diff|patch)$|
  # Library files can have extraneous formatting (even minimized)
  /static/(src/)?lib/|
  # You don't usually want a bot to modify your legal texts
  (LICENSE.*|COPYING.*)
default_language_version:
  python: python3
  node: "18.17.1"
repos:
  - repo: local
    hooks:
      - id: forbidden-files
        name: forbidden files
        entry: found forbidden files; remove them
        language: fail
        files: "\\.rej$"
  - &maintainer_tools
    repo: https://github.com/oca/maintainer-tools
    rev: 400ffa99242c8b225ab4d34de78721a68b292a61
    hooks:
      # update the NOT INSTALLABLE ADDONS section above
      - id: oca-update-pre-commit-excluded-addons
        args:
          - --addons-dir
          - odoo/custom/src/private
  {% if odoo_version >= 14 -%}
  - repo: https://github.com/OCA/odoo-pre-commit-hooks
    rev: {{ proj_rev.odoo_pre_commit_hooks }}
    hooks:
      - id: oca-checks-odoo-module
      - id: oca-checks-po
        args: ["--fix"]
  {% endif -%}
  {% if odoo_version >= 13 -%}
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: {{ proj_rev.ruff }}
    hooks:
      - id: ruff
        args: [--fix, --exit-non-zero-on-fix]
      - id: ruff-format
  {% else -%}
  - repo: https://github.com/psf/black
    rev: 23.9.1
    hooks:
      - id: black
        additional_dependencies: ["click<=8.1.7"]
  - repo: https://github.com/PyCQA/isort
    rev: 5.12.0
    hooks:
      - id: isort
        name: isort except __init__.py
        args: [--settings, .]
        exclude: /__init__\.py$
  - repo: https://github.com/pycqa/flake8
    rev: 6.1.0
    hooks:
      - id: flake8
        name: flake8 except __init__.py, __manifest__.py
        args: ["--extend-ignore=B023"]
        exclude: /__(?:init|manifest)__\.py$
        additional_dependencies: ["flake8-bugbear==23.7.10", "importlib-metadata<=6.8.0"]
      - id: flake8
        name: flake8 only __init__.py
        args: ["--extend-ignore=F401"] # ignore unused imports in __init__.py
        files: /__init__\.py$
        additional_dependencies: ["flake8-bugbear==23.7.10", "importlib-metadata<=6.8.0"]
      - id: flake8
        name: flake8 only __manifest__.py
        args: ["--extend-ignore=B018"] # ignore found useless expression in __manifest__.py
        files: /__manifest__\.py$
        additional_dependencies: ["flake8-bugbear==23.7.10", "importlib-metadata<=6.8.0"]
  {% endif -%}
  - repo: https://github.com/pre-commit/mirrors-prettier
    # HACK https://github.com/prettier/prettier/issues/15696
    rev: v2.7.1
    hooks:
      - id: prettier
        name: prettier + plugin-xml
        args: [--plugin=@prettier/plugin-xml]
        additional_dependencies:
          # HACK https://github.com/prettier/pre-commit/issues/16#issuecomment-713474520
          - prettier@2.7.1
          - "@prettier/plugin-xml@v2.2.0"
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: {{ proj_rev.pre_commit_hooks }}
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      {%- if odoo_version >= 11 %}
      - id: debug-statements
      {%- endif %}
      - id: fix-encoding-pragma
        {%- if odoo_version >= 11 %}
        args: ["--remove"]
        {%- endif %}
      - id: check-case-conflict
      - id: check-docstring-first
      - id: check-executables-have-shebangs
      - id: check-merge-conflict
        args: [--assume-in-merge]
        exclude: \.rst$ # HACK https://github.com/pre-commit/pre-commit-hooks/issues/985
      - id: check-symlinks
      - id: check-xml
      - id: mixed-line-ending
        args: ["--fix=lf"]
  - repo: https://github.com/OCA/pylint-odoo
    rev: {{ proj_rev.pylint_odoo }}
    hooks:
      - id: pylint_odoo
        name: pylint with optional checks
        args:
          - --rcfile=.pylintrc
          - --exit-zero
        verbose: true
      - id: pylint_odoo
        args:
          - --rcfile=.pylintrc-mandatory
  - repo: https://github.com/pre-commit/mirrors-eslint
    rev: v8.49.0
    hooks:
      - id: eslint
        verbose: true
        args:
          - --color
          - --fix
  - <<: *maintainer_tools
    hooks:
      # Generate readme is last, so its digest includes changes from above
      - id: oca-gen-addon-readme
        args:
          - --addons-dir=odoo/custom/src/private
          - --org-name={{ project_author }}
          - --repo-name={{ project_name }}
          - --convert-fragments-to-markdown
          - --gen-html
          - --if-fragments-changed
          - --branch={{ odoo_version }}
          - --template-filename=.module-readme.rst.j2