resolve conflicts

Author: DannyBen

CHANGELOG.md

@@ -1,6 +1,12 @@
 Change Log
 ========================================
 
+Untagged - Latest
+----------------------------------------
+
+- Add optional arg/flag validation functions
+
+
 v0.6.8 - 2021-10-12
 ----------------------------------------
 

README.md

@@ -67,11 +67,13 @@ Bashly is responsible for:
 ## Contributing / Support
 
 If you experience any issue, have a question or a suggestion, or if you wish
-to contribute, feel free to [open an issue][issues].
+to contribute, feel free to [open an issue][issues] or
+[start a discussion][discussions].
 
 
 
 [issues]: https://github.com/DannyBen/bashly/issues
+[discussions]: https://github.com/DannyBen/bashly/discussions
 [docs]: https://bashly.dannyb.co/
 [examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
 

examples/README.md

@@ -43,3 +43,4 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [colors](colors#readme) - using the color print feature
 - [yaml](yaml#readme) - using the YAML reading functions
 - [completions](completions#readme) - adding bash completion functionality
+- [validations](validations#readme) - adding argument validation functions

examples/validations/.gitignore

@@ -0,0 +1 @@
+calc

examples/validations/README.md

@@ -0,0 +1,127 @@
+# Validations Example
+
+Demonstrates how to add validation functions to arguments and flag arguments.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly add validations
+$ bashly generate
+```
+
+Running the `bashly add validations` command simply adds the
+[src/lib/validations](src/lib/validations) folder, which includes some built in
+validation functions. You can add custom function by adding a function that
+starts with `validate_`. Thee functions must return a string on validation
+failure, or an empty string on success.
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: calc
+help: Sample application demonstrating validations
+version: 0.1.0
+
+commands:
+- name: add
+  short: a
+  help: Add two numbers
+
+  args:
+  - name: first
+    help: First number
+    required: true
+
+    # Specify one or more validation types (as string or array)
+    # This validation will look for a function named `validate_integer` in your
+    # script.
+    validate: integer
+  - name: second
+    help: Second number
+
+    # Using the array syntax, you can specify more than one validations
+    validate:
+      - integer
+
+  flags:
+  - long: --multiply
+    short: -m
+    arg: factor
+    help: Multiply the result
+
+    # Validations also work on flags (when they have arguments)
+    validate: integer
+```
+
+
+
+## Generated script output
+
+### `$ ./calc -h`
+
+```shell
+calc - Sample application demonstrating validations
+
+Usage:
+  calc [command]
+  calc [command] --help | -h
+  calc --version | -v
+
+Commands:
+  add   Add two numbers
+
+Options:
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+
+
+
+```
+
+### `$ ./calc add 1 2 --multiply 3`
+
+```shell
+# this file is located in 'src/add_command.sh'
+# code for 'calc add' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[first]} = 1
+- ${args[--multiply]} = 3
+- ${args[second]} = 2
+
+
+```
+
+### `$ ./calc add A`
+
+```shell
+validation error: FIRST must be an integer
+
+
+```
+
+### `$ ./calc add 1 B`
+
+```shell
+validation error: SECOND must be an integer
+
+
+```
+
+### `$ ./calc add 1 2 --multiply C`
+
+```shell
+validation error: --multiply, -m FACTOR must be an integer
+
+
+```
+
+
+

examples/validations/src/add_command.sh

@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/add_command.sh'"
+echo "# code for 'calc add' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

examples/validations/src/bashly.yml

@@ -0,0 +1,33 @@
+name: calc
+help: Sample application demonstrating validations
+version: 0.1.0
+
+commands:
+- name: add
+  short: a
+  help: Add two numbers
+
+  args:
+  - name: first
+    help: First number
+    required: true
+
+    # Specify one or more validation types (as string or array)
+    # This validation will look for a function named `validate_integer` in your
+    # script.
+    validate: integer
+  - name: second
+    help: Second number
+
+    # Using the array syntax, you can specify more than one validations
+    validate:
+      - integer
+
+  flags:
+  - long: --multiply
+    short: -m
+    arg: factor
+    help: Multiply the result
+
+    # Validations also work on flags (when they have arguments)
+    validate: integer

examples/validations/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/validations/src/lib/validations/validate_integer.sh

@@ -0,0 +1,3 @@
+validate_integer() {
+  [[ "$1" =~ ^[0-9]+$ ]] || echo "must be an integer"
+}

examples/validations/test.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+rm -f ./src/*.sh
+rm -rf ./src/lib
+
+set -x
+
+bashly add validations
+bashly generate
+
+### Try Me ###
+
+./calc -h
+./calc add 1 2 --multiply 3
+./calc add A
+./calc add 1 B
+./calc add 1 2 --multiply C
+
+