CI: Visibly print trailing whitespace when static checks fail #75700
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
akien-mga
commented
Apr 5, 2023
| # A diff has been created, notify the user, clean up, and exit. | ||
| 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>`. | ||
| printf "$diff\n" | 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' |
There was a problem hiding this comment.
This was fun (not). If someone has a deep love for regex and sed/perl/awk/bash, feel free to try to optimize this so it's faster, simpler, more reliable, and more readable.
The gist of it is that it finds trailing whitespace (spaces and tabs) or colored lines (from git diff --color, i.e. lines removed or added), we replace them with · and <TAB> respectively. Had to use perl to be able to do "·" x length($2) for that, as I didn't want to replace spaces and tabs on the whole line if there's valid code before the trailing whitespace.
YuriSizov
approved these changes
Apr 5, 2023
|
Cherry-picked for 4.0.3. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.Test run: https://github.com/akien-mga/godot/actions/runs/4620688099/jobs/8171140859
All these shell scripts could use some refactoring to de-duplicate stuff, if anything by moving a few common patterns to functions in a separate script that would be sourced in each. But for now I'm keeping it simple, already spent more time on this than I was expecting, and I don't plan to work further on this right now.