godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7bb68278bb
godot/misc/scripts/file_format.sh

83 lines
2.5 KiB
Bash
Raw Normal View History

Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
#!/usr/bin/env bash
# This script ensures proper POSIX text file formatting and a few other things.
Style: Fix code format scripts compat with non-GNU Unices It's too hard to get compatibility between GNU and BSD sed, so let's just use perl oneliners. And improve it to also remove trailing tabs, not just spaces.
2020-07-25 19:38:34 +00:00
# This is supplementary to clang_format.sh and black_format.sh, but should be
# run before them.
Fix file formatting script dependencies and cleanup
2023-01-12 22:16:02 +00:00
# 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"
Style: Fix code format scripts compat with non-GNU Unices It's too hard to get compatibility between GNU and BSD sed, so let's just use perl oneliners. And improve it to also remove trailing tabs, not just spaces.
2020-07-25 19:38:34 +00:00
fi
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
set -uo pipefail
IFS=$'\n\t'
# Loops through all text files tracked by Git.
git grep -zIl '' |
while IFS= read -rd '' f; do
# Exclude some types of files.
if [[ "$f" == *"csproj" ]]; then
continue
elif [[ "$f" == *"sln" ]]; then
continue
Skip formatting .bat files in file_format.sh These are supposed to have CRLF because Windows, so we'll just skip this file type in the script.
2022-01-06 01:53:08 +00:00
elif [[ "$f" == *".bat" ]]; then
continue
Add dozens of new integration tests to the GDScript test suite This also ignores `.out` files in the file format static checks.
2021-04-19 18:50:52 +00:00
elif [[ "$f" == *".out" ]]; then
# GDScript integration testing files.
continue
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
elif [[ "$f" == *"patch" ]]; then
continue
elif [[ "$f" == *"pot" ]]; then
continue
elif [[ "$f" == *"po" ]]; then
continue
Add an exception for thirdparty subdirectories in file_format.sh This exception is also present in clang_format.sh and is needed in some cases.
2022-11-12 23:46:13 +00:00
elif [[ "$f" == "thirdparty/"* ]]; then
continue
elif [[ "$f" == *"/thirdparty/"* ]]; then
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
continue
elif [[ "$f" == "platform/android/java/lib/src/com/google"* ]]; then
continue
Dynamically load libudev.so.1 on Linux if `udev=yes` This makes it possibly to run Linux binaries compiled with udev support on Linux systems which do not provide udev (typically systemd-less distros). If udev is missing, we fall back to parsing `/dev/input` like when compiled without udev support (`udev=no`). Also adding some verbose debug statements to know which method we're using when debugging Linux joypad issues. The libudev so wrappers were generated on Mageia 8 with libudev 246.9 using https://github.com/hpvb/dynload-wrapper: ``` ./generate-wrapper.py --include /usr/include/libudev.h --sys-include '<libudev.h>' \ --soname libudev.so.1 --init-name libudev --omit-prefix gnu_ \ --output-header libudev-so_wrap.h --output-implementation libudev-so_wrap.c ```
2021-02-17 10:28:27 +00:00
elif [[ "$f" == *"-so_wrap."* ]]; then
continue
File: Re-add support to skip CR (`\r`) in `File::get_as_text` This was removed in #63481, and we confirmed that it's better like this, but we add back the possibility to strip CR as an option, to optionally restore the previous behavior. For performance this is done directly in `String::parse_utf8`. Also fixes Android `FileAccess::get_line()` as this one _should_ strip CR. Supersedes #63717.
2022-07-31 16:46:53 +00:00
elif [[ "$f" == *".test.txt" ]]; then
continue
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
fi
Fix incorrect comments in file formatting script
2020-07-28 06:56:05 +00:00
# Ensure that files are UTF-8 formatted.
Fix UTF-8 validation in static checks Use isutf8 instead of recode to detect invalid UTF-8 sequences. Also add the necessary dependencies to run the static checks locally using act (https://github.com/nektos/act) with the Medium size image.
2022-09-05 09:55:51 +00:00
isutf8 "$f" >> utf8-validation.txt 2>&1
Fix incorrect comments in file formatting script
2020-07-28 06:56:05 +00:00
# Ensure that files have LF line endings and do not contain a BOM.
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
dos2unix "$f" 2> /dev/null
Fix incorrect comments in file formatting script
2020-07-28 06:56:05 +00:00
# Remove trailing space characters and ensures that files end
# with newline characters. -l option handles newlines conveniently.
Style: Fix code format scripts compat with non-GNU Unices It's too hard to get compatibility between GNU and BSD sed, so let's just use perl oneliners. And improve it to also remove trailing tabs, not just spaces.
2020-07-25 19:38:34 +00:00
perl -i -ple 's/\s*$//g' "$f"
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
done
simplify formatting scripts, add a clang-tidy script, and run clang-tidy
2022-01-27 16:34:33 +00:00
diff=$(git diff --color)
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
Fix UTF-8 validation in static checks Use isutf8 instead of recode to detect invalid UTF-8 sequences. Also add the necessary dependencies to run the static checks locally using act (https://github.com/nektos/act) with the Medium size image.
2022-09-05 09:55:51 +00:00
if [ ! -s utf8-validation.txt ] && [ -z "$diff" ] ; then
Fix file formatting script dependencies and cleanup
2023-01-12 22:16:02 +00:00
# If no UTF-8 violations were collected (the file is empty) and
# no diff has been generated all is OK, clean up, and exit.
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
printf "Files in this commit comply with the formatting rules.\n"
Fix file formatting script dependencies and cleanup
2023-01-12 22:16:02 +00:00
rm -f utf8-validation.txt
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
exit 0
fi
Fix UTF-8 validation in static checks Use isutf8 instead of recode to detect invalid UTF-8 sequences. Also add the necessary dependencies to run the static checks locally using act (https://github.com/nektos/act) with the Medium size image.
2022-09-05 09:55:51 +00:00
if [ -s utf8-validation.txt ]
then
Fix file formatting script dependencies and cleanup
2023-01-12 22:16:02 +00:00
# If the file has content and is not empty, violations
# detected, notify the user, clean up, and exit.
Fix UTF-8 validation in static checks Use isutf8 instead of recode to detect invalid UTF-8 sequences. Also add the necessary dependencies to run the static checks locally using act (https://github.com/nektos/act) with the Medium size image.
2022-09-05 09:55:51 +00:00
printf "\n*** The following files contain invalid UTF-8 character sequences:\n\n"
cat utf8-validation.txt
fi
Fix file formatting script dependencies and cleanup
2023-01-12 22:16:02 +00:00
rm -f utf8-validation.txt
Fix UTF-8 validation in static checks Use isutf8 instead of recode to detect invalid UTF-8 sequences. Also add the necessary dependencies to run the static checks locally using act (https://github.com/nektos/act) with the Medium size image.
2022-09-05 09:55:51 +00:00
if [ ! -z "$diff" ]
then
printf "\n*** The following differences were found between the code "
printf "and the formatting rules:\n\n"
echo "$diff"
fi
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
printf "\n*** Aborting, please fix your commit(s) with 'git commit --amend' or 'git rebase -i <hash>'\n"
exit 1
Reference in New Issue Copy Permalink