add heredoc example, closes #211

Author: DannyBen

examples/README.md

@@ -47,6 +47,10 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [docker-like](docker-like#readme) - a sample script with deep commands (like `docker container run`)
 - [git-like](git-like#readme) - a sample script with sub-commands similar to git
 
+## Other Examples
+
+- [heredoc](heredoc#readme) - using heredoc strings
+
 ## Bashly library features
 
 - [config-ini](config-ini#readme) - using the config (INI) functions

examples/heredoc/.gitignore

@@ -0,0 +1 @@
+cli

examples/heredoc/README.md

@@ -0,0 +1,66 @@
+# Heredoc Example
+
+This example shows how (and where) you can use *Here document* (heredoc)
+constructs.
+
+Since bashly applies indentation to most of your code, it is not possible to 
+use heredoc everywhere. Code in the `src/lib` directory is injected to your
+script as is, so in cases where you must use heredocs, this is where you can.
+
+This example was generated with:
+
+```bash
+$ bashly init
+$ bashly add lib
+# ... now edit src/bashly.yml to match the example ...
+# ... now edit src/root_command.sh to match the example ...
+# ... now edit src/lib/heredocs.sh to match the example ...
+$ bashly generate
+```
+
+<!-- include: src/root_command.sh src/lib/heredocs.sh -->
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: cli
+help: Sample application showing the use of heredoc
+version: 0.1.0
+```
+
+## `src/root_command.sh`
+
+```bash
+echo "$(message1)"
+```
+
+## `src/lib/heredocs.sh`
+
+```bash
+message1() {
+  cat << EOF
+this is a
+  multiline
+    heredoc text
+EOF
+}
+
+```
+
+
+## Generated script output
+
+### `$ ./cli`
+
+```shell
+this is a
+  multiline
+    heredoc text
+
+
+```
+
+
+

examples/heredoc/src/bashly.yml

@@ -0,0 +1,3 @@
+name: cli
+help: Sample application showing the use of heredoc
+version: 0.1.0

examples/heredoc/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/heredoc/src/lib/heredocs.sh

@@ -0,0 +1,7 @@
+message1() {
+  cat << EOF
+this is a
+  multiline
+    heredoc text
+EOF
+}

examples/heredoc/src/root_command.sh

@@ -0,0 +1 @@
+echo "$(message1)"

examples/heredoc/test.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./cli

spec/approvals/examples/heredoc

@@ -0,0 +1,10 @@
++ bashly generate
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ ./cli
+this is a
+  multiline
+    heredoc text