Refactor docs and cmd.version variable

.gitignore

@@ -32,4 +32,4 @@ dist/
 internal/utils/markdown_render/docs/
 
 # OSX
-.DS_Store
+.DS_Store

.goreleaser.yaml

@@ -9,7 +9,7 @@ builds:
     flags:
       - -trimpath
     ldflags:
-      - -s -w -X cmd.version={{ .Tag }}
+      - -s -w -X github.com/containerscrew/tftools/cmd.version={{ .Tag }}
     goos:
       - linux
       - darwin

cmd/tftools/root.go

@@ -24,7 +24,6 @@ var (
 // printBanner will print an ascii banner with colors
 func printBanner() {
 	templ := `{{ .AnsiColor.BrightMagenta  }} {{ .Title "tftools" "" 2 }}{{ .AnsiColor.Default }}
-   GoVersion: {{ .GoVersion }}
    Author: github.com/containerscrew
    Now: {{ .Now "Monday, 2 Jan 2006" }}`
 	banner.InitString(colorable.NewColorableStdout(), true, true, templ)
@@ -58,6 +57,6 @@ var versionCmd = &cobra.Command{
 	Short: "tftools current version",
 	Long:  "Get the cli tftools version installed",
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Printf("tftools: %v with go version %s %s/%s", version, goversion, goos, goarch)
+		fmt.Printf("tftools: %s with go version %s %s/%s", version, goversion, goos, goarch)
 	},
 }

docs/install.md

@@ -17,10 +17,21 @@
 
 ## Using go
 
+Go install is not a good solution because in order to compile the binary you must first run go generate ./....
+
 ```bash
 go install github.com/containerscrew/tftools
 ```
-> **NOTE:** this installation mode is broken by using go:embed files. To be fixed 🛠️
+
+> **NOTE:** this will fail as I mentioned 🛠️
+
+You can do the following:
+
+```bash
+git clone https://github.com/containerscrew/tftools.git && cd tftools
+go generate ./...
+go install .
+```
 
 ## Using brew
 

internal/utils/markdown_render/pretty_markdown.go

@@ -9,8 +9,8 @@ import (
 )
 
 // Embed usage documentation.
-//go:generate cp -r ../../../docs ./docs
-//go:embed docs
+//go:generate cp -r ../../../docs/usage.md ./usage.md
+//go:embed usage.md
 
 var usage embed.FS
 

internal/utils/markdown_render/usage.md

@@ -0,0 +1,53 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Usage](#usage)
+  - [Summarize](#summarize)
+  - [Function for ~/.zshrc](#function-for-zshrc)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Usage
+
+## Summarize
+
+```bash
+terraform plan -out plan.tfplan
+terraform show -json plan.tfplan | tftools summarize
+```
+
+Or if you have the file in json
+
+```bash
+terraform plan -out plan.tfplan
+terraform show -json plan.tfplan > plan.json
+cat plan.json | tftools summarize
+```
+
+## Function for ~/.zshrc
+
+Copy [this function](../scripts/tfsum.sh) in your `~/.zshrc` or `~/.bashrc` file.
+
+```bash
+function tfsum() {
+  if [ -z "$1" ];
+  then
+    echo "You should type 'tfsum terraform|terragrunt'"
+  else
+    echo -e "Starting tf summary..."
+    # Don't print output of terraform plan
+    # If you don't want full plan output: $1 plan -out plan.tfplan 1> /dev/null
+    $1 plan -out plan.tfplan
+    echo -e "\n\n"
+    $1 show -json plan.tfplan | tftools summarize
+    # Delete plan out file to avoid git tracking (although is included in .gitignore)
+    if [ -f "plan.tfplan" ]; then rm plan.tfplan; fi
+  fi
+}
+```
+
+```bash
+source ~/.zshrc
+tfsum terragrunt or tfsum terraform
+```