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
|
|
|
|
|
2023-12-18 07:08:13 +00:00
|
|
|
default_stages: [commit]
|
|
|
|
|
2020-10-21 11:30:49 +00:00
|
|
|
repos:
|
|
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
2024-02-06 12:29:55 +00:00
|
|
|
rev: v4.5.0
|
2020-10-21 11:30:49 +00:00
|
|
|
hooks:
|
|
|
|
- id: trailing-whitespace
|
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'
|
2023-01-16 12:44:37 +00:00
|
|
|
# 4 - protobuf auto-generated files
|
2020-11-13 03:22:18 +00:00
|
|
|
exclude: &whitespace_excludes |
|
2021-01-22 07:25:22 +00:00
|
|
|
(?x)^(
|
|
|
|
.+\.(md|rst|map|bin)|
|
|
|
|
.+test.*\/.*expected.*|
|
|
|
|
.+\/testdata\/.+|
|
2022-05-27 04:05:46 +00:00
|
|
|
.*_pb2.py|
|
|
|
|
.*.pb-c.h|
|
2022-08-06 04:44:52 +00:00
|
|
|
.*.pb-c.c|
|
|
|
|
.*.yuv
|
2021-01-22 07:25:22 +00:00
|
|
|
)$
|
2020-10-21 11:30:49 +00:00
|
|
|
- id: end-of-file-fixer
|
2020-11-13 03:22:18 +00:00
|
|
|
exclude: *whitespace_excludes
|
2020-10-21 11:30:49 +00:00
|
|
|
- id: check-executables-have-shebangs
|
|
|
|
- id: mixed-line-ending
|
|
|
|
args: ['-f=lf']
|
2020-12-21 04:42:29 +00:00
|
|
|
- id: double-quote-string-fixer
|
2022-11-15 05:33:02 +00:00
|
|
|
- repo: https://github.com/PyCQA/flake8
|
2022-08-10 07:01:57 +00:00
|
|
|
rev: 5.0.4
|
2020-10-21 11:30:49 +00:00
|
|
|
hooks:
|
|
|
|
- id: flake8
|
|
|
|
args: ['--config=.flake8', '--tee', '--benchmark']
|
2024-01-09 18:52:15 +00:00
|
|
|
- repo: https://github.com/asottile/reorder-python-imports
|
|
|
|
rev: v3.12.0
|
2020-12-21 04:42:29 +00:00
|
|
|
hooks:
|
2024-01-09 18:52:15 +00:00
|
|
|
- id: reorder-python-imports
|
|
|
|
name: Reorder Python imports
|
|
|
|
args: [--py37-plus]
|
2022-05-27 04:05:46 +00:00
|
|
|
exclude: >
|
|
|
|
(?x)^(
|
|
|
|
.*_pb2.py
|
|
|
|
)$
|
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
|
2020-10-30 09:28:24 +00:00
|
|
|
entry: tools/ci/check_kconfigs.py
|
2020-10-21 11:30:49 +00:00
|
|
|
language: python
|
2020-10-30 09:28:24 +00:00
|
|
|
files: '^Kconfig$|Kconfig.*$'
|
2020-10-21 11:30:49 +00:00
|
|
|
- id: check-deprecated-kconfigs-options
|
|
|
|
name: Check if any Kconfig Options Deprecated
|
2020-10-30 09:28:24 +00:00
|
|
|
entry: tools/ci/check_deprecated_kconfigs.py
|
2020-10-21 11:30:49 +00:00
|
|
|
language: python
|
2020-10-30 09:28:24 +00:00
|
|
|
files: 'sdkconfig\.ci$|sdkconfig\.rename$|sdkconfig.*$'
|
2020-10-21 11:30:49 +00:00
|
|
|
- id: cmake-lint
|
|
|
|
name: Check CMake Files Format
|
2020-11-09 02:59:18 +00:00
|
|
|
entry: cmakelint --linelength=120 --spaces=4 --filter=-whitespace/indent
|
2020-10-21 11:30:49 +00:00
|
|
|
language: python
|
|
|
|
additional_dependencies:
|
2020-11-08 23:06:05 +00:00
|
|
|
- cmakelint==1.4.1
|
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
|
2021-11-11 08:59:54 +00:00
|
|
|
always_run: true
|
2020-10-21 11:30:49 +00:00
|
|
|
files: '\.gitlab/CODEOWNERS'
|
|
|
|
pass_filenames: false
|
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
|
2023-01-05 04:51:45 +00:00
|
|
|
files: '\.gitlab/ci/.+\.yml|\.gitlab-ci.yml|\.gitmodules'
|
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)
|
2022-10-09 05:10:59 +00:00
|
|
|
entry: tools/ci/generate_rules.py
|
2021-02-09 04:34:16 +00:00
|
|
|
language: python
|
2022-10-12 07:42:22 +00:00
|
|
|
files: '\.gitlab/ci/dependencies/.+|\.gitlab/ci/.*\.yml'
|
2021-02-09 04:34:16 +00:00
|
|
|
pass_filenames: false
|
|
|
|
additional_dependencies:
|
|
|
|
- PyYAML == 5.3.1
|
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
|
2021-09-08 15:38:14 +00:00
|
|
|
additional_dependencies:
|
2022-04-25 20:55:28 +00:00
|
|
|
- 'mypy==0.940'
|
2021-09-08 15:38:14 +00:00
|
|
|
- 'mypy-extensions==0.4.3'
|
2022-04-26 14:32:06 +00:00
|
|
|
- 'types-setuptools==57.4.14'
|
2022-05-23 06:50:37 +00:00
|
|
|
- 'types-PyYAML==0.1.9'
|
2022-05-27 04:05:46 +00:00
|
|
|
exclude: >
|
|
|
|
(?x)^(
|
|
|
|
.*_pb2.py
|
|
|
|
)$
|
2021-02-01 08:18:16 +00:00
|
|
|
language: python
|
|
|
|
types: [python]
|
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
|
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
|
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)
|
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/*/'
|
2021-11-05 09:23:24 +00:00
|
|
|
language: python
|
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'
|
2021-11-05 09:23:24 +00:00
|
|
|
pass_filenames: false
|
|
|
|
additional_dependencies:
|
|
|
|
- pyparsing
|
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
|
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
|
2022-07-11 05:43:45 +00:00
|
|
|
additional_dependencies:
|
2022-09-06 06:58:16 +00:00
|
|
|
- PyYAML == 5.3.1
|
2024-02-01 08:56:42 +00:00
|
|
|
- idf_build_apps~=1.0
|
2022-07-11 05:43:45 +00:00
|
|
|
- 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:
|
2022-09-06 06:58:16 +00:00
|
|
|
- PyYAML == 5.3.1
|
2022-07-11 05:43:45 +00:00
|
|
|
- ruamel.yaml
|
2021-04-26 07:58:03 +00:00
|
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
2021-09-08 15:38:14 +00:00
|
|
|
rev: v4.0.1
|
2021-04-26 07:58:03 +00:00
|
|
|
hooks:
|
|
|
|
- id: file-contents-sorter
|
2021-11-18 17:21:52 +00:00
|
|
|
files: 'tools\/ci\/(executable-list\.txt|mypy_ignore_list\.txt|check_copyright_ignore\.txt)'
|
2022-06-23 14:39:12 +00:00
|
|
|
- repo: https://github.com/espressif/check-copyright/
|
2023-07-19 12:56:02 +00:00
|
|
|
rev: v1.0.3
|
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']
|
2023-12-05 09:06:05 +00:00
|
|
|
- repo: https://github.com/espressif/esp-idf-sbom.git
|
2023-12-12 11:26:34 +00:00
|
|
|
rev: v0.13.0
|
2023-12-05 09:06:05 +00:00
|
|
|
hooks:
|
|
|
|
- id: validate-sbom-manifest
|
2023-12-18 07:08:13 +00:00
|
|
|
stages: [post-commit]
|