Merge branch 'docs/fix_pre_commit_hook' into 'master'

chore: Updated formatting according to pre-commit hooks

See merge request application/esp-at!1944

Author: xcguang

.codespellrc

@@ -1,4 +1,4 @@
 [codespell]
 skip = build,*.drawio,*.svg,*.pdf
-ignore-words-list = laf,OT,QUITT
+ignore-words-list = laf,OT,QUITT,rsource,inout
 write-changes = true

.pre-commit-config.yaml

@@ -3,6 +3,13 @@
 
 default_stages: [commit]
 
+# Exclude some directories or files from all hooks
+exclude: &global_excludes |
+  (?x)^(
+    .+\/STM32\/.+|
+    .*.crt
+  )$
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1

build.py

@@ -77,7 +77,7 @@ def at_sync_submodule(path, repo, branch, commit, redirect):
             raise Exception('git checkout failed! Please manually run:\r\n{}'.format(cmd))
 
     if new_clone:
-        # init submoules for cloned repository
+        # init submodules for cloned repository
         ret = subprocess.call('cd {} && git submodule init'.format(path), shell = True)
         if ret:
             raise Exception('git submodule init failed')

components/at/include/at_compress_ota.h

@@ -21,7 +21,7 @@ extern "C" {
  *
  *  An OTA method for saving flash space. Typical workflow:
  *  Compress the firmware to be upgraded by compression algorithm, and pack into compressed image,
- *  which inludes compressed image header (indicates the compressed image info and verify info) and compressed image body (compressed firmware).
+ *  which includes compressed image header (indicates the compressed image info and verify info) and compressed image body (compressed firmware).
  *  Compress OTA will download the compressed image into special partition slot (type:0x01 subtype:0x22).
  *  After reboot the module, esp-bootloader-plus (https://github.com/espressif/esp-bootloader-plus) will check if firmware needs to be upgraded.
  *  If yes, esp-bootloader-plus will verify the integrity of compressed image, and then decompress it into the bootable partition slot.

components/at/include/esp_at.h

@@ -114,7 +114,7 @@ void esp_at_ready_before(void);
  * @param[in] expected_response: expected response string
  * @param[in] timeout_ms: timeout in milliseconds
  *
- * @note Once exprected response is received, the function will return immediately.
+ * @note Once expected response is received, the function will return immediately.
  * @note You should not call this function directly from an AT command handler.
  *       The AT command handler typically refers to the test command, query command, set command, and execute command
  *       corresponding to the AT commands registered via esp_at_custom_cmd_array_regist().

components/at/include/esp_at_core.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -71,7 +71,7 @@ typedef struct {
  */
 typedef enum {
     ESP_AT_STATUS_NORMAL = 0x0,                /*!< Normal mode.Now mcu can send AT command */
-    ESP_AT_STATUS_TRANSMIT,                    /*!< Transparent Transmition mode */
+    ESP_AT_STATUS_TRANSMIT,                    /*!< Transparent Transmission mode */
 
 } esp_at_status_type;
 
@@ -256,7 +256,7 @@ void esp_at_transmit_terminal_from_isr(void);
 void esp_at_transmit_terminal(void);
 
 /**
- * @brief regist at command set, which defined by custom,
+ * @brief register at command set, which defined by custom,
  *
  * @param custom_at_cmd_array at command set
  * @param cmd_num command number
@@ -265,15 +265,15 @@ void esp_at_transmit_terminal(void);
 bool esp_at_custom_cmd_array_regist(const esp_at_cmd_struct *custom_at_cmd_array, uint32_t cmd_num);
 
 /**
- * @brief regist device operate functions set,
+ * @brief register device operate functions set,
  *
  * @param ops device operate functions set
  *
  */
 void esp_at_device_ops_regist(esp_at_device_ops_struct* ops);
 
 /*
- *  @brief regist custom callback about socket status,
+ *  @brief register custom callback about socket status,
  *
  *  @param link_id the link id
  *  @param ops custom operate functions set
@@ -283,7 +283,7 @@ void esp_at_device_ops_regist(esp_at_device_ops_struct* ops);
 bool esp_at_custom_net_ops_regist(int32_t link_id, esp_at_custom_net_ops_struct* ops);
 
 /*
- *  @brief regist custom callback about ble status,
+ *  @brief register custom callback about ble status,
  *
  *  @param ops custom operate functions set
  *
@@ -292,7 +292,7 @@ bool esp_at_custom_net_ops_regist(int32_t link_id, esp_at_custom_net_ops_struct*
 bool esp_at_custom_ble_ops_regist(int32_t conn_index, esp_at_custom_ble_ops_struct* ops);
 
 /**
- * @brief regist custom operate functions set interacting with AT,
+ * @brief register custom operate functions set interacting with AT,
  *
  * @param ops custom operate functions set
  *

components/at/src/at_web_dns_server.c

@@ -161,7 +161,7 @@ static int parse_dns_request(char *req, size_t req_len, char *dns_reply, size_t
     // Prepare the reply
     memcpy(dns_reply, req, req_len);
 
-    // Endianess of NW packet different from chip
+    // Endianness of NW packet different from chip
     dns_header_t *header = (dns_header_t*)dns_reply;
     ESP_LOGD(TAG, "DNS req with header id: 0x%X, flags: 0x%X, qd_count: %d", ntohs(header->id), ntohs(header->flags), ntohs(header->qd_count));
 
@@ -186,7 +186,7 @@ static int parse_dns_request(char *req, size_t req_len, char *dns_reply, size_t
     char *cur_qd_ptr  = dns_reply + sizeof(dns_header_t);
 
     char name[128] = {0};
-    /* Repond to all questions with the ESP's IP address */
+    /* Respond to all questions with the ESP's IP address */
     for (int i = 0; i < qd_count; i++) {
         char *name_end_ptr = parse_dns_name(cur_qd_ptr, name, sizeof(name));
         if (name_end_ptr == NULL) {

components/at/src/at_web_server_cmd.c

@@ -36,7 +36,7 @@
 
 #ifdef CONFIG_AT_WEB_SERVER_SUPPORT
 #include "esp_http_server.h"
-// AT web can use fatfs to storge html or use embeded file to storge html.
+// AT web can use fatfs to storage html or use embedded file to storage html.
 // If use fatfs,we should enable AT FS Command support.
 #ifdef CONFIG_AT_WEB_USE_FATFS
 #include "esp_vfs_fat.h"
@@ -155,7 +155,7 @@ static const char *s_ota_receive_fail_response = "+WEBSERVERRSP:5\r\n";
 static SLIST_HEAD(router_fail_list_head_, router_obj) s_router_fail_list = SLIST_HEAD_INITIALIZER(s_router_fail_list);
 static const char *TAG = "at-web";
 
-// AT web can use fatfs to storge html or use embeded file to storge html.
+// AT web can use fatfs to storage html or use embedded file to storage html.
 // If use fatfs,we should enable AT FS Command support.
 #ifdef CONFIG_AT_WEB_USE_FATFS
 static wl_handle_t s_wl_handle = WL_INVALID_HANDLE; // Handle of the wear levelling library instance
@@ -487,7 +487,7 @@ static esp_err_t at_web_start_scan_filter(uint8_t *phone_mac, uint8_t *password,
             memcpy(item->mac, ap_info[loop].bssid, sizeof(item->mac));
             // copy ssid
             memcpy(item->ssid, ap_info[loop].ssid, sizeof(item->ssid));
-            // cpoy rssi
+            // copy rssi
             item->rssi = ap_info[loop].rssi;
 
             if (last == NULL) {
@@ -506,7 +506,7 @@ static esp_err_t at_web_start_scan_filter(uint8_t *phone_mac, uint8_t *password,
 
         // If have mobile phone mac, first consider connect the router which has similar mac
         if (phone_mac != NULL) {
-            ESP_LOGI(TAG, "Try to macth MAC");
+            ESP_LOGI(TAG, "Try to match MAC");
             for (item = SLIST_FIRST(&s_router_all_list); (item != NULL) && (try_connect_count < max_try_connect_num); item = SLIST_NEXT(item, next)) {
                 // some phone(like XIAOMI10), the difference between SOFTAP and STA is two bytes
                 if ((at_web_get_mac_match_len(phone_mac, item->mac, sizeof(item->mac)) >= 5)) {
@@ -525,7 +525,7 @@ static esp_err_t at_web_start_scan_filter(uint8_t *phone_mac, uint8_t *password,
                 }
             }
             if (item == NULL) {
-                ESP_LOGI(TAG, "No macth MAC");
+                ESP_LOGI(TAG, "No match MAC");
             }
         }
 #if ESP_AT_WEB_ENABLE_VIRTUAL_MAC_MATCH
@@ -545,7 +545,7 @@ static esp_err_t at_web_start_scan_filter(uint8_t *phone_mac, uint8_t *password,
                         } else {
                             s_connect_success_flag = 1;
                         }
-                        break; // find ssid, skip seach
+                        break; // find ssid, skip search
                     }
                 }
             }
@@ -691,7 +691,7 @@ static int at_web_find_arg(char *line, char *arg, char *buff, int buffLen)
     return -1; // not found
 }
 
-// AT web can use fatfs to storge html or use embeded file to storge html.
+// AT web can use fatfs to storage html or use embedded file to storage html.
 // If use fatfs,we should enable AT FS Command support.
 #ifdef CONFIG_AT_WEB_USE_FATFS
 /* Send HTTP response with the contents of the requested file */
@@ -867,7 +867,7 @@ static void listen_sta_connect_status_timer_cb(TimerHandle_t timer)
     esp_netif_t *sta_if = esp_netif_get_handle_from_ifkey("WIFI_STA_DEF");
 
     if (connect_count < connect_max_count) {
-        sta_got_ip = at_web_get_sta_got_ip_flag(); // to check whether sta has connnected to appointed ap(like at_wifi_station_get_connect_status())
+        sta_got_ip = at_web_get_sta_got_ip_flag(); // to check whether sta has connected to appointed ap(like at_wifi_station_get_connect_status())
         if (sta_got_ip != true) {
             connect_count++;
             return;
@@ -958,7 +958,7 @@ static void listen_sta_connect_success_timer_cb(TimerHandle_t timer)
     wifi_sta_connection_info_t *current_connection_info = at_web_get_sta_connection_info();
 
     if (current_connection_info->config_status == ESP_AT_WIFI_STA_CONNECTING) {
-        sta_got_ip = at_web_get_sta_got_ip_flag(); // to check whether sta has connnected to appointed ap(like at_wifi_station_get_connect_status())
+        sta_got_ip = at_web_get_sta_got_ip_flag(); // to check whether sta has connected to appointed ap(like at_wifi_station_get_connect_status())
         if (sta_got_ip != true) {
             return;
         } else {
@@ -973,7 +973,7 @@ static void listen_sta_connect_success_timer_cb(TimerHandle_t timer)
 /**
  * @brief Apply WiFi connect info to try connect
  *
- * @param[in] udp_port: indicates the device in use, -1: brower, others: WeChat;
+ * @param[in] udp_port: indicates the device in use, -1: browser, others: WeChat;
  *  when Wechat is in use and ssid is null, we use udp send wifi connect result.
  *
  * @return
@@ -1435,7 +1435,7 @@ static esp_err_t ap_record_get_handler(httpd_req_t *req)
 
     for (loop = 0; loop < ap_number; loop++) {
         int32_t ssid_len = strlen((const char*)ap_info[loop].ssid);
-        if (ssid_len != 0) { // ingore hidden ssid
+        if (ssid_len != 0) { // ignore hidden ssid
             json_len += sprintf(temp_json_str + json_len, "{\"ssid\":\"");
             for (int i = 0; i < ssid_len; i++) {
                 uint8_t c = ap_info[loop].ssid[i];
@@ -1891,7 +1891,7 @@ static esp_err_t at_web_start(uint16_t server_port)
     esp_err_t err;
 
     if (s_server == NULL) {
-        /*AT web can use fatfs to storge html or use embeded file to storge html.If use fatfs, we should enable AT FS Command support*/
+        /*AT web can use fatfs to storage html or use embedded file to storage html.If use fatfs, we should enable AT FS Command support*/
 #ifdef CONFIG_AT_WEB_USE_FATFS
         err = at_web_fatfs_spiflash_init();
         if (err != ESP_OK) {

components/customized_partitions/README.md

@@ -57,7 +57,7 @@ In building customized partition bin stage:
 2. try to find generation tool from `generation_tool` folder
     * if tool is not found, then skip generating this partition bin
 3. run generation tool, generate customized bin
-    * the generation tool can specify its raw data folder. by default the raw data will be put into `raw_data/partition_name` of component customzied partitions
+    * the generation tool can specify its raw data folder. by default the raw data will be put into `raw_data/partition_name` of component customized partitions
     * if generation tools did not exit 0, it will report error and stop build
 4. copy bin to `build/customized_partitions` folder and update to flash args
 

components/customized_partitions/at_customized_target_generate.py

@@ -56,7 +56,7 @@ def main():
 
     # check fatfs dependency
     if 'fatfs' in to_read_config_name and 'fatfs' not in to_write_partition:
-        print('FatFS is required in sdkconfig but not found in parition table. Please check the at_customize.csv')
+        print('FatFS is required in sdkconfig but not found in partition table. Please check the at_customize.csv')
         sys.exit(1)
 
     with open(flash_args_file, 'w+') as args_file: