add repeatable args example

DannyBen · DannyBen · commit d77067ba85d2 · 2022-04-01T10:08:41.000Z
diff --git a/examples/README.md b/examples/README.md
@@ -25,7 +25,8 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [extensible](extensible#readme) - letting your script's users extend the script
 - [extensible-delegate](extensible-delegate#readme) - extending your script by delegating commands to an external executable
 - [whitelist](whitelist#readme) - arguments and flags with a predefined allowed list of values
-- [repeatable](repeatable#readme) - allowing flags to be provided multiple times
+- [repeatable-arg](repeatable-arg#readme) - allowing args to be provided multiple times
+- [repeatable-flag](repeatable-flag#readme) - allowing flags to be provided multiple times
 - [conflicts](conflicts#readme) - defining mutually exclusive flags
 - [command-private](command-private#readme) - hiding commands from the command list
 - [stdin](stdin#readme) - reading input from stdin
diff --git a/examples/repeatable-arg/.gitignore b/examples/repeatable-arg/.gitignore
@@ -0,0 +1 @@
+upcase
diff --git a/examples/repeatable-arg/README.md b/examples/repeatable-arg/README.md
diff --git a/examples/repeatable-arg/file1 b/examples/repeatable-arg/file1
@@ -0,0 +1 @@
+content of file1
diff --git a/examples/repeatable-arg/file2 b/examples/repeatable-arg/file2
@@ -0,0 +1 @@
+content of file2
diff --git a/examples/repeatable-arg/src/bashly.yml b/examples/repeatable-arg/src/bashly.yml
@@ -0,0 +1,18 @@
+name: upcase
+help: Sample application to demonstrate the use of repeatable arguments
+version: 0.1.0
+
+args:
+- name: file
+  help: One or more files to process
+  required: true
+
+  # Setting repeatable to true means that the user can provide multiple arguments
+  # for it.
+  # The argument will be received as a quoted and space-delimited string which
+  # needs to be converted to an array with `eval "data=(${args[file]})"`
+  repeatable: true
+
+examples:
+- upcase README.md LICENSE
+- upcase *.md
diff --git a/examples/repeatable-arg/src/initialize.sh b/examples/repeatable-arg/src/initialize.sh
diff --git a/examples/repeatable-arg/src/root_command.sh b/examples/repeatable-arg/src/root_command.sh
@@ -0,0 +1,14 @@
+# Convert the space delimited string to an array
+eval "files=(${args[file]})"
+
+echo
+echo "files:"
+for i in "${files[@]}"; do
+  echo "  path: $i:"
+  content="$(cat "$i")"
+  echo "  content: ${content}"
+  echo "  upcase: ${content^^}"
+done
+
+echo
+inspect_args
diff --git a/examples/repeatable-arg/test.sh b/examples/repeatable-arg/test.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./upcase -h
+./upcase file1
+./upcase file*
diff --git a/examples/repeatable-flag/.gitignore b/examples/repeatable-flag/.gitignore
diff --git a/examples/repeatable-flag/README.md b/examples/repeatable-flag/README.md
@@ -0,0 +1,123 @@
+# Repeatable Example
+
+Demonstrates the use of repeatable flags that allow users to run commands such
+as `download -d one -d "two three" -vvv`.
+
+This example was generated with:
+
+```bash
+$ bashly init --minimal
+# ... now edit src/bashly.yml to match the example ...
+# ... now edit src/root_command.sh to match the example ...
+$ bashly generate
+```
+
+<!-- include: src/root_command.sh -->
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: download
+help: Sample application to demonstrate the use of repeatable flags
+version: 0.1.0
+
+flags:
+- long: --data
+  short: -d
+  arg: data
+  help: Provide data values
+  required: true
+
+  # Setting this to true on a flag with an argument means the user can type it
+  # multiple times, like --data a --data b.
+  # The argument will be received as a quoted and space-delimited string which
+  # needs to be converted to an array with `eval "data=(${args[--data]})"`
+  repeatable: true
+
+- long: --verbose
+  short: -v
+  help: Set verbosity level
+
+  # Setting this to true on a regular flag means the user can type it multiple
+  # times, in the form of -vvv or -v -v -v.
+  # The argument's value will hold the number of times it was entered.
+  repeatable: true
+
+examples:
+  - download -d one -d "two three" -vvv
+```
+
+## `src/root_command.sh`
+
+```bash
+# Convert the space delimited string to an array
+eval "data=(${args[--data]})"
+
+echo "Data elements:"
+for i in "${data[@]}"; do
+  echo "$i"
+done
+
+# The --verbose arg will contain the number of times it was used by the user
+verbose=${args[--verbose]}
+echo ""
+echo "Verbosity level: $verbose"
+echo ""
+
+inspect_args
+
+```
+
+
+## Generated script output
+
+### `$ ./download -h`
+
+```shell
+download - Sample application to demonstrate the use of repeatable flags
+
+Usage:
+  download [options]
+  download --help | -h
+  download --version
+
+Options:
+  --help, -h
+    Show this help
+
+  --version
+    Show version number
+
+  --data, -d DATA (required) (repeatable)
+    Provide data values
+
+  --verbose, -v (repeatable)
+    Set verbosity level
+
+Examples:
+  download -d one -d "two three" -vvv
+
+
+
+```
+
+### `$ ./download -d one -d "two three" -vvv`
+
+```shell
+Data elements:
+one
+two three
+
+Verbosity level: 3
+
+args:
+- ${args[--data]} = "one" "two three"
+- ${args[--verbose]} = 3
+
+
+```
+
+
+
diff --git a/examples/repeatable-flag/src/bashly.yml b/examples/repeatable-flag/src/bashly.yml
@@ -25,5 +25,5 @@ flags:
   repeatable: true
 
 examples:
-  - download -d one -d "two three" -vvv
+- download -d one -d "two three" -vvv
 
diff --git a/examples/repeatable-flag/src/initialize.sh b/examples/repeatable-flag/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment vairables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/repeatable-flag/src/root_command.sh b/examples/repeatable-flag/src/root_command.sh
diff --git a/examples/repeatable-flag/test.sh b/examples/repeatable-flag/test.sh
diff --git a/lib/bashly/views/command/whitelist_filter.erb b/lib/bashly/views/command/whitelist_filter.erb
@@ -4,7 +4,7 @@
 eval "input_array=(${args[<%= arg.name %>]})"
 for i in "${input_array[@]}"; do
   if [[ ! $i =~ ^(<%= arg.allowed.join '|' %>)$ ]]; then
-    printf "%s\n" "<%= strings[:disallowed_arg] % { name: arg.name, allowed: arg.allowed.join(', ') } %>"
+    printf "%s\n" "<%= strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } %>"
     exit 1
   fi
 done
