Go：git gofmt pre-commit hook

yexiaobai發表於2019-02-16
GoGitMITHook

我們使用 git 做 Go 原始碼的版本控制，在提交前，我們需要對程式碼自動格式，並且當未格式的時候，輸出一些資訊，下面是一個這樣的指令碼：

注：該指令碼來源於：http://golang.org/misc/git/pre-commit
關於介紹清理 Go 程式碼的小文章：An Introduction to Go Tools and Clean Code

    #!/bin/sh
        # Copyright 2012 The Go Authors. All rights reserved.
        # Use of this source code is governed by a BSD-style
        # license that can be found in the LICENSE file.

        # git gofmt pre-commit hook
        #
        # To use, store as .git/hooks/pre-commit inside your repository and make sure
        # it has execute permissions.
        #
        # This script does not handle file names that contain spaces.

        gofiles=$(git diff --cached --name-only --diff-filter=ACM | grep `.go$`)
        [ -z "$gofiles" ] && exit 0

        unformatted=$(gofmt -l $gofiles)
        [ -z "$unformatted" ] && exit 0

        # Some files are not gofmt`d. Print message and fail.

        echo >&2 "Go files must be formatted with gofmt. Please run:"
        for fn in $unformatted; do
            echo >&2 "  gofmt -w $PWD/$fn"
        done

        exit 1

相關文章