check-scripts.sh: added script to check linting and formatting

Ticket: ENT-12601
Signed-off-by: Lars Erik Wik <[email protected]>

Author: larsewi

build-scripts/produce-debug-symbols

@@ -4,7 +4,7 @@
 . detect-environment
 . compile-options
 
-if [ "$BUILD_TYPE" != "RELEASE" ]; then
+if [ $BUILD_TYPE != "RELEASE" ]; then
     echo "Debug symbols not requested"
     exit 0
 else
@@ -60,7 +60,7 @@ done
 
 # Write the installation script
 log_debug "Writing the installation script"
-cat <<EOF >> $PAYLOAD_DIR/install-ds.sh
+cat <<EOF >>$PAYLOAD_DIR/install-ds.sh
 #!/bin/sh
 # Install debug symbols for executables
 for i in \`ls exe/*.gz\`; do
@@ -77,7 +77,7 @@ EOF
 
 # Write the decompression script
 log_debug "Writing the decompression script"
-cat <<EOF >> decompress-ds.sh
+cat <<EOF >>decompress-ds.sh
 #!/bin/sh
 echo "Installing debug symbols"
 TMPDIR=\`mktemp -d /tmp/ds.XXXXXX\`; export TMPDIR
@@ -97,7 +97,7 @@ EOF
 
 # Write the uninstall script
 log_debug "Writing the uninstall script"
-cat <<EOF >> $PAYLOAD_DIR/uninstall-ds.sh
+cat <<EOF >>$PAYLOAD_DIR/uninstall-ds.sh
 #!/bin/sh
 echo "Uninstalling debug symbols"
 rm -f "$PREFIX"/bin/*.\$DEBUG_SUFFIX

user-scripts/check-scripts.sh

@@ -0,0 +1,40 @@
+#!/bin/bash -e
+
+#
+# Interactively lint & format shell scripts in the build-scripts directory.
+#
+# Dependencies:
+# * shfmt
+# * shellcheck
+#
+# This script takes no arguments can be executed from anywhere, e.g.:
+# $ ./user-scripts/check-scripts.sh
+#
+
+BUILD_SCRIPTS="$(dirname "$0")"/../build-scripts
+
+grep -Erl '^(#!/(bin|usr/bin)/(env )?(sh|bash))' "$BUILD_SCRIPTS" | sort | while read -r filepath; do
+    filename=$(basename "$filepath")
+
+    if ! shfmt --diff --indent=4 "$filepath"; then
+        echo
+        echo "File '$filename' requires formatting."
+        read -r -p "Do you wish to format '$filename'? [y/N] " answer </dev/tty
+        case $answer in
+        [yY] | [yY][eE][sS])
+            echo "Formatting file '$filename'..."
+            shfmt --write --indent=4 "$filepath"
+            ;;
+        *)
+            echo "Skipping formatting of file '$filename'..."
+            ;;
+        esac
+    fi
+
+    if ! shellcheck --external-sources --source-path="$BUILD_SCRIPTS" "$filepath"; then
+        echo
+        echo "File '$filename' requires manual intervention."
+        read -n 1 -s -r -p "Press any key to continue..." </dev/tty
+        echo
+    fi
+done