Merge pull request #105 from weikelu/feat/add_codespell_check

feat: add codespell check and fix typos

Author: EspressifApp

.codespellrc

@@ -0,0 +1,5 @@
+[codespell]
+skip = build,*.drawio,*.svg,*.pdf,*.png,*.jar,gradlew.bat
+ignore-words-list = laf,OT
+write-changes = true
+

.github/workflows/pre_commit.yml

@@ -0,0 +1,52 @@
+name: Pre-Commit Checks
+
+# Triggers on pull requests and pushes to master or main branches
+on:
+  pull_request:
+  push:
+    branches: [master, main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      # Fetches full Git history to enable branch comparison
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      # Identifies changed files using git diff
+      - name: Get modified files
+        id: modified_files
+        run: |
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            BASE_BRANCH="${{ github.base_ref }}"
+            git fetch origin $BASE_BRANCH --depth=1
+            MODIFIED_FILES="$(git diff --name-only origin/$BASE_BRANCH...HEAD || echo "")"
+          else
+            MODIFIED_FILES="$(git diff --name-only HEAD~1 HEAD || echo "")"
+          fi
+
+          if [ -n "$MODIFIED_FILES" ]; then
+            echo "Running pre-commit on changed files:"
+            echo "$MODIFIED_FILES"
+            echo "files=$(echo "$MODIFIED_FILES" | tr '\n' ' ')" >> $GITHUB_OUTPUT
+            echo "has_files=true" >> $GITHUB_OUTPUT
+          else
+            echo "No modified files to check."
+            echo "has_files=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Run pre-commit on modified files
+        if: steps.modified_files.outputs.has_files == 'true'
+        run: pre-commit run --files ${{ steps.modified_files.outputs.files }}
+

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: [--config=.codespellrc]
+

esptouch/src/main/java/com/espressif/iot/esptouch/task/ICodeData.java

@@ -9,12 +9,12 @@ public interface ICodeData {
     /**
      * Get the byte[] to be transformed.
      *
-     * @return the byte[] to be transfromed
+     * @return the byte[] to be transformed
      */
     byte[] getBytes();
 
     /**
-     * Get the char[](u8[]) to be transfromed.
+     * Get the char[](u8[]) to be transformed.
      *
      * @return the char[](u8) to be transformed
      */

log/log-en.md

@@ -69,7 +69,7 @@ EspTouch v0.3.7.1
 - Modify bssid post sequence
 
 ## v0.3.6.0
-- Fix bug that cann't configure Chinese SSID
+- Fix bug that can't configure Chinese SSID
 
 ## v0.3.4.7
 - Change project from Eclipse to Android Studio
@@ -98,7 +98,7 @@ EspTouch v0.3.7.1
     - Esptouch v0.3.4.3 only support Espressif's Smart Config v2.4
 
 ## v0.3.4.2
-- Espressif's Smart Config is updated to v2.4, and some paremeters are changed.
+- Espressif's Smart Config is updated to v2.4, and some parameters are changed.
     - Esptouch v0.3.4.2 only support Espressif's Smart Config v2.4
 ```
     The usage of v0.3.4 is supported, besides one new API is added:
@@ -107,7 +107,7 @@ EspTouch v0.3.7.1
  ```
 
 ## v0.3.4
-- Espressif's Smart Config is updated to v2.4, and some paremeters are changed.
+- Espressif's Smart Config is updated to v2.4, and some parameters are changed.
     - Esptouch v0.3.4 only support Espressif's Smart Config v2.4
 
 ## v0.3.3
@@ -116,7 +116,7 @@ EspTouch v0.3.7.1
 ```
     The usage of v0.3.0 is supported, besides one new API is added:
     List<IEsptouchResult> executeForResults(int expectTaskResultCount)
-    The only differece is that it return list, and require expectTaskResultCount
+    The only difference is that it return list, and require expectTaskResultCount
 ```
 
 ## v0.3.2
@@ -207,7 +207,7 @@ IEsptouchTask esptouchTask = new EsptouchTask(apSsid, apPassword);
 IEsptouchTask esptouchTask = new EsptouchTask(apSsid, apPassword);
 // execute syn util it suc or timeout
 IEsptouchResult result = esptouchTask.executeForResult();
-// check whehter the execute is suc
+// check whether the execute is suc
 boolean isSuc = result.isSuc();
 // get the device's bssid, the format of the bssid is like this format: "18fe3497f310"
 String bssid = result.getBssid();