From 3cf75729d009ca16bbefb909f66e0807c4d8d19a Mon Sep 17 00:00:00 2001 From: Radek Simko Date: Fri, 16 Feb 2024 14:13:46 +0000 Subject: [PATCH] Add make targets for common checks + fixes This is to make it easier for existing and new maintainers and contributors to run checks on the codebase. --- Makefile | 18 ++++++++++++++++++ scripts/gofmtcheck.sh | 5 +++++ 2 files changed, 23 insertions(+) create mode 100644 Makefile create mode 100755 scripts/gofmtcheck.sh diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..675178e7 --- /dev/null +++ b/Makefile @@ -0,0 +1,18 @@ +fmtcheck: + "$(CURDIR)/scripts/gofmtcheck.sh" + +fmtfix: + gofmt -w ./ + +vetcheck: + go vet ./... + +copyrightcheck: + go run github.com/hashicorp/copywrite@latest headers --plan + +copyrightfix: + go run github.com/hashicorp/copywrite@latest headers + +check: copyrightcheck vetcheck fmtcheck + +fix: copyrightfix fmtfix diff --git a/scripts/gofmtcheck.sh b/scripts/gofmtcheck.sh new file mode 100755 index 00000000..c09fa208 --- /dev/null +++ b/scripts/gofmtcheck.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env bash +# Copyright (c) HashiCorp, Inc. +# SPDX-License-Identifier: MPL-2.0 + +if [[ -n $(gofmt -l ./) ]]; then echo "Please run gofmt -w ./ to format code"; exit 1; fi;