Working whitespace check #838
Closed
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
|
Seems good to me. |
|
@nishnik |
| exit -1; | ||
| fi | ||
| # TODO: Add similar grep checks for space after comma,, space after `if`, space between `)` and `{` also | ||
| git diff HEAD^1 --check #test for whitespaces |
There was a problem hiding this comment.
What is the idea here?
remove the top commit and take a diff as it looks to me.
There was a problem hiding this comment.
It doesn't remove the top commit. Just returns the diff at it, i.e. the changes introduced in previous commit.
And diff --check is to check for trailing whitespaces.
--check
Warn if changes introduce whitespace errors.
What are considered whitespace errors is controlled by core.whitespace configuration.
By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the initial indent of the line are considered whitespace errors.
Exits with non-zero status if problems are found.
|
@nishnik This misses out on some cases. Say you have a set of 10 commits, this checks only the top two. If the whitespace was introduced in the initial commits then they are missed out. |
|
Oh! My bad! |
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.
I googled a lot about this issue.
As a good practice it is advised to use Git hooks.
The default
pre-commithook is sufficient for whitespace check.We can write a bash or python script to activate
pre-commithook (It just needsmv .git/hooks/pre-commit.sample .git/hooks/pre-commit). Need suggestions on that!And adding this:
git diff HEAD^1 --checkin travis will serve our purpose. As it will exit the travis build if it finds trailing whitespace in recently modified code.Instance where travis build fails due to trailing whitespace.
Instance when it runs fine when there aren't any whitespace. One job fails because piranha has been updated. Unrelated to this PR.