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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

54 lines
2.3 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 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
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 13:10:36 +00: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' \
C#: Replace libnethost dependency to find hostfxr We want to replace libnethost as it gives us issues with some compilers. Our implementation tries to mimic libnethost's hostfxr_resolver search logic. We try to use the same function names for easier comparing in case we need to update this in the future.
2022-09-06 01:23:55 +00:00
':!:.git/*' ':!:thirdparty/*' ':!:*/thirdparty/*' ':!:platform/android/java/lib/src/com/google/*' \
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 13:10:36 +00: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
simplify formatting scripts, add a clang-tidy script, and run clang-tidy
2022-01-27 16:34:33 +00:00
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 13:10:36 +00: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
Fix or workaround recent extension API compatibility issues - Add compatibility methods for `RenderingDevice::shader_create_from_bytecode` and `CodeEdit::get_text_for_symbol_loopup`. - Silence errors which now have compatibility methods. - Acknowledge GraphEdit/GraphNode compat breakage, intended and WIP.
2023-08-02 12:45:44 +00:00
if [[ "$f" == *"inc" && "$f" != *"compat.inc" ]]; then
simplify formatting scripts, add a clang-tidy script, and run clang-tidy
2022-01-27 16:34:33 +00:00
continue
elif [[ "$f" == *"glsl" ]]; then
continue
Fix flickering issues with low processor mode on Android
2022-03-28 01:09:48 +00: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
Fix the logic to restart the Godot application
2022-05-23 19:33:15 +00:00
elif [[ "$f" == "platform/android/java/lib/src/org/godotengine/godot/utils/ProcessPhoenix"* ]]; then
continue
simplify formatting scripts, add a clang-tidy script, and run clang-tidy
2022-01-27 16:34:33 +00:00
fi
python misc/scripts/copyright_headers.py "$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
improve OS.get_name classref, misc/scripts fixes, remove trailing quote
2022-04-22 22:13:08 +00:00
# If no diff has been generated all is OK, clean up, and exit.
simplify formatting scripts, add a clang-tidy script, and run clang-tidy
2022-01-27 16:34:33 +00:00
if [ -z "$diff" ] ; then
CI: Visibly print trailing whitespace when static checks fail GitHub Actions seems to be hiding colored whitespace, and after lots of attempts I couldn't find a way to work it around. So instead I'm using a perl expression to replace trailing spaces with `·` and tabs with `<TAB>` in the ANSI colored diff output. This ensure that they're visible, and they are properly colored as expected too.
2023-04-05 11:51:38 +00:00
printf "\e[1;32m*** Files in this commit comply with the clang-format style rules.\e[0m\n"
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
exit 0
fi
improve OS.get_name classref, misc/scripts fixes, remove trailing quote
2022-04-22 22:13:08 +00:00
# A diff has been created, notify the user, clean up, and exit.
CI: Visibly print trailing whitespace when static checks fail GitHub Actions seems to be hiding colored whitespace, and after lots of attempts I couldn't find a way to work it around. So instead I'm using a perl expression to replace trailing spaces with `·` and tabs with `<TAB>` in the ANSI colored diff output. This ensure that they're visible, and they are properly colored as expected too.
2023-04-05 11:51:38 +00: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>`.
Fix `printf` for format checks Prevents errors with input being invalid format strings
2024-02-02 11:10:02 +00: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'
CI: Visibly print trailing whitespace when static checks fail GitHub Actions seems to be hiding colored whitespace, and after lots of attempts I couldn't find a way to work it around. So instead I'm using a perl expression to replace trailing spaces with `·` and tabs with `<TAB>` in the ANSI colored diff output. This ensure that they're visible, and they are properly colored as expected too.
2023-04-05 11:51:38 +00:00
printf "\n\e[1;91m*** Please fix your commit(s) with 'git commit --amend' or 'git rebase -i <hash>'\e[0m\n"
Add static formatting checks for GitHub Actions
2020-07-13 07:34:34 +00:00
exit 1