feat(prompt): add ENV key to aad environment variables to the flow and regex capacity hover default values

Author: Rodrigo Navarro

cmf/cmf.go

@@ -74,6 +74,14 @@ func NewCMF(repository Repository, templateManager TemplateManager, fsManager FS
 	}
 }
 
+func (cmfInstance *cmf) getInnerVariables() map[string]string {
+	extra := map[string]string{
+		"BRANCH_NAME": cmfInstance.repository.BranchName(),
+	}
+
+	return extra
+}
+
 // GetVersion return current cmf version
 func (cmfInstance *cmf) GetVersion() {
 	fmt.Println("Git - Commit Message Formatter v", version)
@@ -88,10 +96,7 @@ func (cmfInstance *cmf) CommitChanges() {
 		cmfFile, _ = cmfInstance.fs.GetFileFromVirtualFS(defaultYamlFile)
 	}
 
-	extra := map[string]string{
-		"BRANCH_NAME": cmfInstance.repository.BranchName(),
-	}
-	message, _ := cmfInstance.templateManager.Run(cmfFile, extra)
+	message, _ := cmfInstance.templateManager.Run(cmfFile, cmfInstance.getInnerVariables())
 	cmfInstance.repository.Commit(message)
 }
 
@@ -104,10 +109,7 @@ func (cmfInstance *cmf) CommitAmend() {
 		cmfFile, _ = cmfInstance.fs.GetFileFromVirtualFS(defaultYamlFile)
 	}
 
-	extra := map[string]string{
-		"BRANCH_NAME": cmfInstance.repository.BranchName(),
-	}
-	message, _ := cmfInstance.templateManager.Run(cmfFile, extra)
+	message, _ := cmfInstance.templateManager.Run(cmfFile, cmfInstance.getInnerVariables())
 	cmfInstance.repository.Amend(message)
 }
 

templaterunner/templaterunner.go

@@ -2,6 +2,8 @@ package templaterunner
 
 import (
 	"errors"
+	"os"
+	"regexp"
 	"strings"
 
 	"gopkg.in/yaml.v2"
@@ -24,6 +26,7 @@ type TemplateRunner interface {
 
 // Template main template struct
 type Template struct {
+	Env      []string     `yaml:"ENV"`
 	Prompt   []PromptItem `yaml:"PROMPT"`
 	Template string       `yaml:"TEMPLATE"`
 }
@@ -34,6 +37,7 @@ type PromptItem struct {
 	Label        string    `yaml:"LABEL"`
 	ErrorLabel   string    `yaml:"ERROR_LABEL"`
 	DefaultValue string    `yaml:"DEFAULT_VALUE"`
+	Regex        string    `yaml:"REGEX"`
 	Options      []Options `yaml:"OPTIONS"`
 }
 
@@ -67,17 +71,24 @@ func (tr *templateRunner) parseYaml(yamlData string) (Template, error) {
 }
 
 // Run return the result of run the template
-func (tr *templateRunner) Run(yamlData string, injectedVariables map[string]string) (string, error) {
+func (tr *templateRunner) Run(yamlData string, defaultVariables map[string]string) (string, error) {
 	template, err := tr.parseYaml(yamlData)
 	if err != nil {
 		return "", err
 	}
 
-	variables := tr.prompt(template)
-	for k, v := range injectedVariables {
+	variables := []keyValue{}
+	for k, v := range defaultVariables {
 		variables = append(variables, keyValue{Key: k, Value: v})
 	}
 
+	for _, environmentVariable := range template.Env {
+		variables = append(variables, keyValue{Key: environmentVariable, Value: os.Getenv(environmentVariable)})
+	}
+
+	promptVariables := tr.prompt(template, variables)
+	variables = append(variables, promptVariables...)
+
 	message := tr.parseTemplate(template.Template, variables)
 
 	return message, err
@@ -91,10 +102,11 @@ func (tr *templateRunner) parseTemplate(template string, variables []keyValue) s
 	return template
 }
 
-func (tr *templateRunner) prompt(template Template) []keyValue {
+func (tr *templateRunner) prompt(template Template, defaultVariables []keyValue) []keyValue {
 	variables := []keyValue{}
 	for _, step := range template.Prompt {
 		result := ""
+		defaultValue := ""
 		var errorMessage = "empty value"
 
 		if step.ErrorLabel != "" {
@@ -105,12 +117,18 @@ func (tr *templateRunner) prompt(template Template) []keyValue {
 			var labelMessage = step.Label
 
 			if step.DefaultValue != "" {
-				labelMessage += " (" + step.DefaultValue + ")"
+				defaultValue = tr.parseTemplate(step.DefaultValue, defaultVariables)
+				if step.Regex != "" {
+					r, _ := regexp.Compile(step.Regex)
+					defaultValue = r.FindStringSubmatch(defaultValue)[0]
+				}
+
+				labelMessage += " (" + defaultValue + ")"
 			}
 
 			labelMessage += ":"
 
-			result = tr.promptManager.ReadValue(labelMessage, errorMessage, step.DefaultValue)
+			result = tr.promptManager.ReadValue(labelMessage, errorMessage, defaultValue)
 		} else {
 			result = tr.promptManager.ReadValueFromList(step.Label, step.Options)
 		}