format-code: Flag lint failures at point of failure
The current format-code script will call all linters and if any of them
fail, it will only print the failure message at the end.
This change will highlight the failure immediately after the lint
failure to easily pinpoint the cause faster.
The fail message will continue to be logged at the end.
Current behavior:
```
Formatting code under /home/cjcain/obmc/code/openpower-occ-control
markdownlint: cannot find .markdownlint.yaml; using /home/cjcain/obmc/code/openbmc-build-scripts/config/markdownlint.yaml
prettier: cannot find .prettierrc.yaml; using /home/cjcain/obmc/code/openbmc-build-scripts/config/prettierrc.yaml
Running commit_gitlint
-: UC2 Multiple Change-Ids found in commit message body: "['Change-Id: Ic2bca9f55227f9e052255e28c68ae01bef2f4885', 'Change-Id: Ic2bca9f55227f9e052255e28c68ae01bef2f4885']"
Running commit_spelling
codespell-dictionary - misspelling count >> 0
generic-dictionary - misspelling count >> 0
Running beautysh_sh
Running black
All done!
1 file left unchanged.
Running clang_format
Running flake8
Running isort
Running markdownlint
Running meson
Running prettier
README.md 29ms (unchanged)
example/occ_sensor.yaml 17ms (unchanged)
Running shellcheck
commit_gitlint: FAILED
```
Tested with successful build as well as several failures:
New behavior:
```
Running commit_gitlint
-: UC2 Multiple Change-Ids found in commit message body: "['Change-Id: Ic2bca9f55227f9e052255e28c68ae01bef2f4885', 'Change-Id: Ic2bca9f55227f9e052255e28c68ae01bef2f4885']"
commit_gitlint - FAILED
Running commit_spelling
codespell-dictionary - misspelling count >> 0
generic-dictionary - misspelling count >> 0
Running beautysh_sh
Running black
All done!
1 file left unchanged.
Running clang_format
Running flake8
Running isort
Running markdownlint
Running meson
Running prettier
README.md 29ms (unchanged)
example/occ_sensor.yaml 17ms (unchanged)
Running shellcheck
commit_gitlint: FAILED (see prior failure)
```
and
```
Running commit_gitlint
Running commit_spelling
codespell-dictionary - misspelling count >> /tmp/tmp.dYkiwSB4jr:7: Every time ==> Every time
1
generic-dictionary - misspelling count >> /tmp/tmp.dYkiwSB4jr:7: Every time ==> Every time
1
commit_spelling - FAILED
Running beautysh_sh
Running black
```
Change-Id: I5c9182f9d5c646f6c1bfea1176695b94cd5fa4bf
Signed-off-by: Chris Cain <cjcain@us.ibm.com>
diff --git a/scripts/format-code.sh b/scripts/format-code.sh
index 09e43dd..7b8ffda 100755
--- a/scripts/format-code.sh
+++ b/scripts/format-code.sh
@@ -424,6 +424,7 @@
echo -e " ${BLUE}Running $op${NORMAL}"
if ! "do_$op" "${LINTER_FILES[@]}" ; then
LINTERS_FAILED+=([$op]=1)
+ echo -e " ${RED}$op - FAILED${NORMAL}"
fi
else
echo -e " ${YELLOW}${op}:${NORMAL} all applicable files are on ignore-lists"
@@ -433,7 +434,7 @@
# Check for failing linters.
if [ 0 -ne ${#LINTERS_FAILED[@]} ]; then
for op in "${!LINTERS_FAILED[@]}"; do
- echo -e "$op: ${RED}FAILED${NORMAL}"
+ echo -e "$op: ${RED}FAILED${NORMAL} (see prior failure)"
done
exit 1
fi