- Add support for allowed values for flags

Author: DannyBen

lib/bashly/models/base.rb

@@ -6,10 +6,11 @@ class Base
       attr_reader :options
 
       OPTION_KEYS = %i[
+        allowed
         arg
+        default
         dependencies
         description
-        default
         environment_variables
         examples
         flags

lib/bashly/templates/strings.yml

@@ -15,6 +15,7 @@ command_shortcut: "Shortcut: %{short}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
 default: "Default: %{value}"
+allowed: "Allowed: %{values}"
 
 # Fixed flags help text
 help_flag_text: Show this help
@@ -28,3 +29,4 @@ missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
 missing_required_flag: "missing required flag: %{usage}"
 missing_required_environment_variable: "missing required environment variable: %{var}"
 missing_dependency: "missing dependency: %{dependency}"
+disallowed_flag: "%{name} must be one of: %{allowed}"

lib/bashly/views/flag/case.erb

@@ -5,6 +5,13 @@
     args[<%= name %>]="$2"
     shift
     shift
+    <%- if allowed -%>
+    allowed="<%= allowed.join '|' %>"
+    if [[ ! ${args[<%= name %>]} =~ $allowed ]]; then
+      printf "%s\n" "<%= strings[:disallowed_flag] % { name: name, allowed: allowed.join(', ') } %>\n"
+      exit 1
+    fi
+    <%- end -%>
   else
     printf "%s\n" "<%= strings[:flag_requires_an_argument] % { name: name, usage: usage_string } %>"
     exit 1

lib/bashly/views/flag/usage.erb

@@ -1,6 +1,9 @@
 # :flag.usage
 echo "  <%= usage_string extended: true %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
+<%- if allowed -%>
+printf "    <%= strings[:allowed] % { values: allowed.join(', ') } -%>\n"
+<%- end -%>
 <%- if default -%>
 printf "    <%= strings[:default] % { value: default } -%>\n"
 <%- end -%>