Merge pull request #684 from bashly-framework/add/extra-lib-dirs

Add `Settings.extra_lib_dirs` to allow loading files from multiple locations

Author: DannyBen

examples/README.md

@@ -58,6 +58,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [command-paths](command-paths#readme) - configuring nested paths for your source scripts
 - [command-function](command-function#readme) - configuring custom internal function names
 - [split-config](split-config#readme) - splitting your `bashly.yml` into several smaller files
+- [multiple-lib-dirs](multiple-lib-dirs#readme) - loading libraries from multiple locations
 
 ## Bashly library features
 

examples/command-paths/README.md

@@ -79,7 +79,7 @@ commands:
 # The path to use for command files, relative to source_dir
 # When set to nil (~), command files will be placed directly under source_dir
 # When set to any other string, command files will be placed under this
-# directory, and each command will get its own subdirectory
+# directory, and each command will get its own sub-directory
 
 # commands_dir: ~
 commands_dir: commands

examples/command-paths/settings.yml

@@ -1,7 +1,7 @@
 # The path to use for command files, relative to source_dir
 # When set to nil (~), command files will be placed directly under source_dir
 # When set to any other string, command files will be placed under this
-# directory, and each command will get its own subdirectory
+# directory, and each command will get its own sub-directory
 
 # commands_dir: ~
 commands_dir: commands

examples/custom-includes/README.md

@@ -56,7 +56,7 @@ echo "After custom code"
 # Note that code here should be wrapped inside bash functions, and it is
 # recommended to have a separate file for each function.
 #
-# Subdirectories will also be scanned for *.sh, so you have no reason not
+# Sub-directories will also be scanned for *.sh, so you have no reason not
 # to organize your code neatly.
 #
 sample_function() {

examples/custom-includes/src/lib/sample_function.sh

@@ -5,7 +5,7 @@
 # Note that code here should be wrapped inside bash functions, and it is
 # recommended to have a separate file for each function.
 #
-# Subdirectories will also be scanned for *.sh, so you have no reason not
+# Sub-directories will also be scanned for *.sh, so you have no reason not
 # to organize your code neatly.
 #
 sample_function() {

examples/multiple-lib-dirs/.gitignore

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

examples/multiple-lib-dirs/README.md

@@ -0,0 +1,77 @@
+# Multiple Lib Dirs
+
+Demonstrates how to include more than one lib directories in the generated
+script.
+
+This example was generated with:
+
+```bash
+$ bashly init --minimal
+$ bashly add settings
+# ... now edit settings.yml to match the example ...
+$ bashly generate
+# ... now edit src/root_command.sh to match the example ...
+$ bashly generate
+```
+
+<!-- include: settings.yml src/root_command.sh -->
+
+-----
+
+## `bashly.yml`
+
+````yaml
+name: download
+help: Sample minimal application without commands
+version: 0.1.0
+
+args:
+- name: source
+  required: true
+  help: URL to download from
+- name: target
+  help: "Target filename (default: same as source)"
+
+flags:
+- long: --force
+  short: -f
+  help: Overwrite existing files
+
+examples:
+- download example.com
+- download example.com ./output -f
+````
+
+## `settings.yml`
+
+````yaml
+# An array or comma delimited string of additional directories to search for
+# bash functions. Any bash script found in any of these directories
+# (or sub-directories) will be merged into the final script.
+# Note that this is relative to the working directory.
+extra_lib_dirs: [common_lib, cloud_lib]
+
+````
+
+## `src/root_command.sh`
+
+````bash
+# Calling library functions
+common_function
+cloud_function
+````
+
+
+## Output
+
+### `$ ./download some_source`
+
+````shell
+common_function called
+cloud_function called
+
+
+````
+
+
+

examples/multiple-lib-dirs/cloud_lib/cloud_function.sh

@@ -0,0 +1,3 @@
+cloud_function() {
+  echo "cloud_function called"
+}

examples/multiple-lib-dirs/common_lib/common_function.sh

@@ -0,0 +1,3 @@
+common_function() {
+  echo "common_function called"
+}

examples/multiple-lib-dirs/settings.yml

@@ -0,0 +1,5 @@
+# An array or comma delimited string of additional directories to search for
+# bash functions. Any bash script found in any of these directories
+# (or sub-directories) will be merged into the final script.
+# Note that this is relative to the working directory.
+extra_lib_dirs: [common_lib, cloud_lib]