Add tools.go

Author: erwinvaneyk

Makefile

@@ -27,19 +27,23 @@ generate: ## Run all code generators
 
 .PHONY: test
 test: ## Run all unit tests.
-	go test ./...
+	go test -v ./...
 
 .PHONY: verify
-verify: ## Run all code analysis tools and linters.
+verify: ## Run all static analysis checks.
 	# Check if codebase is formatted.
-	@echo "gofmt -l ."
-	@bash -c "[ -z $$(gofmt -l .) ] && echo 'OK' || (echo 'ERROR: files are not formatted:' && gofmt -l . && false)"
+	@which goimports > /dev/null || ! echo 'goimports not found'
+	@bash -c "[ -z \"$(goimports -l cmd pkg)\" ] && echo 'OK' || (echo 'ERROR: files are not formatted:' && goimports -l cmd pkg && echo -e \"\nRun 'make format' or manually fix the formatting issues.\n\" && false)"
 	# Run static checks on codebase.
-	go vet ./...
+	go vet ./cmd/... ./pkg/...
 
 .PHONY: format
 format: ## Run all formatters on the codebase.
-	go fmt ./...
+	# Format the Go codebase.
+	goimports -w cmd pkg
+
+	# Format the go.mod file.
+	go mod tidy
 
 .PHONY: release
 release: clean generate verify test ## Build and release goversion, publishing the artifacts on Github and Dockerhub.

README.md

@@ -23,7 +23,8 @@ TODO
 ### Using Go tools
 
 
-### Using Go install
+
+### Using Go install (deprecated)
 ```bash
 GO11MODULE=off go install github.com/erwinvaneyk/goversion/cmd/goversion 
 ```

go.mod

@@ -5,6 +5,7 @@ go 1.13
 require (
 	github.com/erwinvaneyk/cobras v0.0.0-20200610150702-9e7b3fed53bf
 	github.com/ghodss/yaml v1.0.0
+	github.com/goreleaser/goreleaser v0.143.0
 	github.com/spf13/cobra v1.0.0
-	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/tools v0.0.0-20200928112810-42b62fc93869 // indirect
 )

go.sum

@@ -1,4 +1,4 @@
-//go:generate goversion generate --goversion "" --pkg goversion -o version.gen.go
+//go:generate goversion generate --goversion "" --pkg goversion -o goversion.gen.go
 package goversion
 
 import (

version.gen.go renamed to goversion.gen.go

@@ -26,6 +26,7 @@ func NewCmdLDFlags() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use: "ldflags",
+		Short: "Collect version information from host and print as valid Go ldflags.",
 		Run: cobras.Run(opts),
 	}
 

version.go renamed to goversion.go

@@ -0,0 +1,21 @@
+// +build tools
+// The build tag above ensures that the imports in this file will not be
+// included in the binaries using this package.
+//
+// To add dependencies, add the tool to the go mod
+// `go get -u golang.org/x/lint/golint`
+// Then, add it as an import to this file.
+//
+// To install the tools specified in this file, run the following:
+// `go generate tools.go`
+// or directly from tools.go:
+// `cat tools.go | grep '^\s_ ' | sed 's/^.*_ "\(.*\)"/\1/g' | xargs -tI % go install %`
+
+//go:generate go install github.com/goreleaser/goreleaser
+//go:generate go install golang.org/x/tools/cmd/goimports
+package goversion
+
+import (
+	_ "github.com/goreleaser/goreleaser"
+	_ "golang.org/x/tools/cmd/goimports"
+)