Merge pull request #182 from DannyBen/add/exclusive

Add support for exclusive flags (conflicts)

Author: DannyBen

examples/README.md

@@ -25,6 +25,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [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
+- [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
 - [filters](filters#readme) - preventing commands from running unless custom conditions are met

examples/conflicts/.gitignore

@@ -0,0 +1 @@
+download

examples/conflicts/README.md

@@ -0,0 +1,91 @@
+# Conflicting Flags Example
+
+Demonstrates the use of conflicting flags that cannot be executed together.
+
+This example was generated with:
+
+```bash
+$ bashly init --minimal
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: download
+help: Sample application to demonstrate the use of conflicting flags
+version: 0.1.0
+
+flags:
+- long: --cache
+  help: Enable cache
+  # Running --cache with --no-cache is not permitted
+  conflicts: [--no-cache]
+- long: --no-cache
+  help: Diisable cache
+  # Running --no-cache with --cache or with --fast is not permitted
+  conflicts: [--cache, --fast]
+- long: --fast
+  help: Run faster
+  # Make sure to add the conflicting flags in both flags
+  conflicts: [--no-cache]
+```
+
+
+
+## Generated script output
+
+### `$ ./download -h`
+
+```shell
+download - Sample application to demonstrate the use of conflicting flags
+
+Usage:
+  download [options]
+  download --help | -h
+  download --version | -v
+
+Options:
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+
+  --cache
+    Enable cache
+
+  --no-cache
+    Diisable cache
+
+  --fast
+    Run faster
+
+
+
+```
+
+### `$ ./download --cache`
+
+```shell
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--cache]} = 1
+
+
+```
+
+### `$ ./download --no-cache --fast`
+
+```shell
+conflicting options: --fast cannot be used with --no-cache
+
+
+```
+
+
+

examples/conflicts/src/bashly.yml

@@ -0,0 +1,18 @@
+name: download
+help: Sample application to demonstrate the use of conflicting flags
+version: 0.1.0
+
+flags:
+- long: --cache
+  help: Enable cache
+  # Running --cache with --no-cache is not permitted
+  conflicts: [--no-cache]
+- long: --no-cache
+  help: Diisable cache
+  # Running --no-cache with --cache or with --fast is not permitted
+  conflicts: [--cache, --fast]
+- long: --fast
+  help: Run faster
+  # Make sure to add the conflicting flags in both flags
+  conflicts: [--no-cache]
+

examples/conflicts/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.

examples/conflicts/src/root_command.sh

@@ -0,0 +1,3 @@
+echo "# this file is located in 'src/root_command.sh'"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

examples/conflicts/test.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./download -h
+./download --cache
+./download --no-cache --fast

examples/filters/README.md

@@ -54,6 +54,7 @@ commands:
 # These filter functions can reside in any path under the `lib` directory.
 # You can use a single file for all filter functions, or a separate file
 # for each function.
+# Note that the `${args[]}` array is available to you in your filter functions.
 
 # Print an error string if docker is not running.
 # The script will automatically exit if this function prints anything.

examples/filters/src/lib/filters.sh

@@ -1,6 +1,7 @@
 # These filter functions can reside in any path under the `lib` directory.
 # You can use a single file for all filter functions, or a separate file
 # for each function.
+# Note that the `${args[]}` array is available to you in your filter functions.
 
 # Print an error string if docker is not running.
 # The script will automatically exit if this function prints anything.

examples/repeatable/README.md

@@ -76,7 +76,7 @@ inspect_args
 ### `$ ./download -h`
 
 ```shell
-download - Sample application to demonstrate use of repeatable flags
+download - Sample application to demonstrate the use of repeatable flags
 
 Usage:
   download [options]