# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks

exclude: |
  (?x)(
    .*/assets/.*
    | .*/brookesia_apps_squareline/ui/.*
    | .*/brookesia_apps_ai_profile/ui/.*
    | .*src/fonts/.*/.*
    | .*py
    | .*espressif__
    | .*private_key.pem
    | .*/boards/(?!.*sdkconfig\.defaults\.board$).*
    | agent/brookesia_agent_coze/.*esp_coze.*
    | apps/brookesia_app_ai_profile/ui/.*
    | apps/brookesia_app_squareline/ui/.*
    | apps/brookesia_app_timer/ui/.*
    | apps/brookesia_app_pos/ui/.*
    | apps/brookesia_app_usbd_ncm/ui/.*
    | core/brookesia_core/gui/squareline/.*
    | core/brookesia_core/systems/speaker/widgets/quick_settings/ui/.*
    | products/speaker/tools/patches/.*
    | docs/.*
  )
repos:
  - repo: https://github.com/igrr/astyle_py.git
    rev: v1.0.5
    hooks:
      - id: astyle_py
        args: ['--style=otbs', '--attach-namespaces', '--attach-classes', '--indent=spaces=4', '--convert-tabs', '--align-pointer=name', '--align-reference=name', '--keep-one-line-statements', '--pad-header', '--pad-oper']

  - repo: https://github.com/espressif/check-copyright/
    rev: v1.0.3
    hooks:
      - id: check-copyright
        args: ['--config', 'check_copyright_config.yaml']

  - repo: https://github.com/PyCQA/flake8
    rev: 5.0.4
    hooks:
      - id: flake8
        types: [python]
        args: ['--config=.flake8', '--tee', '--benchmark']

  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - id: trailing-whitespace
        # note: whitespace exclusions use multiline regex, see https://pre-commit.com/#regular-expressions
        # items are:
        # 1 - some file extensions
        # 2 - any file matching *test*/*expected* (for host tests, if possible use this naming pattern always)
        # 3 - any file with known-warnings in the name
        # 4 - any directory named 'testdata'
        # 5 - protobuf auto-generated files
        exclude: &whitespace_excludes |
          (?x)^(
            .+\.(md|rst|map|bin)|
            .+test.*\/.*expected.*|
            .+known-warnings.*|
            .+\/testdata\/.+|
            .*_pb2.py|
            .*.pb-c.h|
            .*.pb-c.c|
            .*.yuv
          )$
      - id: end-of-file-fixer
        exclude: *whitespace_excludes
      - id: check-executables-have-shebangs
      - id: check-shebang-scripts-are-executable
      - id: mixed-line-ending
        args: ['-f=lf']
      - id: double-quote-string-fixer
      - id: no-commit-to-branch
        name: Do not use more than one slash in the branch name
        args: ['--pattern', '^[^/]*/[^/]*/']
      - id: no-commit-to-branch
        name: Do not use uppercase letters in the branch name
        args: ['--pattern', '^[^A-Z]*[A-Z]']
  - repo: local
    hooks:
      - id: check-executables
        name: Check File Permissions
        entry: .gitlab/tools/check_executables.py --action executables
        language: python
        types: [executable]
        exclude: '\.pre-commit/.+'
      - id: check-executable-list
        name: Validate executable-list.txt
        entry: .gitlab/tools/check_executables.py --action list
        language: python
        pass_filenames: false
        always_run: true
      - id: check-forbidden-strings
        name: Check for forbidden strings in sdkconfig files
        entry: ./.gitlab/tools/check_forbidden_strings.py -s ./.gitlab/tools/forbidden_strings.txt -f
        language: python
        files: '(^|/)sdkconfig[^/]*$'
  - repo: https://github.com/espressif/conventional-precommit-linter
    rev: v1.8.0
    hooks:
      - id: conventional-precommit-linter
        stages: [commit-msg]
        args:
          - --subject-min-length=15
          - --body-max-line-length=200
  - repo: https://github.com/codespell-project/codespell
    rev: v2.3.0
    hooks:
    - id: codespell
      args: [-w]