Add shellcheck

Author: Bill-hbrhbr

lint-requirements.txt

@@ -2,4 +2,5 @@ clang-format>=19.1.6
 clang-tidy>=19.1.0
 colorama>=0.4.6
 gersemi>=0.16.2
+shellcheck-py>=0.10.0
 yamllint>=1.35.1

taskfiles/deps.yaml

@@ -2,10 +2,12 @@ version: "3"
 
 tasks:
   default:
+    desc: "Install all required dependencies."
     cmds:
       - task: "pkgs"
 
   pkgs:
+    desc: "Install dependencies from prebuilt packages or build them from source packages."
     cmds:
       - task: "linux-pkgs"
       - task: "macos-pkgs"
@@ -23,4 +25,4 @@ tasks:
     platforms:
       - "darwin"
     cmds:
-      - "echo 'Nothing to be installed for macOS.'"
+      - "echo 'Nothing pckages required to be installed for macOS.'"

taskfiles/lint-cmake.yaml

@@ -5,7 +5,6 @@ tasks:
     desc: "Runs the CMake linters."
     sources: &cmake_format_src_files
       - "{{.G_LINT_VENV_CHECKSUM_FILE}}"
-      - "{{.G_YSTDLIB_CPP_SRC_DIR}}/.gersemirc"
       - "{{.ROOT_DIR}}/**/*.cmake"
       - "{{.ROOT_DIR}}/**/*.cmake.in"
       - "{{.ROOT_DIR}}/**/CMakeLists.txt"

taskfiles/lint-cpp.yaml

@@ -52,9 +52,9 @@ tasks:
     # NOTE: clang-tidy does have the ability to fix some errors, but the fixes can be inaccurate.
     # When we eventually determine which errors can be safely fixed, we'll allow clang-tidy to
     # fix them.
-    desc: "Runs the C++ static analyzers. Only checks for warnings and violations."
     aliases:
       - "cpp-static-fix"
+    desc: "Runs the C++ static analyzers. Only checks for warnings and violations."
     sources:
       - "{{.G_CMAKE_CACHE}}"
       - "{{.G_COMPILE_COMMANDS_DB}}"

taskfiles/lint-sh.yaml

@@ -0,0 +1,32 @@
+version: "3"
+
+tasks:
+  sh-check:
+    # NOTE: shellcheck does not have the ability to fix errors.
+    aliases:
+      - "sh-fix"
+    desc: "Runs the shell script linters. Only checks for warnings and violations."
+    sources:
+      - "{{.G_LINT_VENV_CHECKSUM_FILE}}"
+      - "{{.G_SCRIPT_DIR}}/**/*.sh"
+      - "{{.TASKFILE}}"
+      - exclude: "{{.ROOT_DIR}}/**/.shellcheckrc"
+    deps:
+      - "venv"
+    cmds:
+      - task: "shellcheck"
+        vars:
+          FLAGS: "--enable=all --severity=style --external-sources --norc"
+          SRC_PATHS:
+            ref: ".G_LINT_SH_DIRS"
+          VENV_DIR: "{{.G_LINT_VENV_DIR}}"
+
+  shellcheck:
+    internal: true
+    requires:
+      vars: ["FLAGS", "SRC_PATHS", "VENV_DIR"]
+    cmd: |-
+      . "{{.VENV_DIR}}/bin/activate"
+      find {{- range .SRC_PATHS}} "{{.}}" {{- end}} \
+        -type f -iname "*.sh" -print0 | \
+          xargs -0 shellcheck {{.FLAGS}}

taskfiles/lint-venv.yaml

@@ -9,7 +9,7 @@ tasks:
     sources:
       - "{{.ROOT_DIR}}/taskfile.yaml"
       - "{{.TASKFILE}}"
-      - "lint-requirements.txt"
+      - "{{.ROOT_DIR}}/lint-requirements.txt"
     generates:
       - "{{.CHECKSUM_FILE}}"
     run: "once"
@@ -24,7 +24,7 @@ tasks:
         vars:
           LABEL: "lint"
           OUTPUT_DIR: "{{.OUTPUT_DIR}}"
-          REQUIREMENTS_FILE: "lint-requirements.txt"
+          REQUIREMENTS_FILE: "{{.ROOT_DIR}}/lint-requirements.txt"
       # This command must be last
       - task: ":utils:compute-checksum"
         vars:

taskfiles/lint.yaml

@@ -10,13 +10,18 @@ includes:
   venv:
     flatten: true
     taskfile: "./lint-venv.yaml"
+  sh:
+    flatten: true
+    taskfile: "./lint-sh.yaml"
   yaml:
     flatten: true
     taskfile: "./lint-yaml.yaml"
 
 vars:
   G_LINT_CPP_DIRS:
     - "{{.G_CPP_SRC_DIR}}"
+  G_LINT_SH_DIRS:
+    - "{{.G_SCRIPT_DIR}}"
   G_LINT_VENV_DIR: "{{.G_BUILD_DIR}}/lint-venv"
   G_LINT_VENV_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/lint#venv.md5"
 
@@ -26,11 +31,13 @@ tasks:
     cmds:
       - task: "cmake-check"
       - task: "cpp-check"
+      - task: "sh-check"
       - task: "yaml-check"
 
   fix:
     desc: "Runs the full suite of linters and fixes some violations."
     cmds:
       - task: "cmake-fix"
       - task: "cpp-fix"
+      - task: "sh-fix"
       - task: "yaml-fix"

tools/scripts/lib_install/linux/install-all.sh

@@ -10,22 +10,23 @@ script_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 
 echo "Checking for elevated privileges..."
 privileged_command_prefix=""
-if [ ${EUID:-$(id -u)} -ne 0 ] ; then
+USER_ID=${EUID:-$(id -u)}
+if [[ 0 -ne ${USER_ID} ]] ; then
   sudo echo "Script can elevate privileges."
   privileged_command_prefix="${privileged_command_prefix} sudo"
 fi
 
 # Check if the system is running Ubuntu and determine the version
 if [[ -f /etc/os-release ]]; then
   source /etc/os-release
-  if [[ "$ID" == "ubuntu" &&
-      ( "$VERSION_CODENAME" == "focal" ||
-        "$VERSION_CODENAME" == "jammy" ||
-        "$VERSION_CODENAME" == "noble" ) ]]; then
-    dist_dir="$script_dir/ubuntu-$VERSION_CODENAME"
+  if [[ "${ID}" == "ubuntu" &&
+      ( "${VERSION_CODENAME}" == "focal" ||
+        "${VERSION_CODENAME}" == "jammy" ||
+        "${VERSION_CODENAME}" == "noble" ) ]]; then
+    dist_dir="${script_dir}/ubuntu-${VERSION_CODENAME}"
     for exe_file in \
-        "$dist_dir/install-prebuilt-packages.sh" "$dist_dir/install-packages-from-source.sh"; do
-	  [[ -f "$exe_file"  ]] && ${privileged_command_prefix} $exe_file
+        "${dist_dir}/install-prebuilt-packages.sh" "${dist_dir}/install-packages-from-source.sh"; do
+	  [[ -f "${exe_file}"  ]] && "${privileged_command_prefix} ${exe_file}"
     done
     exit 0
   fi