ci: add pre-commit check

Author: leeebo

.gitlab/ci/pre_check.yml

@@ -1,30 +1,53 @@
-check_readme_links:
-  extends:
-    - .rules:pre_check:readme
+.pre_check_template:
   stage: pre_check
   image: python:3.9
   tags: ["build", "amd64", "internet"]
-  allow_failure: true
-  script:
-    - python ${CI_PROJECT_DIR}/tools/ci/check_readme_links.py
+  dependencies: []
 
 check_copyright:
-  stage: pre_check
-  image: python:3.9
-  tags: ["build", "amd64", "internet"]
-  allow_failure: true
+  extends:
+    - .pre_check_template
+  allow_failure: false
   before_script:
     - pip install git+https://github.com/espressif/[email protected]
   script:
     - python -m check_copyright --verbose --dry-run --ignore tools/ci/ignore_list_copyright.txt --config tools/ci/check_copyright_config.yaml .
 
 check_example_paths:
   extends:
+    - .pre_check_template
     - .rules:pre_check:components
-  stage: pre_check
-  image: python:3.9
-  tags: ["build", "amd64", "internet"]
   script:
     - pip install --upgrade pip
     - pip install pyyaml
-    - python ${CI_PROJECT_DIR}/tools/ci/check_components.py
+    - python ${CI_PROJECT_DIR}/tools/ci/check_components.py
+
+check_pre_commit:
+  extends:
+    - .pre_check_template
+  before_script:
+    - pip install pre-commit
+  script:
+    - |
+      # merged results pipelines, by default
+      if [[ -n $CI_MERGE_REQUEST_SOURCE_BRANCH_SHA ]]; then
+        MODIFIED_FILES=$(git diff --name-only $CI_MERGE_REQUEST_DIFF_BASE_SHA $CI_MERGE_REQUEST_SOURCE_BRANCH_SHA)
+      # merge request pipelines, when the mr got conflicts
+      elif [[ -n $CI_MERGE_REQUEST_DIFF_BASE_SHA ]]; then
+        MODIFIED_FILES=$(git diff --name-only $CI_MERGE_REQUEST_DIFF_BASE_SHA $CI_COMMIT_SHA)
+      # other pipelines, like the protected branches pipelines
+      else
+        MODIFIED_FILES=$(git diff --name-only $CI_COMMIT_BEFORE_SHA $CI_COMMIT_SHA)
+      fi
+      # print the MODIFIED_FILES
+      echo "MODIFIED_FILES: $MODIFIED_FILES"
+    - pre-commit install --allow-missing-config -t pre-commit -t commit-msg
+    - pre-commit run --files $MODIFIED_FILES
+
+check_readme_links:
+  extends:
+    - .pre_check_template
+    - .rules:pre_check:readme
+  allow_failure: true
+  script:
+    - python ${CI_PROJECT_DIR}/tools/ci/check_readme_links.py

.pre-commit-config.yaml

@@ -6,4 +6,41 @@ repos:
     rev: v1.0.3
     hooks:
       - id: check-copyright
-        args: ['--config', 'tools/ci/check_copyright_config.yaml', '--ignore', 'tools/ci/ignore_list_copyright.txt']
+        args: ['--config', 'tools/ci/check_copyright_config.yaml', '--ignore', 'tools/ci/ignore_list_copyright.txt']
+  - 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/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
+      - 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]']

CONTRIBUTING.rst

@@ -17,6 +17,8 @@ Before sending us a Pull Request, please consider this list of points:
 
 * Does any new code conform to the esp-idf : :doc:`Style Guide <style-guide>` ?
 
+* Have you installed the `pre-commit hook <https://docs.espressif.com/projects/esp-idf/en/stable/esp32/contribute/install-pre-commit-hook.html>`_ for the esp-iot-solution project?
+
 * Does the code documentation follow requirements in `Documenting-code <http://docs.espressif.com/projects/esp-idf/en/stable/contribute/documenting-code.html>`_ ?
 
 * Is the code adequately commented for people to understand how it is structured?