esp-idf/.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: v4.0.1
    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 directory named 'testdata'
        # 4 - protobuf auto-generated files
        exclude: &whitespace_excludes |
          (?x)^(
            .+\.(md|rst|map|bin)|
            .+test.*\/.*expected.*|
            .+\/testdata\/.+|
            .*_pb2.py|
            .*.pb-c.h|
            .*.pb-c.c|
            .*.yuv
          )$
      - id: end-of-file-fixer
        exclude: *whitespace_excludes
      - id: check-executables-have-shebangs
      - id: mixed-line-ending
        args: ['-f=lf']
      - id: double-quote-string-fixer
  - repo: https://github.com/PyCQA/flake8
    rev: 5.0.4
    hooks:
      - id: flake8
        args: ['--config=.flake8', '--tee', '--benchmark']
  - repo: https://github.com/pycqa/isort
    rev: 5.11.5  # python 3.7 compatible
    hooks:
      - id: isort
        name: isort (python)
        exclude: >
          (?x)^(
              .*_pb2.py
          )$
  - repo: local
    hooks:
      - id: check-executables
        name: Check File Permissions
        entry: tools/ci/check_executables.py --action executables
        language: python
        types: [executable]
        exclude: '\.pre-commit/.+'
      - id: check-executable-list
        name: Validate executable-list.txt
        entry: tools/ci/check_executables.py --action list
        language: python
        pass_filenames: false
        always_run: true
      - id: check-kconfigs
        name: Validate Kconfig files
        entry: tools/ci/check_kconfigs.py
        language: python
        files: '^Kconfig$|Kconfig.*$'
      - id: check-deprecated-kconfigs-options
        name: Check if any Kconfig Options Deprecated
        entry: tools/ci/check_deprecated_kconfigs.py
        language: python
        files: 'sdkconfig\.ci$|sdkconfig\.rename$|sdkconfig.*$'
      - id: cmake-lint
        name: Check CMake Files Format
        entry: cmakelint --linelength=120 --spaces=4 --filter=-whitespace/indent
        language: python
        additional_dependencies:
          - cmakelint==1.4.1
        files: 'CMakeLists.txt$|\.cmake$'
        exclude: '\/third_party\/'
      - id: check-codeowners
        name: Validate Codeowner File
        entry: tools/ci/check_codeowners.py ci-check
        language: python
        always_run: true
        files: '\.gitlab/CODEOWNERS'
        pass_filenames: false
      - id: check-rules-yml
        name: Check rules.yml all rules have at lease one job applied, all rules needed exist
        entry: tools/ci/check_rules_yml.py
        language: python
        files: '\.gitlab/ci/.+\.yml|\.gitlab-ci.yml|\.gitmodules'
        pass_filenames: false
        additional_dependencies:
          - PyYAML == 5.3.1
      - id: check-generated-rules
        name: Check rules are generated (based on .gitlab/ci/dependencies/dependencies.yml)
        entry: tools/ci/generate_rules.py
        language: python
        files: '\.gitlab/ci/dependencies/.+|\.gitlab/ci/.*\.yml'
        pass_filenames: false
        additional_dependencies:
          - PyYAML == 5.3.1
      - id: mypy-check
        name: Check type annotations in python files
        entry: tools/ci/check_type_comments.py
        additional_dependencies:
          - 'mypy==0.940'
          - 'mypy-extensions==0.4.3'
          - 'types-setuptools==57.4.14'
          - 'types-PyYAML==0.1.9'
        exclude: >
          (?x)^(
              .*_pb2.py
          )$
        language: python
        types: [python]
      - id: check-requirement-files
        name: Check requirement files
        entry: tools/ci/check_requirement_files.py
        additional_dependencies:
          - 'jsonschema'
        language: python
        files: 'tools/requirements.+|tools/requirements/.+'
        pass_filenames: false
      - id: check-tools-files-patterns
        name: Check tools dir files patterns
        entry: tools/ci/check_tools_files_patterns.py
        language: python
        files: '^tools/.+'
        additional_dependencies:
          - PyYAML == 5.3.1
        pass_filenames: false
      - id: check-generated-soc-caps-kconfig
        name: Check soc caps kconfig files are generated (based on components/soc/IDF_TARGET/include/soc/soc_caps.h)
        entry: tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py -d 'components/soc/*/include/soc/' 'components/esp_rom/*/' 'components/spi_flash/*/'
        language: python
        files: 'components/soc/.+/include/soc/.+_caps\.h|components/esp_rom/.+/.+_caps\.h|kconfig\.soc_caps.in|components/spi_flash/.+/.+_caps\.h'
        pass_filenames: false
        additional_dependencies:
          - pyparsing
      - id: check-all-apps-readmes
        name: Check if all apps readme files match given .build-test-rules.yml files. Modify the supported target tables
        entry: tools/ci/check_build_test_rules.py check-readmes
        language: python
        files: 'tools/test_apps/.+|examples/.+|components/.+|tools/idf_py_actions/constants.py|tools/ci/check_build_test_rules.py'
        require_serial: true
        additional_dependencies:
          - PyYAML == 5.3.1
          - idf_build_apps
      - id: sort-build-test-rules-ymls
        name: sort .build-test-rules.yml files
        entry: tools/ci/check_build_test_rules.py sort-yaml
        language: python
        files: '\.build-test-rules\.yml'
        additional_dependencies:
          - PyYAML == 5.3.1
          - ruamel.yaml
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
      - id: file-contents-sorter
        files: 'tools\/ci\/(executable-list\.txt|mypy_ignore_list\.txt|check_copyright_ignore\.txt)'
  - repo: https://github.com/espressif/check-copyright/
    rev: v1.0.3
    hooks:
      - id: check-copyright
        args: ['--ignore', 'tools/ci/check_copyright_ignore.txt', '--config', 'tools/ci/check_copyright_config.yaml']
  - repo: https://github.com/espressif/esp-idf-sbom.git
    rev: v0.11.0
    hooks:
      - id: validate-sbom-manifest
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`# 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`
Add copyright check to pre-commit-config 2021-09-08 15:38:14 +00:00			`rev: v4.0.1`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`hooks:`
			`- id: trailing-whitespace`
pre-commit: Rearrange the YAML file to avoid the warning Having a root level key that existed only to make an anchor led to a warning, instead create the anchor in the first place the key was used and then reference it later on. 2020-11-13 03:22:18 +00:00			`# 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 directory named 'testdata'`
feat(idf_monitor): move idf_monitor to separate repo 2023-01-16 12:44:37 +00:00			`# 4 - protobuf auto-generated files`
pre-commit: Rearrange the YAML file to avoid the warning Having a root level key that existed only to make an anchor led to a warning, instead create the anchor in the first place the key was used and then reference it later on. 2020-11-13 03:22:18 +00:00			`exclude: &whitespace_excludes \|`
style(editorconfig): add indent style for yaml 2021-01-22 07:25:22 +00:00			`(?x)^(`
			`.+\.(md\|rst\|map\|bin)\|`
			`.+test.\/.expected.*\|`
			`.+\/testdata\/.+\|`
protobuf: Fix v4.21.0 (python) compatibility issue - Added auto-generated protobuf files (proto-c and python to pre-commit hook ignore lists 2022-05-27 04:05:46 +00:00			`.*_pb2.py\|`
			`.*.pb-c.h\|`
rgb_lcd: support yuv converter 2022-08-06 04:44:52 +00:00			`.*.pb-c.c\|`
			`.*.yuv`
style(editorconfig): add indent style for yaml 2021-01-22 07:25:22 +00:00			`)$`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`- id: end-of-file-fixer`
pre-commit: Rearrange the YAML file to avoid the warning Having a root level key that existed only to make an anchor led to a warning, instead create the anchor in the first place the key was used and then reference it later on. 2020-11-13 03:22:18 +00:00			`exclude: *whitespace_excludes`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`- id: check-executables-have-shebangs`
			`- id: mixed-line-ending`
			`args: ['-f=lf']`
pre-commit: Add double-quote-string-fixer and isort for python files 2020-12-21 04:42:29 +00:00			`- id: double-quote-string-fixer`
precommit: update flake8 repo url to use github Gitlab mirror repo has been deprecated. 2022-11-15 05:33:02 +00:00			`- repo: https://github.com/PyCQA/flake8`
Tools: Fix flake8 version 5 warnings 2022-08-10 07:01:57 +00:00			`rev: 5.0.4`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`hooks:`
			`- id: flake8`
			`args: ['--config=.flake8', '--tee', '--benchmark']`
pre-commit: Add double-quote-string-fixer and isort for python files 2020-12-21 04:42:29 +00:00			`- repo: https://github.com/pycqa/isort`
ci: fix isort py37 incompatible issue 2023-02-03 05:05:30 +00:00			`rev: 5.11.5 # python 3.7 compatible`
pre-commit: Add double-quote-string-fixer and isort for python files 2020-12-21 04:42:29 +00:00			`hooks:`
			`- id: isort`
			`name: isort (python)`
protobuf: Fix v4.21.0 (python) compatibility issue - Added auto-generated protobuf files (proto-c and python to pre-commit hook ignore lists 2022-05-27 04:05:46 +00:00			`exclude: >`
			`(?x)^(`
			`.*_pb2.py`
			`)$`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`- repo: local`
			`hooks:`
			`- id: check-executables`
			`name: Check File Permissions`
			`entry: tools/ci/check_executables.py --action executables`
			`language: python`
			`types: [executable]`
			`exclude: '\.pre-commit/.+'`
			`- id: check-executable-list`
			`name: Validate executable-list.txt`
			`entry: tools/ci/check_executables.py --action list`
			`language: python`
			`pass_filenames: false`
			`always_run: true`
			`- id: check-kconfigs`
			`name: Validate Kconfig files`
check_kconfigs and check_deprecated_kconfigs now use files arguments 2020-10-30 09:28:24 +00:00			`entry: tools/ci/check_kconfigs.py`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`language: python`
check_kconfigs and check_deprecated_kconfigs now use files arguments 2020-10-30 09:28:24 +00:00			`files: '^Kconfig$\|Kconfig.*$'`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`- id: check-deprecated-kconfigs-options`
			`name: Check if any Kconfig Options Deprecated`
check_kconfigs and check_deprecated_kconfigs now use files arguments 2020-10-30 09:28:24 +00:00			`entry: tools/ci/check_deprecated_kconfigs.py`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`language: python`
check_kconfigs and check_deprecated_kconfigs now use files arguments 2020-10-30 09:28:24 +00:00			`files: 'sdkconfig\.ci$\|sdkconfig\.rename$\|sdkconfig.*$'`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`- id: cmake-lint`
			`name: Check CMake Files Format`
cmake: Disable cmakelint indentation checks temporarily 2020-11-09 02:59:18 +00:00			`entry: cmakelint --linelength=120 --spaces=4 --filter=-whitespace/indent`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`language: python`
			`additional_dependencies:`
pre-commit: Use cmakelint 1.4.1 not older commit 2020-11-08 23:06:05 +00:00			`- cmakelint==1.4.1`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`files: 'CMakeLists.txt$\|\.cmake$'`
			`exclude: '\/third_party\/'`
			`- id: check-codeowners`
			`name: Validate Codeowner File`
			`entry: tools/ci/check_codeowners.py ci-check`
			`language: python`
ci: always run check-codeowners 2021-11-11 08:59:54 +00:00			`always_run: true`
CI: Add pre-commit for esp-idf project. add tools/ci/python_packages/idf_ci.py for some util functions used in ci and needs multi-os solution 2020-10-21 11:30:49 +00:00			`files: '\.gitlab/CODEOWNERS'`
			`pass_filenames: false`
ci(pre-commit): check if rules is updated and valid 2021-02-09 04:34:16 +00:00			`- id: check-rules-yml`
			`name: Check rules.yml all rules have at lease one job applied, all rules needed exist`
			`entry: tools/ci/check_rules_yml.py`
			`language: python`
ci: fix pre-commit check hook 2023-01-05 04:51:45 +00:00			`files: '\.gitlab/ci/.+\.yml\|\.gitlab-ci.yml\|\.gitmodules'`
ci(pre-commit): check if rules is updated and valid 2021-02-09 04:34:16 +00:00			`pass_filenames: false`
			`additional_dependencies:`
			`- PyYAML == 5.3.1`
			`- id: check-generated-rules`
			`name: Check rules are generated (based on .gitlab/ci/dependencies/dependencies.yml)`
ci: remove unused rules 2022-10-09 05:10:59 +00:00			`entry: tools/ci/generate_rules.py`
ci(pre-commit): check if rules is updated and valid 2021-02-09 04:34:16 +00:00			`language: python`
CI: fix pre-commit ci dependencie file pattern 2022-10-12 07:42:22 +00:00			`files: '\.gitlab/ci/dependencies/.+\|\.gitlab/ci/.*\.yml'`
ci(pre-commit): check if rules is updated and valid 2021-02-09 04:34:16 +00:00			`pass_filenames: false`
			`additional_dependencies:`
			`- PyYAML == 5.3.1`
Add mypy check to pre-commit-config 2021-02-01 08:18:16 +00:00			`- id: mypy-check`
			`name: Check type annotations in python files`
			`entry: tools/ci/check_type_comments.py`
Add copyright check to pre-commit-config 2021-09-08 15:38:14 +00:00			`additional_dependencies:`
bump version 2022-04-25 20:55:28 +00:00			`- 'mypy==0.940'`
Add copyright check to pre-commit-config 2021-09-08 15:38:14 +00:00			`- 'mypy-extensions==0.4.3'`
Tools: Fix the Python dependency checker by skipping not installed dependency sub-trees 2022-04-26 14:32:06 +00:00			`- 'types-setuptools==57.4.14'`
Tools: fix PyYAML deps for pre-commit hook Fix 'error: Library stubs not installed for "yaml" (or incompatiblewith Python 3.9)' 2022-05-23 06:50:37 +00:00			`- 'types-PyYAML==0.1.9'`
protobuf: Fix v4.21.0 (python) compatibility issue - Added auto-generated protobuf files (proto-c and python to pre-commit hook ignore lists 2022-05-27 04:05:46 +00:00			`exclude: >`
			`(?x)^(`
			`.*_pb2.py`
			`)$`
Add mypy check to pre-commit-config 2021-02-01 08:18:16 +00:00			`language: python`
			`types: [python]`
Tools: Make easier the detection of the list of Python features 2022-02-01 18:11:46 +00:00			`- id: check-requirement-files`
			`name: Check requirement files`
			`entry: tools/ci/check_requirement_files.py`
			`additional_dependencies:`
			`- 'jsonschema'`
			`language: python`
			`files: 'tools/requirements.+\|tools/requirements/.+'`
			`pass_filenames: false`
ci: move check_tools_files_patterns to pre-commit 2021-10-12 02:47:28 +00:00			`- id: check-tools-files-patterns`
			`name: Check tools dir files patterns`
			`entry: tools/ci/check_tools_files_patterns.py`
			`language: python`
			`files: '^tools/.+'`
			`additional_dependencies:`
			`- PyYAML == 5.3.1`
			`pass_filenames: false`
build-system: include soc_caps defines into kconfig Adds gen_soc_caps_kconfig.py which parses the soc caps (soc_caps.h) into a format that can be included in kconfig. 2021-11-05 09:23:24 +00:00			`- id: check-generated-soc-caps-kconfig`
			`name: Check soc caps kconfig files are generated (based on components/soc/IDF_TARGET/include/soc/soc_caps.h)`
spi_flash: only link flash vendor which is officially supported to save IRAM 2023-02-06 11:23:10 +00:00			`entry: tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py -d 'components/soc//include/soc/' 'components/esp_rom//' 'components/spi_flash/*/'`
build-system: include soc_caps defines into kconfig Adds gen_soc_caps_kconfig.py which parses the soc caps (soc_caps.h) into a format that can be included in kconfig. 2021-11-05 09:23:24 +00:00			`language: python`
spi_flash: only link flash vendor which is officially supported to save IRAM 2023-02-06 11:23:10 +00:00			`files: 'components/soc/.+/include/soc/.+_caps\.h\|components/esp_rom/.+/.+_caps\.h\|kconfig\.soc_caps.in\|components/spi_flash/.+/.+_caps\.h'`
build-system: include soc_caps defines into kconfig Adds gen_soc_caps_kconfig.py which parses the soc caps (soc_caps.h) into a format that can be included in kconfig. 2021-11-05 09:23:24 +00:00			`pass_filenames: false`
			`additional_dependencies:`
			`- pyparsing`
ci: add check job and pre-commit 2022-07-11 05:43:45 +00:00			`- id: check-all-apps-readmes`
			`name: Check if all apps readme files match given .build-test-rules.yml files. Modify the supported target tables`
			`entry: tools/ci/check_build_test_rules.py check-readmes`
			`language: python`
ci: run readme check when constants.py or check script updated 2023-04-21 03:37:14 +00:00			`files: 'tools/test_apps/.+\|examples/.+\|components/.+\|tools/idf_py_actions/constants.py\|tools/ci/check_build_test_rules.py'`
			`require_serial: true`
ci: add check job and pre-commit 2022-07-11 05:43:45 +00:00			`additional_dependencies:`
ci: make bringup process for check_build_test_rules.py more friendly 2022-09-06 06:58:16 +00:00			`- PyYAML == 5.3.1`
ci: add check job and pre-commit 2022-07-11 05:43:45 +00:00			`- idf_build_apps`
			`- id: sort-build-test-rules-ymls`
			`name: sort .build-test-rules.yml files`
			`entry: tools/ci/check_build_test_rules.py sort-yaml`
			`language: python`
			`files: '\.build-test-rules\.yml'`
			`additional_dependencies:`
ci: make bringup process for check_build_test_rules.py more friendly 2022-09-06 06:58:16 +00:00			`- PyYAML == 5.3.1`
ci: add check job and pre-commit 2022-07-11 05:43:45 +00:00			`- ruamel.yaml`
ci: put file sorter to the end of the pre-commit checking So that the sorter will be done at the end of the checking flow, we don't need to run pre-commit hooks again if another hook also take effect. 2021-04-26 07:58:03 +00:00			`- repo: https://github.com/pre-commit/pre-commit-hooks`
Add copyright check to pre-commit-config 2021-09-08 15:38:14 +00:00			`rev: v4.0.1`
ci: put file sorter to the end of the pre-commit checking So that the sorter will be done at the end of the checking flow, we don't need to run pre-commit hooks again if another hook also take effect. 2021-04-26 07:58:03 +00:00			`hooks:`
			`- id: file-contents-sorter`
tools: make copyright check configurable 2021-11-18 17:21:52 +00:00			`files: 'tools\/ci\/(executable-list\.txt\|mypy_ignore_list\.txt\|check_copyright_ignore\.txt)'`
Add SPDX license check 2022-06-23 14:39:12 +00:00			`- repo: https://github.com/espressif/check-copyright/`
ci(pre-commit): Use the newest copyright checker 2023-07-19 12:56:02 +00:00			`rev: v1.0.3`
Add SPDX license check 2022-06-23 14:39:12 +00:00			`hooks:`
			`- id: check-copyright`
			`args: ['--ignore', 'tools/ci/check_copyright_ignore.txt', '--config', 'tools/ci/check_copyright_config.yaml']`
feat: use esp-idf-sbom pre-commit plugin Currently sbom manifest is checked only in .gitmodules and this check is done in pre-commit and also in CI. Meaning it's running three times(pre-commit before push if user has it enabled, in CI as there is the pre-commit run again and again with test in CI). Since esp-idf-sbom contains a full manifest validation support and pre-commit plugin for it, let's use it. This removes all the current sbom testing and replaces it with a signle pre-commit plugin which validates all manifests files(sbom.yml, idf_component.yml, .gitmodules and also referenced manifests) in repository. Note that this checks all manifests, not only ones which were modified. The check is reasonably fast though, so it should not cause any problem. The reason for validating all manifest files is that we want to make sure that the sbom information in .gitmodules is updated too and that the hash recorded in .gitmodules is up-to-date. Meaning submodule update would not trigger this plugin, because no manifest was changed. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com> 2023-12-05 09:06:05 +00:00			`- repo: https://github.com/espressif/esp-idf-sbom.git`
			`rev: v0.11.0`
			`hooks:`
			`- id: validate-sbom-manifest`