2020-07-13 09:34:34 +02:00
|
|
|
#!/usr/bin/env bash
|
|
|
|
|
|
|
|
# This script runs clang-format and fixes copyright headers on all relevant files in the repo.
|
|
|
|
# This is the primary script responsible for fixing style violations.
|
|
|
|
|
|
|
|
set -uo pipefail
|
|
|
|
|
2023-04-19 15:10:36 +02:00
|
|
|
if [ $# -eq 0 ]; then
|
|
|
|
# Loop through all code files tracked by Git.
|
|
|
|
files=$(git ls-files -- '*.c' '*.h' '*.cpp' '*.hpp' '*.cc' '*.hh' '*.cxx' '*.m' '*.mm' '*.inc' '*.java' '*.glsl' \
|
2022-09-06 03:23:55 +02:00
|
|
|
':!:.git/*' ':!:thirdparty/*' ':!:*/thirdparty/*' ':!:platform/android/java/lib/src/com/google/*' \
|
2023-04-19 15:10:36 +02:00
|
|
|
':!:*-so_wrap.*' ':!:tests/python_build/*')
|
|
|
|
else
|
|
|
|
# $1 should be a file listing file paths to process. Used in CI.
|
|
|
|
files=$(cat "$1" | grep -v "thirdparty/" | grep -E "\.(c|h|cpp|hpp|cc|hh|cxx|m|mm|inc|java|glsl)$" | grep -v "platform/android/java/lib/src/com/google/" | grep -v "\-so_wrap\." | grep -v "tests/python_build/")
|
|
|
|
fi
|
2022-01-27 17:34:33 +01:00
|
|
|
|
2023-04-19 15:10:36 +02:00
|
|
|
if [ ! -z "$files" ]; then
|
|
|
|
clang-format --Wno-error=unknown -i $files
|
|
|
|
fi
|
|
|
|
|
|
|
|
# Fix copyright headers, but not all files get them.
|
|
|
|
for f in $files; do
|
2023-08-02 14:45:44 +02:00
|
|
|
if [[ "$f" == *"inc" && "$f" != *"compat.inc" ]]; then
|
2022-01-27 17:34:33 +01:00
|
|
|
continue
|
|
|
|
elif [[ "$f" == *"glsl" ]]; then
|
|
|
|
continue
|
2022-03-28 03:09:48 +02:00
|
|
|
elif [[ "$f" == "platform/android/java/lib/src/org/godotengine/godot/gl/GLSurfaceView"* ]]; then
|
|
|
|
continue
|
|
|
|
elif [[ "$f" == "platform/android/java/lib/src/org/godotengine/godot/gl/EGLLogWrapper"* ]]; then
|
|
|
|
continue
|
2022-05-23 21:33:15 +02:00
|
|
|
elif [[ "$f" == "platform/android/java/lib/src/org/godotengine/godot/utils/ProcessPhoenix"* ]]; then
|
|
|
|
continue
|
2022-01-27 17:34:33 +01:00
|
|
|
fi
|
|
|
|
|
|
|
|
python misc/scripts/copyright_headers.py "$f"
|
2020-07-13 09:34:34 +02:00
|
|
|
done
|
|
|
|
|
2022-01-27 17:34:33 +01:00
|
|
|
diff=$(git diff --color)
|
2020-07-13 09:34:34 +02:00
|
|
|
|
2022-04-23 00:13:08 +02:00
|
|
|
# If no diff has been generated all is OK, clean up, and exit.
|
2022-01-27 17:34:33 +01:00
|
|
|
if [ -z "$diff" ] ; then
|
2023-04-05 13:51:38 +02:00
|
|
|
printf "\e[1;32m*** Files in this commit comply with the clang-format style rules.\e[0m\n"
|
2020-07-13 09:34:34 +02:00
|
|
|
exit 0
|
|
|
|
fi
|
|
|
|
|
2022-04-23 00:13:08 +02:00
|
|
|
# A diff has been created, notify the user, clean up, and exit.
|
2023-04-05 13:51:38 +02:00
|
|
|
printf "\n\e[1;33m*** The following changes must be made to comply with the formatting rules:\e[0m\n\n"
|
|
|
|
# Perl commands replace trailing spaces with `·` and tabs with `<TAB>`.
|
2024-02-02 12:10:02 +01:00
|
|
|
printf "%s\n" "$diff" | perl -pe 's/(.*[^ ])( +)(\e\[m)$/my $spaces="·" x length($2); sprintf("$1$spaces$3")/ge' | perl -pe 's/(.*[^\t])(\t+)(\e\[m)$/my $tabs="<TAB>" x length($2); sprintf("$1$tabs$3")/ge'
|
2023-04-05 13:51:38 +02:00
|
|
|
|
|
|
|
printf "\n\e[1;91m*** Please fix your commit(s) with 'git commit --amend' or 'git rebase -i <hash>'\e[0m\n"
|
2020-07-13 09:34:34 +02:00
|
|
|
exit 1
|