zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: generalize functions in pre-commit-hook

Browse Source 
- improves code re-usage for pre-receive hook
This commit is contained in:
Mark Olesen
2010-11-10 11:50:00 +01:00
parent 1a0da12db3
commit ba19b63907
1 changed files with 40 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
bin/tools/pre-commit-hook
View File

@ -49,9 +49,10 @@
# test the specified files/directories for standards conformance. # test the specified files/directories for standards conformance.
# #
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
hookName="pre-commit"
die() die()
{ {
echo 'pre-commit hook failure' 1>&2 echo '$hookName hook failure' 1>&2
echo '-----------------------' 1>&2 echo '-----------------------' 1>&2
echo '' 1>&2 echo '' 1>&2
echo "$@" 1>&2 echo "$@" 1>&2
@ -104,7 +105,7 @@ dieOnBadFiles()
{ {
if [ -n "$badFiles" ] if [ -n "$badFiles" ]
then then
echo 'pre-commit hook failure' 1>&2 echo '$hookName hook failure' 1>&2
echo '-----------------------' 1>&2 echo '-----------------------' 1>&2
echo "$@" 1>&2 echo "$@" 1>&2
echo '' 1>&2 echo '' 1>&2
@ -116,22 +117,37 @@ dieOnBadFiles()
} }
#
# qualify 'git grep' to check cached value or from a specific commit
#
gitScope()
{
if [ "$#" -gt 0 ]
then
echo "$1:"
else
echo "--cached -- "
fi
}
# #
# check for bad strings, characters, etc # check for bad strings, characters, etc
# #
checkIllegalCode() checkIllegalCode()
{ {
echo "pre-commit: check bad strings/characters etc ..." 1>&2 echo "$hookName: check bad strings/characters etc ..." 1>&2
reBad="(N""abla|"$'\t'")" reBad="(N""abla|"$'\t'")"
msgBad="N""abla or <TAB>" msgBad="N""abla or <TAB>"
scope=$(gitScope $@)
badFiles=$( badFiles=$(
for f in $fileList for f in $fileList
do do
# parse line numbers from grep output: # parse line numbers from grep output:
# <lineNr>: contents # <lineNr>: contents
lines=$(git grep --cached -E -hn -e "$reBad" -- "$f" | lines=$(git grep -E -hn -e "$reBad" $scope"$f" |
sed -e 's@:.*@@' | sed -e 's@:.*@@' |
tr '\n' ' ' tr '\n' ' '
) )
@ -149,7 +165,9 @@ checkIllegalCode()
checkCopyright() checkCopyright()
{ {
year=$(date +%Y) year=$(date +%Y)
echo "pre-commit: check copyright ..." 1>&2 echo "$hookName: check copyright ..." 1>&2
scope=$(gitScope $@)
badFiles=$( badFiles=$(
for f in $fileList for f in $fileList
@ -160,10 +178,10 @@ checkCopyright()
# parse line numbers from grep output: # parse line numbers from grep output:
# <lineNr>: contents # <lineNr>: contents
# #
lines=$(git grep --cached -F -hn -e Copyright \ lines=$(git grep -F -hn -e Copyright \
--and -e OpenCFD \ --and -e OpenCFD \
--and --not -e "$year" \ --and --not -e "$year" \
-- "$f" | $scope"$f" |
sed -e 's@:.*@@' | sed -e 's@:.*@@' |
tr '\n' ' ' tr '\n' ' '
) )
@ -180,7 +198,9 @@ checkCopyright()
# #
checkLineLength() checkLineLength()
{ {
echo "pre-commit: check line lengths ..." 1>&2 echo "$hookName: check line lengths ..." 1>&2
scope=$(gitScope $@)
badFiles=$( badFiles=$(
for f in $fileList for f in $fileList
@ -190,7 +210,7 @@ checkLineLength()
(*.[CH]) (*.[CH])
# parse line numbers from grep output: # parse line numbers from grep output:
# <lineNr>: contents # <lineNr>: contents
lines=$(git grep --cached -hn -e '^.\{81,\}' -- "$f" | lines=$(git grep -hn -e '^.\{81,\}' $scope"$f" |
sed -e 's@:.*@@' | sed -e 's@:.*@@' |
tr '\n' ' ' tr '\n' ' '
) )
@ -209,7 +229,9 @@ checkLineLength()
# #
checkLineLengthNonComments() checkLineLengthNonComments()
{ {
echo "pre-commit: check line lengths ..." 1>&2 echo "$hookName: check line lengths ..." 1>&2
scope=$(gitScope $@)
badFiles=$( badFiles=$(
for f in $fileList for f in $fileList
@ -219,9 +241,9 @@ checkLineLengthNonComments()
(*.[CH]) (*.[CH])
# parse line numbers from grep output: # parse line numbers from grep output:
# <lineNr>: contents # <lineNr>: contents
lines=$(git grep --cached -hn -e '^.\{81,\}' \ lines=$(git grep -hn -e '^.\{81,\}' \
--and --not -e "^ *//" \ --and --not -e "^ *//" \
-- "$f" | $scope"$f" |
sed -e 's@:.*@@' | sed -e 's@:.*@@' |
tr '\n' ' ' tr '\n' ' '
) )
@ -234,12 +256,15 @@ checkLineLengthNonComments()
dieOnBadFiles "Limit code to 80 columns before pushing" dieOnBadFiles "Limit code to 80 columns before pushing"
} }
# #
# limit line length to 80-columns, except #directive lines # limit line length to 80-columns, except #directive lines
# #
checkLineLengthNonDirective() checkLineLengthNonDirective()
{ {
echo "pre-commit: check line lengths ..." 1>&2 echo "$hookName: check line lengths ..." 1>&2
scope=$(gitScope $@)
badFiles=$( badFiles=$(
for f in $fileList for f in $fileList
@ -249,9 +274,9 @@ checkLineLengthNonDirective()
(*.[CH]) (*.[CH])
# parse line numbers from grep output: # parse line numbers from grep output:
# <lineNr>: contents # <lineNr>: contents
lines=$(git grep --cached -hn -e '^.\{81,\}' \ lines=$(git grep -hn -e '^.\{81,\}' \
--and --not -e "^ *#" \ --and --not -e "^ *#" \
-- "$f" | $scope"$f" |
sed -e 's@:.*@@' | sed -e 's@:.*@@' |
tr '\n' ' ' tr '\n' ' '
) )