https://github.com/edsrzf/gofmt-git-hook

A Git pre-commit hook that checks formatting of Go code
https://github.com/edsrzf/gofmt-git-hook

Last synced: 2 months ago
JSON representation

A Git pre-commit hook that checks formatting of Go code

• Host: GitHub
• URL: https://github.com/edsrzf/gofmt-git-hook
• Owner: edsrzf
• License: bsd-3-clause
• Created: 2010-09-21T00:45:06.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2018-04-09T05:02:10.000Z (about 6 years ago)
• Last Synced: 2024-01-24T12:16:18.655Z (5 months ago)
• Language: Shell
• Homepage:
• Size: 237 KB
• Stars: 128
• Watchers: 4
• Forks: 17
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome - gofmt-git-hook - A Git pre-commit hook that checks formatting of Go code (Shell)

README

        
This project contains two scripts intended to be used as git pre-commit hooks.

The first, fmt-check, prevents you from committing if you need to run gofmt on any

modified .go file.

The second, fmt-fix, runs all modified .go files through gofmt before committing.

NOTE: This script does not play well when adding partial changes, such as with

`git add -p` or `git commit -p`.

You should use either one or the other, not both.

Both scripts are originally based on a [golang-nuts discussion][1].

To install in a single repository, copy a script to .git/hooks/pre-commit and make

sure it's executable.

You might also find it useful to create a git alias for gofmt by running:

    git config --global alias.gofmt '!echo $(git diff --cached --name-only --diff-filter=ACM | grep '.go$') | xargs gofmt -w -l | xargs git add'

Then you can run git gofmt and format all modified .go files. Note that this alias

will not handle situations where partial file changes have been added to the index.

[1]: http://groups.google.com/group/golang-nuts/browse_thread/thread/bcd1b0e3c75c3884/5ce342b06ea29d03