Merge pull request #68 from DannyBen/add/arg-whitelist

Add support for whitelist in args

Author: DannyBen

.github/workflows/test.yml

@@ -9,6 +9,9 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    env: 
+      LC_ALL: en_US.UTF-8 # consistent sort order
+
     strategy:
       matrix: { ruby: ['2.4', '2.5', '2.6', '2.7', '3.0'] }
 

README.md

@@ -223,6 +223,7 @@ bash function.
 `help`     | The message to display when using `--help`. Can have multiple lines.
 `required` | Specify if this argument is required. Note that once you define an optional argument (without required: true) then you cannot define required arguments after it.
 `default`  | The value to use in case it is not provided by the user. Implies that this argument is optional.
+`allowed`  | Limit the allowed values by providing an array.
 
 ### Flag options
 

examples/allowed-flags/src/bashly.yml

@@ -151,6 +151,7 @@ parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.initialize

examples/allowed-flags/test.sh

@@ -215,6 +215,7 @@ parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -270,6 +271,7 @@ ftp_upload_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -325,6 +327,7 @@ ftp_download_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.initialize

examples/colors/colorly

@@ -288,6 +288,7 @@ parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -343,6 +344,7 @@ ftp_download_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -398,6 +400,7 @@ ftp_upload_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -441,6 +444,7 @@ ftp_login_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -484,6 +488,7 @@ ftp_logout_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.initialize

examples/command-default/ftp

@@ -358,6 +358,7 @@ parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -426,6 +427,7 @@ cli_dir_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -481,6 +483,7 @@ cli_dir_list_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -542,6 +545,7 @@ cli_dir_remove_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -610,6 +614,7 @@ cli_file_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -665,6 +670,7 @@ cli_file_show_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -720,6 +726,7 @@ cli_file_edit_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.initialize

examples/command-groups/ftp

@@ -248,6 +248,7 @@ parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -312,6 +313,7 @@ cli_download_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -396,6 +398,7 @@ cli_upload_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.initialize

examples/commands-nested/cli

@@ -410,6 +410,7 @@ parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -476,6 +477,7 @@ configly_set_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -531,6 +533,7 @@ configly_get_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.parse_requirements
@@ -574,6 +577,7 @@ configly_list_parse_requirements() {
     esac
   done
   # :command.default_assignments
+  # :command.whitelist_filter
 }
 
 # :command.initialize