- Add hooks example

Author: DannyBen

examples/README.md

@@ -62,6 +62,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [yaml](yaml#readme) - using the YAML reading functions
 - [completions](completions#readme) - adding bash completion functionality
 - [validations](validations#readme) - adding argument validation functions
+- [hooks](hooks#readme) - adding before/after hooks
 
 ## Other Examples
 

examples/colors/README.md

@@ -13,9 +13,9 @@ $ bashly generate
 $ bashly generate
 ```
 
-The `bashly add colors` command, simply created the [src/lib/colors.sh]
-(src/lib/colors.sh) file, with useful color functions that will be
-automatically included in the generated script.
+The `bashly add colors` command, simply created the
+[src/lib/colors.sh](src/lib/colors.sh) file, with useful color functions that
+will be automatically included in the generated script.
 
 See the manually edited [src/root_command.sh](src/root_command.sh) for usage
 examples.

examples/hooks/.gitignore

@@ -0,0 +1 @@
+hooks

examples/hooks/README.md

@@ -0,0 +1,17 @@
+# Before/After Hooks Example
+
+This example demonstrates how to run common code before or after executing any
+command.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly add hooks
+$ bashly generate
+```
+
+<!-- include: src/root_command.sh -->
+
+-----

examples/hooks/src/after.sh

@@ -0,0 +1,7 @@
+## after hook
+##
+## Any code here will be placed inside an `after_hook()` function and called
+## after running any command.
+##
+## You can safely delete this file if you do not need it.
+echo "==[ After Hook Called ]=="

examples/hooks/src/bashly.yml

@@ -0,0 +1,8 @@
+name: hooks
+help: Sample application that uses before/after hooks
+version: 0.1.0
+
+flags:
+- long: --debug
+  short: -d
+  help: Enable debug mode

examples/hooks/src/before.sh

@@ -0,0 +1,8 @@
+## before hook
+##
+## Any code here will be placed inside a `before_hook()` function and called
+## before running any command (but after processing its arguments).
+##
+## You can safely delete this file if you do not need it.
+echo "==[ Before Hook Called ]=="
+inspect_args

examples/hooks/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 variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.

examples/hooks/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/hooks/test.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly add hooks --force
+bashly generate
+
+### Try Me ###
+
+./hooks
+./hooks --debug