ci(pre-commit): Add bash script formatter and linter (#10681)

* ci(pre-commit): Add check for bash scripts

* fix(formatting): Fix bash scripts

* docs(pre-commit): Add info about the included hooks

Author: lucasssvaz

.github/scripts/check-cmakelists.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+
 #
 # This script is used in the CI workflow. It checks all non-examples source files in libraries/ and cores/ are listed in
 # CMakeLists.txt for the cmake-based IDF component
@@ -12,10 +13,10 @@ set -e
 git submodule update --init --recursive
 
 # find all source files in repo
-REPO_SRCS=`find cores/esp32/ libraries/ -name 'examples' -prune -o -name '*.c' -print -o -name '*.cpp' -print | sort`
+REPO_SRCS=$(find cores/esp32/ libraries/ -name 'examples' -prune -o -name '*.c' -print -o -name '*.cpp' -print | sort)
 
 # find all source files named in CMakeLists.txt COMPONENT_SRCS
-CMAKE_SRCS=`cmake --trace-expand -P CMakeLists.txt 2>&1 | grep set\(srcs | cut -d'(' -f3 | sed 's/ )//' | sed 's/srcs //' | tr ' ;' '\n' | sort`
+CMAKE_SRCS=$(cmake --trace-expand -P CMakeLists.txt 2>&1 | grep set\(srcs | cut -d'(' -f3 | sed 's/ )//' | sed 's/srcs //' | tr ' ;' '\n' | sort)
 
 if ! diff -u0 --label "Repo Files" --label "srcs" <(echo "$REPO_SRCS") <(echo "$CMAKE_SRCS"); then
     echo "Source files in repo (-) and source files in CMakeLists.txt (+) don't match"

.github/scripts/find_all_boards.sh

@@ -3,7 +3,9 @@
 # Get all boards
 boards_array=()
 
-for line in `grep '.tarch=' boards.txt`; do
+boards_list=$(grep '.tarch=' boards.txt)
+
+while read -r line; do
     board_name=$(echo "$line" | cut -d '.' -f1 | cut -d '#' -f1)
     # skip esp32c2 as we dont build libs for it
     if [ "$board_name" == "esp32c2" ]; then
@@ -12,29 +14,26 @@ for line in `grep '.tarch=' boards.txt`; do
     fi
     boards_array+=("espressif:esp32:$board_name")
     echo "Added 'espressif:esp32:$board_name' to array"
-done
+done <<< "$boards_list"
 
 # Create JSON like string with all boards found and pass it to env variable
 board_count=${#boards_array[@]}
 echo "Boards found: $board_count"
-echo "BOARD-COUNT=$board_count" >> $GITHUB_ENV
+echo "BOARD-COUNT=$board_count" >> "$GITHUB_ENV"
 
-if [ $board_count -gt 0 ]
-then
+if [ "$board_count" -gt 0 ]; then
     json_matrix='['
-    for board in ${boards_array[@]}
-    do
+    for board in "${boards_array[@]}"; do
         json_matrix+='"'$board'"'
-        if [ $board_count -gt 1 ]
-        then
+        if [ "$board_count" -gt 1 ]; then
             json_matrix+=","
         fi
-        board_count=$(($board_count - 1))
+        board_count=$((board_count - 1))
     done
     json_matrix+=']'
 
-    echo $json_matrix
-    echo "FQBNS=${json_matrix}" >> $GITHUB_ENV
+    echo "$json_matrix"
+    echo "FQBNS=${json_matrix}" >> "$GITHUB_ENV"
 else
-    echo "FQBNS=" >> $GITHUB_ENV
+    echo "FQBNS=" >> "$GITHUB_ENV"
 fi

.github/scripts/find_new_boards.sh

@@ -5,14 +5,13 @@ owner_repository=$1
 base_ref=$2
 
 # Download the boards.txt file from the base branch
-curl -L -o boards_base.txt https://raw.githubusercontent.com/$owner_repository/$base_ref/boards.txt
+curl -L -o boards_base.txt https://raw.githubusercontent.com/"$owner_repository"/"$base_ref"/boards.txt
 
 # Compare boards.txt file in the repo with the modified file from PR
 diff=$(diff -u boards_base.txt boards.txt)
 
 # Check if the diff is empty
-if [ -z "$diff" ]
-then
+if [ -z "$diff" ]; then
     echo "No changes in boards.txt file"
     echo "FQBNS="
     exit 0
@@ -21,23 +20,20 @@ fi
 # Extract added or modified lines (lines starting with '+' or '-')
 modified_lines=$(echo "$diff" | grep -E '^[+-][^+-]')
 
-# Print the modified lines for debugging
+# Print the modified lines for debugging
 echo "Modified lines:"
 echo "$modified_lines"
 
 boards_array=()
 previous_board=""
 
 # Extract board names from the modified lines, and add them to the boards_array
-while read -r line
-do
+while read -r line; do
     board_name=$(echo "$line" | cut -d '.' -f1 | cut -d '#' -f1)
     # remove + or - from the board name at the beginning
-    board_name=$(echo "$board_name" | sed 's/^[+-]//')
-    if [ "$board_name" != "" ] && [ "$board_name" != "+" ] && [ "$board_name" != "-" ] && [ "$board_name" != "esp32_family" ]
-    then
-        if [ "$board_name" != "$previous_board" ]
-        then
+    board_name=${board_name#[-+]}
+    if [ "$board_name" != "" ] && [ "$board_name" != "+" ] && [ "$board_name" != "-" ] && [ "$board_name" != "esp32_family" ]; then
+        if [ "$board_name" != "$previous_board" ]; then
             boards_array+=("espressif:esp32:$board_name")
             previous_board="$board_name"
             echo "Added 'espressif:esp32:$board_name' to array"
@@ -48,22 +44,19 @@ done <<< "$modified_lines"
 # Create JSON like string with all boards found and pass it to env variable
 board_count=${#boards_array[@]}
 
-if [ $board_count -gt 0 ]
-then
+if [ "$board_count" -gt 0 ]; then
     json_matrix='{"fqbn": ['
-    for board in ${boards_array[@]}
-    do
+    for board in "${boards_array[@]}"; do
         json_matrix+='"'$board'"'
-        if [ $board_count -gt 1 ]
-        then
+        if [ "$board_count" -gt 1 ]; then
             json_matrix+=","
         fi
-        board_count=$(($board_count - 1))
+        board_count=$((board_count - 1))
     done
     json_matrix+=']}'
 
-    echo $json_matrix
-    echo "FQBNS=${json_matrix}" >> $GITHUB_ENV
+    echo "$json_matrix"
+    echo "FQBNS=${json_matrix}" >> "$GITHUB_ENV"
 else
-    echo "FQBNS=" >> $GITHUB_ENV
-fi
+    echo "FQBNS=" >> "$GITHUB_ENV"
+fi

.github/scripts/install-arduino-cli.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-OSBITS=`uname -m`
+OSBITS=$(uname -m)
 if [[ "$OSTYPE" == "linux"* ]]; then
     export OS_IS_LINUX="1"
     if [[ "$OSBITS" == "i686" ]]; then
@@ -49,4 +49,3 @@ if [ ! -d "$ARDUINO_IDE_PATH" ] || [ ! -f "$ARDUINO_IDE_PATH/arduino-cli" ]; the
         curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR="$ARDUINO_IDE_PATH" sh
     fi
 fi
-

.github/scripts/install-arduino-core-esp32.sh

@@ -5,7 +5,7 @@ if [ ! -d "$ARDUINO_ESP32_PATH" ]; then
     echo "Installing ESP32 Arduino Core ..."
     script_init_path="$PWD"
     mkdir -p "$ARDUINO_USR_PATH/hardware/espressif"
-    cd "$ARDUINO_USR_PATH/hardware/espressif"
+    cd "$ARDUINO_USR_PATH/hardware/espressif" || exit
 
     echo "Installing Python Serial ..."
     pip install pyserial > /dev/null
@@ -15,25 +15,25 @@ if [ ! -d "$ARDUINO_ESP32_PATH" ]; then
         pip install requests > /dev/null
     fi
 
-    if [ ! -z "$GITHUB_REPOSITORY" ];  then
+    if [ -n "$GITHUB_REPOSITORY" ];  then
         echo "Linking Core..."
-        ln -s $GITHUB_WORKSPACE esp32
+        ln -s "$GITHUB_WORKSPACE" esp32
     else
         echo "Cloning Core Repository..."
         git clone https://github.com/espressif/arduino-esp32.git esp32 > /dev/null 2>&1
     fi
 
     #echo "Updating Submodules ..."
-    cd esp32
+    cd esp32 || exit
     #git submodule update --init --recursive > /dev/null 2>&1
 
     echo "Installing Platform Tools ..."
     if [ "$OS_IS_WINDOWS" == "1" ]; then
-      cd tools && ./get.exe
+        cd tools && ./get.exe
     else
-      cd tools && python get.py
+        cd tools && python get.py
     fi
-    cd $script_init_path
+    cd "$script_init_path" || exit
 
     echo "ESP32 Arduino has been installed in '$ARDUINO_ESP32_PATH'"
     echo ""

.github/scripts/install-arduino-ide.sh

@@ -4,7 +4,7 @@
 #OSTYPE: 'msys', ARCH: 'x86_64' => win32
 #OSTYPE: 'darwin18', ARCH: 'i386' => macos
 
-OSBITS=`uname -m`
+OSBITS=$(uname -m)
 if [[ "$OSTYPE" == "linux"* ]]; then
     export OS_IS_LINUX="1"
     ARCHIVE_FORMAT="tar.xz"
@@ -77,4 +77,3 @@ if [ ! -d "$ARDUINO_IDE_PATH" ]; then
     echo "Arduino IDE Installed in '$ARDUINO_IDE_PATH'"
     echo ""
 fi
-

.github/scripts/install-platformio-esp32.sh

@@ -52,7 +52,7 @@ python -c "$replace_script"
 
 if [ "$GITHUB_REPOSITORY" == "espressif/arduino-esp32" ];  then
     echo "Linking Core..."
-    ln -s $GITHUB_WORKSPACE "$PLATFORMIO_ESP32_PATH"
+    ln -s "$GITHUB_WORKSPACE" "$PLATFORMIO_ESP32_PATH"
 else
     echo "Cloning Core Repository ..."
     git clone --recursive https://github.com/espressif/arduino-esp32.git "$PLATFORMIO_ESP32_PATH" > /dev/null 2>&1
@@ -61,7 +61,7 @@ fi
 echo "PlatformIO for ESP32 has been installed"
 echo ""
 
-function build_pio_sketch(){ # build_pio_sketch <board> <options> <path-to-ino>
+function build_pio_sketch { # build_pio_sketch <board> <options> <path-to-ino>
     if [ "$#" -lt 3 ]; then
         echo "ERROR: Illegal number of parameters"
         echo "USAGE: build_pio_sketch <board> <options> <path-to-ino>"
@@ -71,13 +71,15 @@ function build_pio_sketch(){ # build_pio_sketch <board> <options> <path-to-ino>
     local board="$1"
     local options="$2"
     local sketch="$3"
-    local sketch_dir=$(dirname "$sketch")
+    local sketch_dir
+
+    sketch_dir=$(dirname "$sketch")
     echo ""
-    echo "Compiling '"$(basename "$sketch")"' ..."
+    echo "Compiling '$(basename "$sketch")' ..."
     python -m platformio ci --board "$board" "$sketch_dir" --project-option="$options"
 }
 
-function build_pio_sketches(){ # build_pio_sketches <board> <options> <examples-path> <chunk> <total-chunks>
+function build_pio_sketches { # build_pio_sketches <board> <options> <examples-path> <chunk> <total-chunks>
     if [ "$#" -lt 3 ]; then
         echo "ERROR: Illegal number of parameters"
         echo "USAGE: build_pio_sketches <board> <options> <examples-path> [<chunk> <total-chunks>]"
@@ -108,27 +110,34 @@ function build_pio_sketches(){ # build_pio_sketches <board> <options> <examples-
     ${COUNT_SKETCHES} "$examples" "esp32"
     local sketchcount=$?
     set -e
-    local sketches=$(cat sketches.txt)
+    local sketches
+    sketches=$(cat sketches.txt)
     rm -rf sketches.txt
 
-    local chunk_size=$(( $sketchcount / $chunks_num ))
-    local all_chunks=$(( $chunks_num * $chunk_size ))
+    local chunk_size
+    local all_chunks
+    local start_index
+    local end_index
+    local start_num
+
+    chunk_size=$(( sketchcount / chunks_num ))
+    all_chunks=$(( chunks_num * chunk_size ))
     if [ "$all_chunks" -lt "$sketchcount" ]; then
-        chunk_size=$(( $chunk_size + 1 ))
+        chunk_size=$(( chunk_size + 1 ))
     fi
 
-    local start_index=$(( $chunk_idex * $chunk_size ))
+    start_index=$(( chunk_idex * chunk_size ))
     if [ "$sketchcount" -le "$start_index" ]; then
         echo "Skipping job"
         return 0
     fi
 
-    local end_index=$(( $(( $chunk_idex + 1 )) * $chunk_size ))
+    end_index=$(( $(( chunk_idex + 1 )) * chunk_size ))
     if [ "$end_index" -gt "$sketchcount" ]; then
         end_index=$sketchcount
     fi
 
-    local start_num=$(( $start_index + 1 ))
+    start_num=$(( start_index + 1 ))
     echo "Found $sketchcount Sketches";
     echo "Chunk Count : $chunks_num"
     echo "Chunk Size  : $chunk_size"
@@ -137,25 +146,32 @@ function build_pio_sketches(){ # build_pio_sketches <board> <options> <examples-
 
     local sketchnum=0
     for sketch in $sketches; do
-        local sketchdir=$(dirname $sketch)
-        local sketchdirname=$(basename $sketchdir)
-        local sketchname=$(basename $sketch)
+        local sketchdir
+        local sketchdirname
+        local sketchname
+        local is_target
+        local has_requirements
+
+        sketchdir=$(dirname "$sketch")
+        sketchdirname=$(basename "$sketchdir")
+        sketchname=$(basename "$sketch")
+
         if [[ "$sketchdirname.ino" != "$sketchname" ]]; then
             continue
-        elif [ -f $sketchdir/ci.json ]; then
+        elif [ -f "$sketchdir"/ci.json ]; then
             # If the target is listed as false, skip the sketch. Otherwise, include it.
-            is_target=$(jq -r '.targets[esp32]' $sketchdir/ci.json)
+            is_target=$(jq -r '.targets[esp32]' "$sketchdir"/ci.json)
             if [[ "$is_target" == "false" ]]; then
                 continue
             fi
 
-            local has_requirements=$(${CHECK_REQUIREMENTS} $sketchdir "$SDKCONFIG_DIR/esp32/sdkconfig")
+            has_requirements=$(${CHECK_REQUIREMENTS} "$sketchdir" "$SDKCONFIG_DIR/esp32/sdkconfig")
             if [ "$has_requirements" == "0" ]; then
                 continue
             fi
         fi
 
-        sketchnum=$(($sketchnum + 1))
+        sketchnum=$((sketchnum + 1))
         if [ "$sketchnum" -le "$start_index" ] \
         || [ "$sketchnum" -gt "$end_index" ]; then
             continue