feat(pre-commit): support to check file versions

Lzw655 · Lzw655 · commit bc6be5e9edfb · 2024-06-01T21:53:12.000+08:00
diff --git a/.github/scripts/check_lib_versions.sh b/.github/scripts/check_lib_versions.sh
diff --git a/.github/workflows/check_lib_versions.yml b/.github/workflows/check_lib_versions.yml
@@ -1,4 +1,4 @@
-name: Check Versions
+name: Check Library Versions
 
 on:
   pull_request:
@@ -26,5 +26,5 @@ jobs:
             echo "prerelease: ${{ steps.last_release.outputs.prerelease }}"
             echo "url: ${{ steps.last_release.outputs.url }}"
         - name: Check & Compare versions
-          run: bash ./.github/scripts/check_versions.sh ${{ steps.last_release.outputs.tag_name }}
+          run: bash ./.github/scripts/check_lib_versions.sh ${{ steps.last_release.outputs.tag_name }}
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -39,6 +39,14 @@ repos:
     hooks:
       - id: sync-conf-files
         name: Update when configuration files change
-        entry: python .github/ci/sync_conf_files.py ./
+        entry: python tools/sync_conf_files.py ./
+        language: system
+        files: '.*ESP_Panel_(Board_Custom|Board_Supported|Conf)\.h'
+
+  - repo: local
+    hooks:
+      - id: check-file-versions
+        name: Update when versions change
+        entry: python tools/check_file_version.py ./
         language: system
         files: '.*ESP_Panel_(Board_Custom|Board_Supported|Conf)\.h'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,12 @@
 # ChangeLog
 
-## v0.1.2 - 2024-05-27
+## v0.1.2 - 2024-06-01
 
 ### Enhancements:
 
 * feat(config): add version control for all configuration files by @lzw655 (#32)
+* feat(touch): add i2c st1633 by @lzw655 (#22)
+* feat(pre-commit): support to check file versions
 
 ### Bugfixes:
 
diff --git a/ESP_Panel_Board_Custom.h b/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 
diff --git a/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h b/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 
diff --git a/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h b/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 
diff --git a/examples/Panel/PanelTest/ESP_Panel_Board_Custom.h b/examples/Panel/PanelTest/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 
diff --git a/examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h b/examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 
diff --git a/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Custom.h b/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 
diff --git a/src/ESP_PanelVersions.h b/src/ESP_PanelVersions.h
@@ -21,7 +21,7 @@
 /* File `ESP_Panel_Board_Custom.h` */
 #define ESP_PANEL_BOARD_CUSTOM_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_VERSION_PATCH 1
 
 /* File `ESP_Panel_Board_Supported.h` */
 #define ESP_PANEL_BOARD_SUPPORTED_VERSION_MAJOR 0
diff --git a/src/touch/README.md b/src/touch/README.md
@@ -7,6 +7,7 @@
 | [FT5x06](https://components.espressif.com/components/espressif/esp_lcd_touch_ft5x06)   | 1.0.6       |
 | [GT911](https://components.espressif.com/components/espressif/esp_lcd_touch_gt911)     | 1.1.0       |
 | [GT1151](https://components.espressif.com/components/espressif/esp_lcd_touch_gt1151)   | 1.0.5~1     |
+| ST1633                                                                                 | 0.1.0       |
 | [ST7123](https://components.espressif.com/components/espressif/esp_lcd_touch_st7123)   | 0.0.1       |
 | [TT21100](https://components.espressif.com/components/espressif/esp_lcd_touch_tt21100) | 1.1.0       |
 | [XPT2046](https://components.espressif.com/components/atanisoft/esp_lcd_touch_xpt2046) | 1.0.4       |
diff --git a/tools/check_file_version.py b/tools/check_file_version.py
@@ -0,0 +1,116 @@
+# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+import os
+import sys
+import re
+
+internal_version_file = "src/ESP_PanelVersions.h"
+internal_version_macross = [
+    {
+        "file": "ESP_Panel_Conf.h",
+        "macro": {
+            "major": "ESP_PANEL_CONF_VERSION_MAJOR",
+            "minor": "ESP_PANEL_CONF_VERSION_MINOR",
+            "patch": "ESP_PANEL_CONF_VERSION_PATCH"
+        },
+    },
+    {
+        "file": "ESP_Panel_Board_Custom.h",
+        "macro": {
+            "major": "ESP_PANEL_BOARD_CUSTOM_VERSION_MAJOR",
+            "minor": "ESP_PANEL_BOARD_CUSTOM_VERSION_MINOR",
+            "patch": "ESP_PANEL_BOARD_CUSTOM_VERSION_PATCH"
+        },
+    },
+    {
+        "file": "ESP_Panel_Board_Supported.h",
+        "macro": {
+            "major": "ESP_PANEL_BOARD_SUPPORTED_VERSION_MAJOR",
+            "minor": "ESP_PANEL_BOARD_SUPPORTED_VERSION_MINOR",
+            "patch": "ESP_PANEL_BOARD_SUPPORTED_VERSION_PATCH"
+        },
+    },
+]
+file_version_macros = [
+    {
+        "file": "ESP_Panel_Conf.h",
+        "macro": {
+            "major": "ESP_PANEL_CONF_FILE_VERSION_MAJOR",
+            "minor": "ESP_PANEL_CONF_FILE_VERSION_MINOR",
+            "patch": "ESP_PANEL_CONF_FILE_VERSION_PATCH"
+        },
+    },
+    {
+        "file": "ESP_Panel_Board_Custom.h",
+        "macro": {
+            "major": "ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR",
+            "minor": "ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR",
+            "patch": "ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH"
+        },
+    },
+    {
+        "file": "ESP_Panel_Board_Supported.h",
+        "macro": {
+            "major": "ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR",
+            "minor": "ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR",
+            "patch": "ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH"
+        },
+    },
+]
+
+
+def extract_version(file_path, version_dict):
+    if os.path.dirname(file_path) == "":
+        file_path = os.path.join(search_directory, file_path)
+
+    file_contents = []
+    content_str = ""
+    with open(file_path, 'r') as file:
+        file_contents.append(file.readlines())
+        for content in file_contents:
+            content_str = ''.join(content)
+
+    version_macro = version_dict['macro']
+    major_version = re.search(r'#define ' + version_macro["major"] + r' (\d+)', content_str)
+    minor_version = re.search(r'#define ' + version_macro["minor"] + r' (\d+)', content_str)
+    patch_version = re.search(r'#define ' + version_macro["patch"] + r' (\d+)', content_str)
+
+    if major_version and minor_version and patch_version:
+        return {"file": version_dict['file'], "version": [major_version.group(1), minor_version.group(1), patch_version.group(1)]}
+
+    return None
+
+
+if __name__ == "__main__":
+    if len(sys.argv) >= 3:
+        search_directory = sys.argv[1]
+
+        # Extract internal versions
+        internal_version_path = os.path.join(search_directory, internal_version_file)
+        internal_versions = []
+        for internal_version_macros in internal_version_macross:
+            version = extract_version(internal_version_path, internal_version_macros)
+            print(f"Internal version extracted from '{internal_version_path}")
+            if version:
+                print(f"Internal version: '{internal_version_macros['file']}': {version}")
+                internal_versions.append(version)
+            else:
+                print(f"'{internal_version_macros['file']}' version not found")
+
+        is_version_mismatch = False
+        for i in range(2, len(sys.argv)):
+            file_path = sys.argv[i]
+            src_file = os.path.join(search_directory, os.path.basename(file_path))
+            for file_version in file_version_macros:
+                versions = extract_version(src_file, file_version)
+                if versions:
+                    print(f"File version extracted from '{src_file}': {versions}")
+                    for internal_version in internal_versions:
+                        if (internal_version['file'] == versions['file']) and (internal_version['version'] != versions['version']):
+                            print(f"Version mismatch: '{internal_version['file']}'")
+                            is_version_mismatch = True
+                    print(f"Version matched")
+
+        if is_version_mismatch:
+            sys.exit(1)
diff --git a/tools/sync_conf_files.py b/tools/sync_conf_files.py
@@ -5,7 +5,6 @@
 import sys
 import shutil
 
-
 exclude_dirs = ["./build"]
 
 
