Skip to content

shellcheck: improve handling of ShellCheck internal errors #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kdudka merged 2 commits into from
Mar 4, 2025
Merged

shellcheck: improve handling of ShellCheck internal errors #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ce104a
CI: trigger on pushes to `main` branch only
lzaoral Feb 24, 2025
083f124
shellcheck: improve handling of ShellCheck internal errors
kdudka Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/differential-shellcheck.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
name: Differential ShellCheck
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

Expand Down
13 changes: 10 additions & 3 deletions scripts/run-shellcheck.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,24 +82,31 @@ filter_shell_scripts"' "$@"'
# function that creates a separate JSON file if shellcheck detects anything
wrap_shellcheck() {
dst="${SC_RESULTS_DIR}/sc-$$.json"
log="${dst%.json}.log"

# compatibility workaround for old versions of shellcheck
echo -n "$SC_RESULTS_BEG" > "$dst"

(set -x && timeout "${SC_TIMEOUT}" shellcheck "${SC_OPTS[@]}" "$@" >> "$dst")
(set -x && timeout "${SC_TIMEOUT}" shellcheck "${SC_OPTS[@]}" "$@" >> "$dst" 2> "$log")
EC=$?

# compatibility workaround for old versions of shellcheck
echo -n "$SC_RESULTS_END" >> "$dst"

case $EC in
0)
# no findings detected -> remove the output file
rm -f "$dst"
# no findings detected -> remove the output files
rm -f "$dst" "$log"
;;

1)
# findings detected -> successful run
if [ -n "$(<"$log")" ]; then
# something printed to stderr -> record an internal error of shellcheck
sed -re 's|^(shellcheck): ([^:]+): (.*)$|\2: internal error: \3 <--[\1]|' "$log" > "$dst"
else
rm -f "$log"
fi
return 0
;;

Expand Down