Add helper function for printing an error with help command

tfversion · Mar 5, 2024 · cd73fb7 · cd73fb7
1 parent 4949dd3
commit cd73fb7
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 18 deletions.
diff --git a/cmd/alias.go b/cmd/alias.go
@@ -1,9 +1,6 @@
 package cmd
 
 import (
-	"fmt"
-
-	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
 	"github.com/tfversion/tfversion/pkg/alias"
@@ -23,7 +20,7 @@ var (
 		Example: aliasExample,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 2 {
-				err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion alias -h`"))
+				err := helpers.ErorWithHelp("tfversion alias -h")
 				helpers.ExitWithError("provide an alias name and Terraform version", err)
 			}
 			alias.AliasVersion(args[0], args[1])

diff --git a/cmd/install.go b/cmd/install.go
@@ -1,10 +1,8 @@
 package cmd
 
 import (
-	"fmt"
 	"os"
 
-	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 	"github.com/tfversion/tfversion/pkg/helpers"
 	"github.com/tfversion/tfversion/pkg/install"
@@ -45,7 +43,7 @@ var (
 			// install latest
 			if latest {
 				if len(args) != 0 {
-					err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion install -h`"))
+					err := helpers.ErorWithHelp("tfversion install -h")
 					helpers.ExitWithError("`--latest` flag does not require specifying a Terraform version", err)
 				}
 				install.InstallLatestVersion(preRelease)
@@ -55,7 +53,7 @@ var (
 			// installed required version
 			if required {
 				if len(args) != 0 {
-					err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion install -h`"))
+					err := helpers.ErorWithHelp("tfversion install -h")
 					helpers.ExitWithError("`--required` flag does not require specifying a Terraform version", err)
 				}
 				install.InstallRequiredVersion()
@@ -64,7 +62,7 @@ var (
 
 			// install specific version
 			if len(args) != 1 {
-				err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion install -h`"))
+				err := helpers.ErorWithHelp("tfversion install -h")
 				helpers.ExitWithError("provide a Terraform version to install", err)
 			}
 			install.InstallVersion(args[0])

diff --git a/cmd/uninstall.go b/cmd/uninstall.go
@@ -1,9 +1,6 @@
 package cmd
 
 import (
-	"fmt"
-
-	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 	"github.com/tfversion/tfversion/pkg/helpers"
 	"github.com/tfversion/tfversion/pkg/uninstall"
@@ -25,7 +22,7 @@ var (
 		Example: uninstallExample,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 1 {
-				err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion uninstall -h`"))
+				err := helpers.ErorWithHelp("tfversion uninstall -h")
 				helpers.ExitWithError("provide a Terraform version to uninstall", err)
 			}
 			uninstall.Uninstall(args[0])

diff --git a/cmd/use.go b/cmd/use.go
@@ -1,10 +1,8 @@
 package cmd
 
 import (
-	"fmt"
 	"os"
 
-	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 	"github.com/tfversion/tfversion/pkg/helpers"
 	"github.com/tfversion/tfversion/pkg/use"
@@ -42,7 +40,7 @@ var (
 			// use latest version
 			if latest {
 				if len(args) != 0 {
-					err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion use -h`"))
+					err := helpers.ErorWithHelp("tfversion use -h")
 					helpers.ExitWithError("`--latest` flag does not require specifying a Terraform version", err)
 				}
 				use.UseLatestVersion(preRelease)
@@ -52,7 +50,7 @@ var (
 			// use required version
 			if required {
 				if len(args) != 0 {
-					err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion use -h`"))
+					err := helpers.ErorWithHelp("tfversion use -h")
 					helpers.ExitWithError("`--required` flag does not require specifying a Terraform version", err)
 				}
 				use.UseRequiredVersion()
@@ -61,7 +59,7 @@ var (
 
 			// use specific version
 			if len(args) != 1 {
-				err := fmt.Errorf("see %s for help and examples", color.CyanString("`tfversion use -h`"))
+				err := helpers.ErorWithHelp("tfversion use -h")
 				helpers.ExitWithError("provide a Terraform version to activate", err)
 			}
 			use.UseVersion(args[0])

diff --git a/pkg/helpers/helper.go b/pkg/helpers/helper.go
@@ -30,6 +30,11 @@ func ExitWithError(message string, err error) {
 	os.Exit(1)
 }
 
+// ErorWithHelp returns an error with a help message
+func ErorWithHelp(help string) error {
+	return fmt.Errorf("see %s for help and examples", color.CyanString("`%s`", help))
+}
+
 // IsPreReleaseVersion checks if the given version is a Terraform pre-release version
 func IsPreReleaseVersion(version string) bool {
 	return strings.Contains(version, "-alpha") || strings.Contains(version, "-beta") || strings.Contains(version, "-rc")