.pre-commit-hooks.yaml

# ==============================================================================
# go-build-mod
#   * Folder-Based
#   * Recursive
#   * Targets first parent folder with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: go-build-mod
    name: 'go-build-mod'
    entry: go-build-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root $FILE); go build -o /dev/null [$ARGS] ./...' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# go-build-pkg
#   * Folder-Based
#   * Targets folder containing staged file
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-build-pkg
    name: 'go-build-pkg'
    entry: go-build-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'go build -o /dev/null [$ARGS] ./$(dirname $FILE)' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# go-build-repo-mod
#   * Repo-Based
#   * Recursive
#   * Targets ALL folders with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: go-build-repo-mod
    name: 'go-build-repo-mod'
    entry: go-build-repo-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root); go build -o /dev/null [$ARGS] ./...' for each module in the repo"
    pass_filenames: false

# ==============================================================================
# go-build-repo-pkg
#   * Repo-Based
#   * Recursive
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-build-repo-pkg
    name: 'go-build-repo-pkg'
    entry: go-build-repo-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'go build -o /dev/null [$ARGS] ./...' in repo root folder"
    pass_filenames: false

# ==============================================================================
# go-critic
#   * File-based
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-critic
    name: 'go-critic'
    entry: go-critic.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'gocritic check [$ARGS] $FILE' for each staged .go file"
    pass_filenames: true

# ==============================================================================
# go-fmt
#   * File-based
#   * Executes if any .go files modified
# NOTES:
#   `go fmt` delegates to `gofmt`, so we'll invote `gofmt` directly.
# ==============================================================================
-   id: go-fmt
    name: 'go-fmt'
    entry: go-fmt.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'gofmt -l -d [$ARGS] $FILE' for each staged .go file"
    pass_filenames: true

# ==============================================================================
# go-imports
#   * File-based
#   * Executes if any .go files modified
# NOTES:
#   Replaces go-fmt-fix
# ==============================================================================
-   id: go-imports
    name: 'go-imports'
    entry: go-imports.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'goimports -l -d [$ARGS] $FILE' for each staged .go file"
    pass_filenames: true

# ==============================================================================
# go-lint
#   * File-based
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-lint
    name: 'go-lint'
    entry: go-lint.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'golint -set_exit_status [$ARGS] $FILE' for each staged .go file"
    pass_filenames: true

# ==============================================================================
# go-returns
#   * File-based
#   * Executes if any .go files modified
# NOTES:
#   Replaces go-imports-fix & go-fmt-fix
# ==============================================================================
-   id: go-returns
    name: 'go-returns'
    entry: go-returns.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'goreturns -l -d [$ARGS] $FILE' for each staged .go file"
    pass_filenames: true

# ==============================================================================
# go-test-mod
#   * Folder-Based
#   * Recursive
#   * Targets first parent folder with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: go-test-mod
    name: 'go-test-mod'
    entry: go-test-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root $FILE); go test [$ARGS] ./...' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# go-test-pkg
#   * Folder-Based
#   * Targets folder containing staged file
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-test-pkg
    name: 'go-test-pkg'
    entry: go-test-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'go test [$ARGS] ./$(dirname $FILE)' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# go-test-repo-mod
#   * Repo-Based
#   * Recursive
#   * Targets ALL folders with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: go-test-repo-mod
    name: 'go-test-repo-mod'
    entry: go-test-repo-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root); go test [$ARGS] ./...' for each module in the repo"
    pass_filenames: false

# ==============================================================================
# go-test-repo-pkg
#   * Repo-Based
#   * Recursive
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-test-repo-pkg
    name: 'go-test-repo-pkg'
    entry: go-test-repo-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'go test [$ARGS] ./...' in repo root folder"
    pass_filenames: false

# ==============================================================================
# go-vet-mod
#   * Folder-Based
#   * Recursive
#   * Targets first parent folder with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: go-vet-mod
    name: 'go-vet-mod'
    entry: go-vet-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root $FILE); go vet [$ARGS] ./...' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# go-vet-pkg
#   * Folder-Based
#   * Targets folder containing staged file
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-vet-pkg
    name: 'go-vet-pkg'
    entry: go-vet-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'go vet [$ARGS] ./$(dirname $FILE)' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# go-vet-repo-mod
#   * Repo-Based
#   * Recursive
#   * Targets ALL folders with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: go-vet-repo-mod
    name: 'go-vet-repo-mod'
    entry: go-vet-repo-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root); go vet [$ARGS] ./...' for each module in the repo"
    pass_filenames: false

# ==============================================================================
# go-vet-repo-pkg
#   * Repo-Based
#   * Recursive
#   * Executes if any .go files modified
# ==============================================================================
-   id: go-vet-repo-pkg
    name: 'go-vet-repo-pkg'
    entry: go-vet-repo-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'go vet [$ARGS] ./...' in repo root folder"
    pass_filenames: false

# ==============================================================================
# go-vet
#   * File-based
#   * Executes if any .go files modified
# NOTES:
#   `go vet` appears to work on single files when given them as args.
# ==============================================================================
-   id: go-vet
    name: 'go-vet'
    entry: go-vet.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'go vet [$ARGS] $FILE' for each staged .go file"
    pass_filenames: true

# ==============================================================================
# golangci-lint-mod
#   * Folder-Based
#   * Recursive
#   * Targets first parent folder with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: golangci-lint-mod
    name: 'golangci-lint-mod'
    entry: golangci-lint-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root $FILE); golangci-lint run [$ARGS] ./...' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# golangci-lint-pkg
#   * Folder-Based
#   * Targets folder containing staged file
#   * Executes if any .go files modified
# ==============================================================================
-   id: golangci-lint-pkg
    name: 'golangci-lint-pkg'
    entry: golangci-lint-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'golangci-lint run [$ARGS] ./$(dirname $FILE)' for each staged .go file"
    pass_filenames: true
    require_serial: true

# ==============================================================================
# golangci-lint-repo-mod
#   * Repo-Based
#   * Recursive
#   * Targets ALL folders with a go.mod file
#   * Executes if any .go files modified
#   * Executes if go.mod modified
# ==============================================================================
-   id: golangci-lint-repo-mod
    name: 'golangci-lint-repo-mod'
    entry: golangci-lint-repo-mod.sh
    files: '(\.go$)|(\bgo\.mod$)'
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'cd $(mod_root); golangci-lint run [$ARGS] ./...' for each module in the repo"
    pass_filenames: false

# ==============================================================================
# golangci-lint-repo-pkg
#   * Repo-Based
#   * Recursive
#   * Executes if any .go files modified
# ==============================================================================
-   id: golangci-lint-repo-pkg
    name: 'golangci-lint-repo-pkg'
    entry: golangci-lint-repo-pkg.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'golangci-lint run [$ARGS] ./...' in repo root folder"
    pass_filenames: false

# ==============================================================================
# golangci-lint
#   * File-based
#   * Executes if any .go files modified
# NOTES:
#   `golangci-lint` appears to work on single files when given them as args.
# ==============================================================================
-   id: golangci-lint
    name: 'golangci-lint'
    entry: golangci-lint.sh
    types: [go]
    exclude: '(^|/)vendor/'
    language: 'script'
    description: "Run 'golangci-lint run [$ARGS] $FILE' for each staged .go file"
    pass_filenames: true