add staticcheck

Author: ethanmdavidson

GNUmakefile

@@ -5,37 +5,50 @@ HASHICORP_PACKER_PLUGIN_SDK_VERSION?=$(shell go list -m github.com/hashicorp/pac
 COUNT?=1
 TEST?=$(shell go list ./...)
 
-.PHONY: dev
+prep: phony
+	go install honnef.co/go/tools/cmd/staticcheck@latest
 
-build:
+build: phony
 	@go build -o ${BINARY}
 
-dev: build
+dev: phony build
 	@mkdir -p ~/.packer.d/plugins/
 	@mv ${BINARY} ~/.packer.d/plugins/${BINARY}
 
-run-example: dev
+run-example: phony dev
 	@packer build ./example
 
-test:
-	@go test -race -count $(COUNT) $(TEST) -timeout=3m
+test: phony
+	go mod tidy
+	go fmt ./...
+	go vet ./...
+	staticcheck -checks="all" -tests ./...
+	go test -race -count $(COUNT) $(TEST) -timeout=3m
 
 # the acceptance tests have a weird habit of messing up the tty (e.g. turning off echo mode, so
 # terminal stops showing what you type). If this happens to you, run `reset` or `stty sane` to fix.
-testacc: dev
+testacc: phony dev
 	@PACKER_ACC=1 go test -count $(COUNT) -v $(TEST) -timeout=120m
 
-install-packer-sdc: ## Install packer software development command
+install-packer-sdc: phony ## Install packer software development command
 	@go install github.com/hashicorp/packer-plugin-sdk/cmd/packer-sdc@${HASHICORP_PACKER_PLUGIN_SDK_VERSION}
 
-ci-release-docs: install-packer-sdc
+ci-release-docs: phony install-packer-sdc
 	@packer-sdc renderdocs -src docs -partials docs-partials/ -dst docs/
 	@/bin/sh -c "[ -d docs ] && zip -r docs.zip docs/"
 
-plugin-check: install-packer-sdc build
+plugin-check: phony install-packer-sdc build
 	@packer-sdc plugin-check ${BINARY}
 
-generate: install-packer-sdc
+generate: phony install-packer-sdc
 	@go generate -v ./...
 	packer-sdc renderdocs -src ./docs -dst ./.docs -partials ./docs-partials
 	# see the .docs folder for a preview of the docs
+
+# instead of listing every target in .PHONY, we create one
+# 'phony' target which all the other targets depend on.
+# This saves me from having to remember to add each new target
+# to the .PHONY list, and is a little cleaner than putting
+# `.PHONY: target` before each target
+.PHONY: phony
+phony:

common/common.go

@@ -1,3 +1,4 @@
+// Package common contains some logic that is shared by all datasources
 package common
 
 import (

datasource/commit/data.go

@@ -1,3 +1,5 @@
+// Package commit contains logic for providing commit data to Packer
+//
 //go:generate packer-sdc mapstructure-to-hcl2 -type Config,DatasourceOutput
 package commit
 

datasource/repository/data.go

@@ -1,3 +1,5 @@
+// Package repository contains logic for providing repo data to Packer
+//
 //go:generate packer-sdc mapstructure-to-hcl2 -type Config,DatasourceOutput
 package repository
 
@@ -93,7 +95,7 @@ func (d *Datasource) Execute() (cty.Value, error) {
 	log.Printf("output.Head: '%s'\n", output.Head)
 
 	output.IsClean = status.IsClean()
-	log.Printf("output.IsClean: '%s'\n", output.IsClean)
+	log.Printf("output.IsClean: '%t'\n", output.IsClean)
 
 	output.Branches = make([]string, 0)
 	_ = branchIter.ForEach(func(reference *plumbing.Reference) error {

datasource/tree/data.go

@@ -1,3 +1,5 @@
+// Package tree contains logic for providing working tree data to Packer
+//
 //go:generate packer-sdc mapstructure-to-hcl2 -type Config,DatasourceOutput
 package tree