Removed empty description from variable declaration (#11)

marceloalmeida · web-flow · commit 5d9b7cc0baca · 2020-12-25T07:48:21.000+02:00
* Removed empty description from variable declaration
* Added command flag to place or not description on variables
diff --git a/README.md b/README.md
@@ -24,11 +24,11 @@ go build .
 ./terraform-variables-generator
 ```
 
-It will find all *.tf files in current directory, and generate variables.tf file. If you already have this file, it will ask to override it.
+It will find all `*.tf` files in current directory, and generate variables.tf file. If you already have this file, it will ask to override it.
 
 ### Example
 
-```text
+```hcl
 resource "aws_vpc" "vpc" {
   cidr_block           = var.cidr
   enable_dns_hostnames = var.enable_dns_hostnames
@@ -48,33 +48,33 @@ resource "aws_internet_gateway" "vpc" {
 }
 ```
 
- Will generate
+Will generate
 
- ```text
- variable "ami" {
-   description  = ""
+```hcl
+variable "ami" {
+  description = ""
 }
 
 variable "instance_type" {
-   description  = ""
+  description = ""
 }
 
 variable "cidr" {
-   description  = ""
+  description = ""
 }
 
 variable "enable_dns_hostnames" {
-   description  = ""
+  description = ""
 }
 
 variable "enable_dns_support" {
-   description  = ""
+  description = ""
 }
 
 variable "name" {
-   description  = ""
+  description = ""
 }
- ```
+```
 
 ## Tests
 
diff --git a/cmd/cmd.go b/cmd/cmd.go
@@ -19,9 +19,10 @@ const (
 var (
 	generatorVersion string
 
-	vars       bool
-	varsFile   string
-	localsFile string
+	vars            bool
+	varsDescription bool
+	varsFile        string
+	localsFile      string
 )
 
 // Execute will run main logic
@@ -37,6 +38,7 @@ func Execute(version string) {
 	}
 
 	cmd.PersistentFlags().BoolVar(&vars, "vars", true, "generate variables")
+	cmd.PersistentFlags().BoolVar(&varsDescription, "vars-description", true, "include description on variables")
 	cmd.PersistentFlags().StringVar(&varsFile, "vars-file", "./variables.tf", "path to generated variables file")
 	cmd.PersistentFlags().StringVar(&localsFile, "locals-file", "./locals.tf", "path to generated locals file")
 
@@ -64,6 +66,6 @@ func runGenerator(cmd *cobra.Command, args []string) {
 			return
 		}
 
-		generator.Generate(tfFiles, varsFile, localsFile)
+		generator.Generate(tfFiles, varsFile, localsFile, varsDescription)
 	}
 }
diff --git a/pkg/generator/terraform.go b/pkg/generator/terraform.go
@@ -9,8 +9,9 @@ import (
 )
 
 type terraformVars struct {
-	Variables []string
-	Locals    []string
+	Locals               []string
+	Variables            []string
+	VariablesDescription bool
 }
 
 func (t *terraformVars) matchVarPref(row, varPrefix string) {
diff --git a/pkg/generator/vars.go b/pkg/generator/vars.go
@@ -16,11 +16,15 @@ var replacer *strings.Replacer
 var varPrefix = "var."
 var localPrefix = "local."
 
-var varTemplate = template.Must(template.New("var_file").Parse(`{{range .}}
-variable "{{ . }}" {
+var varTemplate = template.Must(template.New("var_file").Funcs(template.FuncMap{"sub": sub}).Parse(`{{- $length := len .Variables -}}
+{{- range $i, $v := .Variables -}}
+{{ if $.VariablesDescription }}variable "{{ $v }}" {
   description = ""
-}
-{{end}}`))
+}{{ else }}variable "{{ $v }}" {}{{ end }}
+{{- if lt $i (sub $length 1) }}{{ "\n\n" }}{{ end -}}
+{{ end -}}{{printf "\n"}}`))
+
+func sub(a, b int) int { return a - b }
 
 var localsTemplate = template.Must(template.New("locals_file").Parse(`locals { {{ range . }}
   {{ . }} ={{ end }}
@@ -44,11 +48,12 @@ func init() {
 }
 
 // Generate will write inputs to file
-func Generate(tfFiles []string, varsDstFile string, localsDstFile string) {
+func Generate(tfFiles []string, varsDstFile string, localsDstFile string, varsDescription bool) {
 	var wg sync.WaitGroup
 	messages := make(chan string)
 	wg.Add(len(tfFiles))
 	t := &terraformVars{}
+	t.VariablesDescription = varsDescription
 
 	for _, file := range tfFiles {
 		go func(file string) {
@@ -75,7 +80,7 @@ func Generate(tfFiles []string, varsDstFile string, localsDstFile string) {
 		log.Infof("Variables are generated to %q file", varsDstFile)
 
 		t.sort(t.Variables)
-		err = varTemplate.Execute(f, t.Variables)
+		err = varTemplate.Execute(f, t)
 		utils.CheckError(err)
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,10 @@ const (`
`19`	`19`	`var (`
`20`	`20`	`generatorVersion string`
`21`	`21`
`22`		`- vars bool`
`23`		`- varsFile string`
`24`		`- localsFile string`
	`22`	`+ vars bool`
	`23`	`+ varsDescription bool`
	`24`	`+ varsFile string`
	`25`	`+ localsFile string`
`25`	`26`	`)`
`26`	`27`
`27`	`28`	`// Execute will run main logic`
`@@ -37,6 +38,7 @@ func Execute(version string) {`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`cmd.PersistentFlags().BoolVar(&vars, "vars", true, "generate variables")`
	`41`	`+ cmd.PersistentFlags().BoolVar(&varsDescription, "vars-description", true, "include description on variables")`
`40`	`42`	`cmd.PersistentFlags().StringVar(&varsFile, "vars-file", "./variables.tf", "path to generated variables file")`
`41`	`43`	`cmd.PersistentFlags().StringVar(&localsFile, "locals-file", "./locals.tf", "path to generated locals file")`
`42`	`44`
`@@ -64,6 +66,6 @@ func runGenerator(cmd *cobra.Command, args []string) {`
`64`	`66`	`return`
`65`	`67`	`}`
`66`	`68`
`67`		`- generator.Generate(tfFiles, varsFile, localsFile)`
	`69`	`+ generator.Generate(tfFiles, varsFile, localsFile, varsDescription)`
`68`	`70`	`}`
`69`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,9 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`type terraformVars struct {`
`12`		`- Variables []string`
`13`		`- Locals []string`
	`12`	`+ Locals []string`
	`13`	`+ Variables []string`
	`14`	`+ VariablesDescription bool`
`14`	`15`	`}`
`15`	`16`
`16`	`17`	`func (t *terraformVars) matchVarPref(row, varPrefix string) {`