wip: add cli arg

jsjoeio · jsjoeio · commit 01ac92825124 · 2022-05-12T18:56:54.000Z
diff --git a/cli/cliarg/cliarg.go b/cli/cliarg/cliarg.go
@@ -0,0 +1,28 @@
+// Package cliarg extends cobra.Args to allow for custom error messages.
+//
+// Usage:
+//
+// cliarg.ExactNamedArgs("workspace", "This command requires a workspace name to be passed. Run this command with '--help' to see an example.")
+//
+// Will produce the following error message when calling
+//
+//   Error: this command accepts 'workspace' as an argument, received no arguments. Pass in 'workspace' or call command with '--help' to see an example.")
+//
+package cliflag
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// Expects 1 arg based on namedArg, otherwise returns customErrorMessage
+func ExactNamedArg(namedArg string, customErrorMessage string) cobra.PositionalArgs {
+	return func(cmd *cobra.Command, args []string) error {
+		expectedNumOfArgs := 1
+		if len(args) != expectedNumOfArgs {
+			return fmt.Errorf("this command accepts <%s> as an argument, received no arguments. Pass in arg or call command with '--help' to see an example.", namedArg)
+		}
+		return nil
+	}
+}
