Fix cmd version env && refactor some code

.github/workflows/build.yml

@@ -23,10 +23,6 @@ jobs:
           go-version: '1.20'
           cache: false
 
-      # Generate data for embed files
-      - name: go-generate
-        run: go generate ./...
-
       - name: security
         uses: securego/gosec@master
         with:

.pre-commit-config.yaml

@@ -9,8 +9,6 @@ repos:
   - repo: https://github.com/dnephin/pre-commit-golang
     rev: v0.5.1
     hooks:
-      - id: go-generate
-        args: [./...]
       - id: go-fmt
       - id: go-imports
       - id: golangci-lint

README.md

@@ -23,6 +23,7 @@
 - [Usage](#usage)
   - [Built-in subcommand](#built-in-subcommand)
 - [Credits](#credits)
+- [TO DO](#to-do)
 - [Contribution](#contribution)
 - [LICENSE](#license)
 
@@ -81,12 +82,22 @@ Take a look inside docs [usage](./docs/usage.md)
 tftools usage
 ```
 
+> Requires internet connectivity, as it fetches the [usage.md](https://raw.githubusercontent.com/containerscrew/tftools/main/docs/usage.md) file.
+
 # Credits
 - [Cobra to build beautiful CLI](https://cobra.dev/)
 - [Terraform json structs for data parsing](https://github.com/hashicorp/terraform-json)
 - [Distroless for container build](https://github.com/GoogleContainerTools/distroless)
 - [Glamour markdown render](https://github.com/charmbracelet/glamour)
 - [Official issue to solve this concern](https://github.com/hashicorp/terraform/issues/10507)
+- [Git leaks](https://github.com/gitleaks/gitleaks-action)
+
+# TO DO
+
+* Improve error handling
+* Create generic `install.sh`
+* Add tests, although I have no experience
+* Code refactor is certainly needed!
 
 # Contribution
 

cmd/tftools/commands.go → cmd/commands.go

@@ -1,7 +1,9 @@
 package cmd
 
 import (
+	"fmt"
 	"os"
+	"runtime"
 
 	markdownrender "github.com/containerscrew/tftools/internal/utils/markdown_render"
 
@@ -10,16 +12,12 @@ import (
 	"github.com/spf13/cobra"
 )
 
-//func Test() *cobra.Command {
-//	return &cobra.Command{
-//		Use:   "test",
-//		Short: "Test subcommand",
-//		Long:  "Testing subcommand",
-//		Run: func(cmd *cobra.Command, args []string) {
-//			fmt.Println("Testing subcommand...")
-//		},
-//	}
-//}
+var (
+	version   string
+	goversion = runtime.Version()
+	goos      = runtime.GOOS
+	goarch    = runtime.GOARCH
+)
 
 // summarizeCmd will parse the tf plan output json to scrape created|updated|deleted resources in a clear outout
 var summarizeCmd = &cobra.Command{
@@ -40,8 +38,18 @@ var summarizeCmd = &cobra.Command{
 var usageCmd = &cobra.Command{
 	Use:   "usage",
 	Short: "print usage",
-	Long:  "print usage in a pretty markdown render using terminal",
+	Long:  "print usage in a pretty markdown render using terminal. This require internet connection since it fetch usage.md from github url",
 	Run: func(cmd *cobra.Command, args []string) {
 		markdownrender.RenderUsage()
 	},
 }
+
+// versionCmd will print the current installed version in your local
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "tftools current version",
+	Long:  "Get the cli tftools version installed",
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("tftools: %s with go version %s %s/%s", version, goversion, goos, goarch)
+	},
+}

cmd/tftools/root.go → cmd/root.go

@@ -6,21 +6,13 @@ package cmd
 import (
 	"fmt"
 	"os"
-	"runtime"
 
 	"github.com/dimiro1/banner"
 	"github.com/mattn/go-colorable"
 
 	"github.com/spf13/cobra"
 )
 
-var (
-	version   string
-	goversion = runtime.Version()
-	goos      = runtime.GOOS
-	goarch    = runtime.GOARCH
-)
-
 // printBanner will print an ascii banner with colors
 func printBanner() {
 	templ := `{{ .AnsiColor.BrightMagenta  }} {{ .Title "tftools" "" 2 }}{{ .AnsiColor.Default }}
@@ -50,13 +42,3 @@ func Execute() {
 		os.Exit(1)
 	}
 }
-
-// versionCmd will print the current installed version in your local
-var versionCmd = &cobra.Command{
-	Use:   "version",
-	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)
-	},
-}

docs/install.md

@@ -17,22 +17,10 @@
 
 ## 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 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
 
 ```bash

internal/utils/markdown_render/pretty_markdown.go

@@ -1,26 +1,43 @@
 package markdownrender
 
 import (
-	"embed"
 	"fmt"
+	"io"
 	"log"
+	"net/http"
 
 	"github.com/charmbracelet/glamour"
 )
 
-// Embed usage documentation.
-//go:generate cp -r ../../../docs/usage.md ./usage.md
-//go:embed usage.md
+const (
+	usageURL = "https://raw.githubusercontent.com/containerscrew/tftools/main/docs/usage.md"
+)
 
-var usage embed.FS
+func ReadUsageFile() string {
+	resp, err := http.Get(usageURL)
 
-func RenderUsage() {
-	usage, err := usage.ReadFile("docs/usage.md")
 	if err != nil {
-		log.Fatal(err)
+		log.Println(err)
+	}
+
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		log.Println(resp.StatusCode)
+	}
+
+	data, err := io.ReadAll(resp.Body)
+	if err != nil {
+		log.Println(err)
 	}
 
-	out, err := glamour.Render(string(usage), "dark")
+	return string(data)
+}
+
+func RenderUsage() {
+	data := ReadUsageFile()
+
+	out, err := glamour.Render(data, "dark")
 	if err != nil {
 		log.Println(err)
 	}

main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	cmd "github.com/containerscrew/tftools/cmd/tftools"
+	"github.com/containerscrew/tftools/cmd"
 )
 
 func main() {