Skip to content

Commit

Permalink
Fix file formatting script dependencies and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronfranke committed Jan 12, 2023
1 parent e62f57f commit 06450bf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/static_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
- name: Install dependencies
run: |
sudo apt-get install -qq dos2unix recode clang-format-15 libxml2-utils python3-pip moreutils
sudo apt-get install -qq dos2unix clang-format-15 libxml2-utils python3-pip moreutils
sudo update-alternatives --remove-all clang-format || true
sudo update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-15 100
sudo pip3 install black==22.3.0 pygments pytest==7.1.2 mypy==0.971
Expand Down
18 changes: 10 additions & 8 deletions misc/scripts/file_format.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
# This is supplementary to clang_format.sh and black_format.sh, but should be
# run before them.

# We need dos2unix and recode.
if [ ! -x "$(command -v dos2unix)" -o ! -x "$(command -v recode)" ]; then
printf "Install 'dos2unix' and 'recode' to use this script.\n"
# We need dos2unix and isutf8.
if [ ! -x "$(command -v dos2unix)" -o ! -x "$(command -v isutf8)" ]; then
printf "Install 'dos2unix' and 'isutf8' (moreutils package) to use this script.\n"
fi

set -uo pipefail
Expand Down Expand Up @@ -53,22 +53,24 @@ done

diff=$(git diff --color)

# If no UTF-8 violations were collected and no diff has been
# generated all is OK, clean up, and exit.
if [ ! -s utf8-validation.txt ] && [ -z "$diff" ] ; then
# If no UTF-8 violations were collected (the file is empty) and
# no diff has been generated all is OK, clean up, and exit.
printf "Files in this commit comply with the formatting rules.\n"
rm -f utf8-violations.txt
rm -f utf8-validation.txt
exit 0
fi

# Violations detected, notify the user, clean up, and exit.
if [ -s utf8-validation.txt ]
then
# If the file has content and is not empty, violations
# detected, notify the user, clean up, and exit.
printf "\n*** The following files contain invalid UTF-8 character sequences:\n\n"
cat utf8-validation.txt
rm -f utf8-validation.txt
fi

rm -f utf8-validation.txt

if [ ! -z "$diff" ]
then
printf "\n*** The following differences were found between the code "
Expand Down

0 comments on commit 06450bf

Please sign in to comment.