d8d9162f5b
0fbed98e42 [script] lint-whitespace: improve print linenumber (Akio Nakamura)
Pull request description:
Before this PR, the linenumber infomaition is output if trailing-space or tab code was found, but the output occurence is only per a file.
This PR separates the output timing of file name and line number.
As a result, users will find where they need to fix more easily.
example:
0) git diff
```
diff --git a/dummy.txt b/dummy.txt
index c0ce4d776..aebbdb88d 100644
--- a/dummy.txt
+++ b/dummy.txt
@@ -1,2 +1,2 @@
-1
-2
+1
+ 2
@@ -8,2 +8,2 @@
-8
-9
+ 8
+9
```
1) before this PR - Is there "9 " in second line? It may lead to be misunderstood.
```
This diff appears to have added new lines with trailing whitespace.
The following changes were suspected:
diff --git a/dummy.txt b/dummy.txt
@@ -1,2 +1,2 @@
+1
+9
```
2) after this PR
```
This diff appears to have added new lines with trailing whitespace.
The following changes were suspected:
diff --git a/dummy.txt b/dummy.txt
@@ -1,2 +1,2 @@
+1
@@ -8,2 +8,2 @@
+9
```
Tree-SHA512: 2fd52e3c982786f86cfe10aa2578589bc9c502bcad9b85111467840d726143330c23968cde5483ee0f563893c8381044b80e8c22a7c8eca56fc73c548b9a9496
113 lines
3.1 KiB
Bash
Executable file
113 lines
3.1 KiB
Bash
Executable file
#!/bin/bash
|
|
#
|
|
# Copyright (c) 2017 The Bitcoin Core developers
|
|
# Distributed under the MIT software license, see the accompanying
|
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
#
|
|
# Check for new lines in diff that introduce trailing whitespace.
|
|
|
|
# We can't run this check unless we know the commit range for the PR.
|
|
|
|
while getopts "?" opt; do
|
|
case $opt in
|
|
?)
|
|
echo "Usage: .lint-whitespace.sh [N]"
|
|
echo " TRAVIS_COMMIT_RANGE='<commit range>' .lint-whitespace.sh"
|
|
echo " .lint-whitespace.sh -?"
|
|
echo "Checks unstaged changes, the previous N commits, or a commit range."
|
|
echo "TRAVIS_COMMIT_RANGE='47ba2c3...ee50c9e' .lint-whitespace.sh"
|
|
exit 0
|
|
;;
|
|
esac
|
|
done
|
|
|
|
if [ -z "${TRAVIS_COMMIT_RANGE}" ]; then
|
|
if [ "$1" ]; then
|
|
TRAVIS_COMMIT_RANGE="HEAD~$1...HEAD"
|
|
else
|
|
TRAVIS_COMMIT_RANGE="HEAD"
|
|
fi
|
|
fi
|
|
|
|
showdiff() {
|
|
if ! git diff -U0 "${TRAVIS_COMMIT_RANGE}" -- "." ":(exclude)depends/patches/" ":(exclude)src/leveldb/" ":(exclude)src/secp256k1/" ":(exclude)src/univalue/" ":(exclude)doc/release-notes/"; then
|
|
echo "Failed to get a diff"
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
showcodediff() {
|
|
if ! git diff -U0 "${TRAVIS_COMMIT_RANGE}" -- *.cpp *.h *.md *.py *.sh ":(exclude)src/leveldb/" ":(exclude)src/secp256k1/" ":(exclude)src/univalue/" ":(exclude)doc/release-notes/"; then
|
|
echo "Failed to get a diff"
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
RET=0
|
|
|
|
# Check if trailing whitespace was found in the diff.
|
|
if showdiff | grep -E -q '^\+.*\s+$'; then
|
|
echo "This diff appears to have added new lines with trailing whitespace."
|
|
echo "The following changes were suspected:"
|
|
FILENAME=""
|
|
SEEN=0
|
|
SEENLN=0
|
|
while read -r line; do
|
|
if [[ "$line" =~ ^diff ]]; then
|
|
FILENAME="$line"
|
|
SEEN=0
|
|
elif [[ "$line" =~ ^@@ ]]; then
|
|
LINENUMBER="$line"
|
|
SEENLN=0
|
|
else
|
|
if [ "$SEEN" -eq 0 ]; then
|
|
# The first time a file is seen with trailing whitespace, we print the
|
|
# filename (preceded by a newline).
|
|
echo
|
|
echo "$FILENAME"
|
|
SEEN=1
|
|
fi
|
|
if [ "$SEENLN" -eq 0 ]; then
|
|
echo "$LINENUMBER"
|
|
SEENLN=1
|
|
fi
|
|
echo "$line"
|
|
fi
|
|
done < <(showdiff | grep -E '^(diff --git |@@|\+.*\s+$)')
|
|
RET=1
|
|
fi
|
|
|
|
# Check if tab characters were found in the diff.
|
|
if showcodediff | perl -nle '$MATCH++ if m{^\+.*\t}; END{exit 1 unless $MATCH>0}' > /dev/null; then
|
|
echo "This diff appears to have added new lines with tab characters instead of spaces."
|
|
echo "The following changes were suspected:"
|
|
FILENAME=""
|
|
SEEN=0
|
|
SEENLN=0
|
|
while read -r line; do
|
|
if [[ "$line" =~ ^diff ]]; then
|
|
FILENAME="$line"
|
|
SEEN=0
|
|
elif [[ "$line" =~ ^@@ ]]; then
|
|
LINENUMBER="$line"
|
|
SEENLN=0
|
|
else
|
|
if [ "$SEEN" -eq 0 ]; then
|
|
# The first time a file is seen with a tab character, we print the
|
|
# filename (preceded by a newline).
|
|
echo
|
|
echo "$FILENAME"
|
|
SEEN=1
|
|
fi
|
|
if [ "$SEENLN" -eq 0 ]; then
|
|
echo "$LINENUMBER"
|
|
SEENLN=1
|
|
fi
|
|
echo "$line"
|
|
fi
|
|
done < <(showcodediff | perl -nle 'print if m{^(diff --git |@@|\+.*\t)}')
|
|
RET=1
|
|
fi
|
|
|
|
exit $RET
|