A git pre-commit hook script for checking gofmt and unit tests
Risto Saarelma
pass and none of the .go files in the repository need a pass through
gofmt before allowing a commit to proceed. The script is in Python
since I don't know bash scripting well enough to do even this level of
complexity.
Use for whatever you like: http://gist.github.com/260411
befelemepeseveze
> I wrote a pre-commit script for git that checks that all unit tests
> pass and none of the .go files in the repository need a pass through
> gofmt before allowing a commit to proceed.
AFAIK, the codereview extension in the Go tree already has the
functionality of guaranteeing all CL sources to be gofmt'ed prior to
upload.
Risto Saarelma
wrote:
> AFAIK, the codereview extension in the Go tree already has the
> functionality of guaranteeing all CL sources to be gofmt'ed prior to
> upload.
Looks like it does. Hadn't noticed that before. And now I know that
the idiomatic way of checking if a file needs gofmt is running "gofmt -
l" instead of diffing the gofmt output with the original file like my
script does. Still, the codereview extension seems pretty Mercurial-
centric, while my script has some Git-specific logic, so mine may
still be useful for people who have Go stuff in Git.
Pat Notz
formatting. This doesn't run tests like your python script because
some of my git repositories are laid out differently. Still, this is
pretty short and simple so I thought others might find it useful.
To use this, put this in the file .git/hooks/pre-commit and make it executable.
#!/bin/sh
status=0
for file in $(git diff --cached --name-only | grep -e '\.go$'); do
badfile=$(gofmt -l $file)
if test -n "$badfile" ; then
echo "git pre-commit check failed: file needs gofmt: $badfile"
status=1
fi
done
exit $status
Kevin Ballard
Pat Notz
> I suspect this script will fail on files with spaces in the name. The
> simplest solution is probably to do something like
> IFS=$'\n'
> before the for loop.
Excellent tip (your suspicion was correct). For the sake of internet
posterity, here's the corrected script. To use this, put this in the
file .git/hooks/pre-commit and make it executable.
#!/bin/sh
status=0
IFS=$'\n'
Risto Saarelma
> Here's a pretty simple shell script pre-commit hook for checking the
> formatting. This doesn't run tests like your python script because
> some of my git repositories are laid out differently. Still, this is
> pretty short and simple so I thought others might find it useful.
Doesn't this check the working directory instead of the staging area?
Meaning that if you gofmt a file going in the commit in the working
dir but don't "git add" it after the formatting, the check will pass,
but an un-goformatted file from the staging area will be committed?
Kevin Ballard
Julian Phillips
> > On Dec 22, 10:56 pm, Pat Notz <patn...@gmail.com> wrote:
> > > Here's a pretty simple shell script pre-commit hook for checking the
> > > formatting. This doesn't run tests like your python script because
> > > some of my git repositories are laid out differently. Still, this is
> > > pretty short and simple so I thought others might find it useful.
>
> > Doesn't this check the working directory instead of the staging area?
> > Meaning that if you gofmt a file going in the commit in the working
> > dir but don't "git add" it after the formatting, the check will pass,
> > but an un-goformatted file from the staging area will be committed?
>
> Indeed you are correct. Here is a revised script that fixes this issue. I
> also added some extra quoting in places where, while I'm not certain its
> required, I believe it may be in the case of files with spaces and certainly
> won't hurt:
Having found this useful little script, I thought I would just post
back the slightly tweaked version that I am actually using which also
checks the initial commit:
#!/bin/sh
status=0
IFS=$'\n'
if git rev-parse HEAD >/dev/null 2>&1; then
FILES=$(git diff --cached --name-only | grep -e '\.go$');
else
FILES=$(git ls-files -c | grep -e '\.go$');
fi
for file in $FILES; do