feat: Add goreleaser

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: release
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version-file: 'go.mod'
+
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v4
+        with:
+          distribution: goreleaser
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,5 +1,4 @@
 # Binaries for programs and plugins
-bin
 *.exe
 *.exe~
 *.dll
@@ -14,3 +13,5 @@ bin
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+dist/

.goreleaser.yaml

@@ -0,0 +1,21 @@
+builds:
+  - env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ incpatch .Version }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-yaml
+        args: [ --allow-multiple-documents ]
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/gruntwork-io/pre-commit
+    rev: v0.1.18
+    hooks:
+      - id: terraform-fmt
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v2.1.1
+    hooks:
+      - id: conventional-pre-commit
+        stages: [ commit-msg ]
+        args: [ ] # optional: list of Conventional Commits types to allow

Makefile

@@ -1,7 +1,7 @@
 XC_OS="linux darwin"
 XC_ARCH="amd64 arm64"
 XC_PARALLEL="2"
-BIN="bin"
+BIN="dist"
 SRC=$(shell find . -name "*.go")
 
 ifeq (, $(shell which gox))
@@ -25,6 +25,8 @@ build: install_deps
 fmt:
 	$(info ******************** checking formatting ********************)
 	@test -z $(shell gofmt -l $(SRC)) || (gofmt -d $(SRC); exit 1)
+	terraform fmt -recursive
+
 
 test: install_deps
 	$(info ******************** running tests ********************)
@@ -35,4 +37,4 @@ install_deps:
 	go get -v ./...
 
 clean:
-	rm -rf $(BIN)
+	rm -rf $(BIN)

README.md

@@ -1,3 +1,11 @@
 # terraform-cleaner
 
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+
 Tiny utility which detects unused variables in your terraform modules
+
+# Pre-commit
+
+```shell
+pre-commit install --hook-type pre-commit --hook-type commit-msg
+```

cmd/root.go

@@ -12,7 +12,7 @@ import (
 )
 
 var rootCmd = &cobra.Command{
-	Use:   "terraform-cleaner",
+	Use:   "terraform-cleaner <path>",
 	Short: "Remove unused variables",
 	RunE:  rootCmdExec,
 }

cmd/testdata/tf/main.tf

@@ -1,14 +1,14 @@
 terraform {
   required_providers {
     null = {
-      source = "hashicorp/null"
+      source  = "hashicorp/null"
       version = "3.2.1"
     }
   }
 }
 
 provider "null" {
-  region     = var.region
+  region = var.region
 }
 
 data "null_data_source" "values" {
@@ -20,4 +20,4 @@ resource "null_resource" "cluster" {
   triggers = {
     instance_ids = var.instance_ids
   }
-}
+}

cmd/testdata/tf/outputs.tf

@@ -1,3 +1,3 @@
 output "out" {
   value = data.null_data_source.values.inputs
-}
+}

cmd/testdata/tf/variables.tf

@@ -1,16 +1,16 @@
 variable "name" {
-  type = string
+  type    = string
   default = "terraform-cleaner"
 }
 
 variable "region" {
-  type = string
+  type    = string
   default = "ca-central-1"
 }
 
 variable "instance_ids" {
-  type = list(string)
+  type    = list(string)
   default = ["i-123", "i-456"]
 }
 
-variable "legacy" {}
+variable "legacy" {}

go.mod

@@ -17,9 +17,9 @@ require (
 	github.com/hashicorp/hcl/v2 v2.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.0 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect˚
+	github.com/pmezard/go-difflib v1.0.0 // indirect; indirect˚
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/stretchr/testify v1.8.2 // indirect
+	github.com/stretchr/testify v1.8.2
 	github.com/zclconf/go-cty v1.1.0 // indirect
 	golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
 	golang.org/x/text v0.3.8 // indirect