Avoid excessive indentation in shell commands

per1234 · per1234 · commit 6e225bbca776 · 2025-09-05T14:47:14.000-07:00
The project's GitHub Actions workflows and tasks contain complex shell command lines.

With the use of the line continuation operator, these commands can be split into multiple code lines. This improves
readability by providing a visualization of the command structure. It also improves maintainability by making diffs for
changes to these commands more clear.

The readability can be further improved by indentation of the subsequent lines of the command in a manner that visually
conveys the structure.

Previously, in cases where multiple commands are chained via control or list operators, the subsequent commands were
indented relative to the prior command in the chain. Although this did help to visually convey the structure, it also
resulted in excessive levels of indentation. It also resulted in some visual ambiguity between indentation used for
arguments to a command, and that for subsequent commands in the chain. For these reasons, the determination was made to
not indent the subsequent commands in the chain. The structure is communicated by placing the operator linking the
commands on a dedicated line.
diff --git a/.github/workflows/check-npm-task.yml b/.github/workflows/check-npm-task.yml
@@ -150,14 +150,12 @@ jobs:
 
       - name: Fix problems in npm configuration file
         run: |
-          task \
-            npm:fix-config \
+          task npm:fix-config \
             PROJECT_PATH="${{ matrix.project.path }}"
 
       - name: Check if fixes are needed in npm configuration file
         run: |
-          git \
-            diff \
-              --color \
-              --exit-code \
-              "${{ matrix.project.path }}/.npmrc"
+          git diff \
+            --color \
+            --exit-code \
+            "${{ matrix.project.path }}/.npmrc"
diff --git a/.github/workflows/test-install-script.yml b/.github/workflows/test-install-script.yml
@@ -241,10 +241,11 @@ jobs:
           BINDIR: ${{ env.FIRST_BINDIR }}
         run: |
           mkdir -p "${{ env.BINDIR }}"
-          "${{ github.workspace }}/${{ env.SCRIPT_NAME }}" | \
-            grep \
-              -F \
-              '${{ env.TOOL_NAME }} not found. You might want to add "${{ env.FIRST_BINDIR }}" to your $PATH'
+          "${{ github.workspace }}/${{ env.SCRIPT_NAME }}" \
+          | \
+          grep \
+            -F \
+            '${{ env.TOOL_NAME }} not found. You might want to add "${{ env.FIRST_BINDIR }}" to your $PATH'
 
       - name: Add first installation to PATH
         shell: bash
@@ -259,10 +260,11 @@ jobs:
           BINDIR: ${{ env.SECOND_BINDIR }}
         run: |
           mkdir -p "${{ env.BINDIR }}"
-          "${{ github.workspace }}/${{ env.SCRIPT_NAME }}" | \
-            grep \
-              -F \
-              '${{ env.TOOL_NAME }} was found at ${{ env.FIRST_BINDIR }}/${{ env.TOOL_NAME }}. Please prepend "${{ env.BINDIR }}" to your $PATH'
+          "${{ github.workspace }}/${{ env.SCRIPT_NAME }}" \
+          | \
+          grep \
+            -F \
+            '${{ env.TOOL_NAME }} was found at ${{ env.FIRST_BINDIR }}/${{ env.TOOL_NAME }}. Please prepend "${{ env.BINDIR }}" to your $PATH'
 
       # ${{ runner.temp }} is a Windows style path on the windows runner, but the script output uses the equivalent
       # POSIX style path.
@@ -274,6 +276,7 @@ jobs:
           BINDIR: ${{ env.SECOND_BINDIR }}
         run: |
           mkdir -p "${{ env.BINDIR }}"
-          "${{ github.workspace }}/${{ env.SCRIPT_NAME }}" | \
-            grep \
-              '${{ env.TOOL_NAME }} was found at .*/${{ env.FIRST_INSTALLATION_FOLDER }}/${{ env.TOOL_NAME }}\. Please prepend ".*/${{ env.SECOND_INSTALLATION_FOLDER }}" to your \$PATH'
+          "${{ github.workspace }}/${{ env.SCRIPT_NAME }}" \
+          | \
+          grep \
+            '${{ env.TOOL_NAME }} was found at .*/${{ env.FIRST_INSTALLATION_FOLDER }}/${{ env.TOOL_NAME }}\. Please prepend ".*/${{ env.SECOND_INSTALLATION_FOLDER }}" to your \$PATH'
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -254,14 +254,14 @@ tasks:
       - |
         # Add source comment
         echo \
-          "# Source: https://github.com/arduino/tooling-project-assets/tree/main/other/clang-format-configuration" > \
-            "{{.TARGET_PATH}}"
+          "# Source: https://github.com/arduino/tooling-project-assets/tree/main/other/clang-format-configuration" \
+        > "{{.TARGET_PATH}}"
 
         # Dump the effective configuration to the target file
         clang-format \
           --dump-config \
-          --style=file:"{{.CLANG_FORMAT_CONFIGURATION_PATH}}" >> \
-            "{{.TARGET_PATH}}"
+          --style=file:"{{.CLANG_FORMAT_CONFIGURATION_PATH}}" \
+        >> "{{.TARGET_PATH}}"
 
       - |
         # Correct invalid `BasedOnStyle` key value
@@ -457,11 +457,12 @@ tasks:
             sh \
               -c \
                 ' \
-                  basename "$0" | \
-                    grep \
-                      --extended-regexp \
-                      --regexp='"'"'([<>:"/\\|?*'"'"'"$(printf "\001-\037")"'"'"'])|(.+\.$)'"'"' \
-                      --silent \
+                  basename "$0" \
+                  | \
+                  grep \
+                    --extended-regexp \
+                    --regexp='"'"'([<>:"/\\|?*'"'"'"$(printf "\001-\037")"'"'"'])|(.+\.$)'"'"' \
+                    --silent \
                   && \
                   echo "$0"
                 ' \
@@ -489,12 +490,13 @@ tasks:
             sh \
               -c \
                 ' \
-                  basename "$0" | \
-                    grep \
-                      --ignore-case \
-                      --extended-regexp \
-                      --regexp='"'"'^(con|prn|aux|nul|com[0-9]+|lpt[0-9]+)$'"'"' \
-                      --silent \
+                  basename "$0" \
+                  | \
+                  grep \
+                    --ignore-case \
+                    --extended-regexp \
+                    --regexp='"'"'^(con|prn|aux|nul|com[0-9]+|lpt[0-9]+)$'"'"' \
+                    --silent \
                   && \
                   echo "$0"
                 ' \
@@ -765,10 +767,9 @@ tasks:
       "{{default .DEFAULT_NPM_PROJECT_PATH .PROJECT_PATH}}"
     cmds:
       - |
-        npm \
-          config \
-            --location project \
-            fix
+        npm config \
+          --location project \
+          fix
 
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-npm-task/Taskfile.yml
   npm:validate:
@@ -869,7 +870,7 @@ tasks:
               --input-format toml \
               --output-format yaml \
               '.tool.poetry.dependencies.python' \
-              < pyproject.toml
+            < pyproject.toml
           )"
 
           echo "Python not found or not in PATH."
@@ -894,7 +895,7 @@ tasks:
               --input-format toml \
               --output-format yaml \
               '.tool.poetry.group.pipx.dependencies.poetry' \
-              < pyproject.toml
+            < pyproject.toml
           )"
 
         pipx install \
diff --git a/workflow-templates/assets/check-action-metadata-task/Taskfile.yml b/workflow-templates/assets/check-action-metadata-task/Taskfile.yml
@@ -20,8 +20,7 @@ tasks:
           https://json.schemastore.org/github-action
       - |
         npx \
-          ajv-cli \
-            validate \
+          ajv-cli validate \
             --strict=false \
             -s "{{.ACTION_METADATA_SCHEMA_PATH}}" \
             -d "action.yml"
diff --git a/workflow-templates/assets/check-files-task/Taskfile.yml b/workflow-templates/assets/check-files-task/Taskfile.yml
@@ -16,11 +16,12 @@ tasks:
             sh \
               -c \
                 ' \
-                  basename "$0" | \
-                    grep \
-                      --extended-regexp \
-                      --regexp='"'"'([<>:"/\\|?*'"'"'"$(printf "\001-\037")"'"'"'])|(.+\.$)'"'"' \
-                      --silent \
+                  basename "$0" \
+                  | \
+                  grep \
+                    --extended-regexp \
+                    --regexp='"'"'([<>:"/\\|?*'"'"'"$(printf "\001-\037")"'"'"'])|(.+\.$)'"'"' \
+                    --silent \
                   && \
                   echo "$0"
                 ' \
@@ -48,12 +49,13 @@ tasks:
             sh \
               -c \
                 ' \
-                  basename "$0" | \
-                    grep \
-                      --ignore-case \
-                      --extended-regexp \
-                      --regexp='"'"'^(con|prn|aux|nul|com[0-9]+|lpt[0-9]+)$'"'"' \
-                      --silent \
+                  basename "$0" \
+                  | \
+                  grep \
+                    --ignore-case \
+                    --extended-regexp \
+                    --regexp='"'"'^(con|prn|aux|nul|com[0-9]+|lpt[0-9]+)$'"'"' \
+                    --silent \
                   && \
                   echo "$0"
                 ' \
diff --git a/workflow-templates/assets/check-npm-task/Taskfile.yml b/workflow-templates/assets/check-npm-task/Taskfile.yml
@@ -12,10 +12,9 @@ tasks:
       "{{default .DEFAULT_NPM_PROJECT_PATH .PROJECT_PATH}}"
     cmds:
       - |
-        npm \
-          config \
-            --location project \
-            fix
+        npm config \
+          --location project \
+          fix
 
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-npm-task/Taskfile.yml
   npm:validate:
diff --git a/workflow-templates/assets/poetry-task/Taskfile.yml b/workflow-templates/assets/poetry-task/Taskfile.yml
@@ -20,7 +20,7 @@ tasks:
               --input-format toml \
               --output-format yaml \
               '.tool.poetry.dependencies.python' \
-              < pyproject.toml
+            < pyproject.toml
           )"
 
           echo "Python not found or not in PATH."
@@ -45,7 +45,7 @@ tasks:
               --input-format toml \
               --output-format yaml \
               '.tool.poetry.group.pipx.dependencies.poetry' \
-              < pyproject.toml
+            < pyproject.toml
           )"
 
         pipx install \
diff --git a/workflow-templates/check-certificates.yml b/workflow-templates/check-certificates.yml
@@ -101,7 +101,9 @@ jobs:
               -legacy \
               -noout \
               -passin env:CERTIFICATE_PASSWORD
-          ) || (
+          ) \
+          || \
+          (
             echo "::error::Verification of ${{ matrix.certificate.identifier }} failed!!!"
             exit 1
           )
@@ -125,39 +127,45 @@ jobs:
         run: |
           if [[ ${{ matrix.certificate.type }} == "pkcs12" ]]; then
             EXPIRATION_DATE="$(
-                (
+              (
                 openssl pkcs12 \
-                    -in ${{ env.CERTIFICATE_PATH }} \
-                    -clcerts \
-                    -legacy \
-                    -nodes \
-                    -passin env:CERTIFICATE_PASSWORD
-                ) | (
+                  -in ${{ env.CERTIFICATE_PATH }} \
+                  -clcerts \
+                  -legacy \
+                  -nodes \
+                  -passin env:CERTIFICATE_PASSWORD
+              ) \
+              | \
+              (
                 openssl x509 \
-                    -noout \
-                    -enddate
-                ) | (
+                  -noout \
+                  -enddate
+              ) \
+              | \
+              (
                 grep \
-                    --max-count=1 \
-                    --only-matching \
-                    --perl-regexp \
-                    'notAfter=(\K.*)'
-                )
+                  --max-count=1 \
+                  --only-matching \
+                  --perl-regexp \
+                  'notAfter=(\K.*)'
+              )
             )"
           elif [[ ${{ matrix.certificate.type }} == "x509" ]]; then
             EXPIRATION_DATE="$(
-                (
+              (
                 openssl x509 \
-                    -in ${{ env.CERTIFICATE_PATH }} \
-                    -noout \
-                    -enddate
-                ) | (
+                  -in ${{ env.CERTIFICATE_PATH }} \
+                  -noout \
+                  -enddate
+              ) \
+              | \
+              (
                 grep \
-                    --max-count=1 \
-                    --only-matching \
-                    --perl-regexp \
-                    'notAfter=(\K.*)'
-                )
+                  --max-count=1 \
+                  --only-matching \
+                  --perl-regexp \
+                  'notAfter=(\K.*)'
+              )
             )"
           fi
 
diff --git a/workflow-templates/check-npm-task.yml b/workflow-templates/check-npm-task.yml
@@ -150,14 +150,12 @@ jobs:
 
       - name: Fix problems in npm configuration file
         run: |
-          task \
-            npm:fix-config \
+          task npm:fix-config \
             PROJECT_PATH="${{ matrix.project.path }}"
 
       - name: Check if fixes are needed in npm configuration file
         run: |
-          git \
-            diff \
-              --color \
-              --exit-code \
-              "${{ matrix.project.path }}/.npmrc"
+          git diff \
+            --color \
+            --exit-code \
+            "${{ matrix.project.path }}/.npmrc"
diff --git a/workflow-templates/release-tag.yml b/workflow-templates/release-tag.yml
@@ -48,8 +48,8 @@ jobs:
           unzip \
             -p \
             "${{ steps.download-semver-tool.outputs.file-path }}" \
-            semver-tool-${{ env.SEMVER_TOOL_VERSION }}/src/semver > \
-              "${{ env.SEMVER_TOOL_PATH }}"
+            semver-tool-${{ env.SEMVER_TOOL_VERSION }}/src/semver \
+          >"${{ env.SEMVER_TOOL_PATH }}"
           chmod +x "${{ env.SEMVER_TOOL_PATH }}"
 
       - name: Identify Prerelease
