Add Settings.extra_lib_dirs to allow loading files from multiple locations

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]

examples/multiple-lib-dirs/src/bashly.yml

@@ -0,0 +1,19 @@
+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

examples/multiple-lib-dirs/src/root_command.sh

@@ -0,0 +1,3 @@
+# Calling library functions
+common_function
+cloud_function

examples/multiple-lib-dirs/test.sh

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

lib/bashly/libraries/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() {

lib/bashly/libraries/settings/settings.yml

@@ -53,10 +53,16 @@ target_dir: .
 # The path to use for common library files, relative to source_dir
 lib_dir: lib
 
+# 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: ~
+
 # 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: ~
 
 # The extension to use when reading/writing partial script snippets

lib/bashly/script/command.rb

@@ -153,7 +153,13 @@ def base_usage_pattern
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"]
+        @user_lib ||= begin
+          result = Settings.all_lib_dirs.map do |dir|
+            Dir["#{dir}/**/*.#{Settings.partials_extension}"]
+          end
+
+          result.flatten
+        end
       end
 
       # Returns a mixed array of Argument and Flag objects that have validations

lib/bashly/settings.rb

@@ -15,6 +15,7 @@ class << self
         :enable_inspect_args,
         :enable_sourcing,
         :enable_view_markers,
+        :extra_lib_dirs,
         :formatter,
         :function_names,
         :lib_dir,
@@ -107,6 +108,21 @@ def lib_dir
         @lib_dir ||= get :lib_dir
       end
 
+      def extra_lib_dirs
+        @extra_lib_dirs ||= begin
+          dirs = get :extra_lib_dirs
+          case dirs
+          when Array then dirs
+          when String then dirs.split(',').map(&:strip)
+          else []
+          end
+        end
+      end
+
+      def all_lib_dirs
+        @all_lib_dirs = [full_lib_dir] + extra_lib_dirs
+      end
+
       def partials_extension
         @partials_extension ||= get :partials_extension
       end

schemas/settings.json

@@ -66,6 +66,37 @@
       "minLength": 1,
       "default": "lib"
     },
+    "extra_lib_dirs": {
+      "title": "extra lib dirs",
+      "description": "One or more paths to use for common library files, relative to the working directory.\nMay be provided as an array or a comma delimited string.\nhttps://bashly.dev/usage/settings/#extra_lib_dirs",
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "string",
+          "minLength": 1,
+          "examples": [
+            "common, org_lib",
+            "lib"
+          ]
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "examples": [
+            [
+              "common",
+              "org_lib"
+            ]
+          ]
+        }
+      ],
+      "default": null
+    },
     "commands_dir": {
       "title": "commands dir",
       "description": "The path to use for command files, relative to source_dir\nhttps://bashly.dev/usage/settings/#commands_dir",

spec/approvals/examples/multiple-lib-dirs

@@ -0,0 +1,8 @@
++ bashly generate
+creating user files in src
+skipped src/root_command.sh (exists)
+created ./download
+run ./download --help to test your bash script
++ ./download some_source
+common_function called
+cloud_function called

spec/bashly/settings_spec.rb

@@ -103,6 +103,26 @@
     end
   end
 
+  describe '::extra_lib_dirs' do
+    context 'when set using env var as a comma delimited string' do
+      before { ENV['BASHLY_EXTRA_LIB_DIRS'] = 'one,two' }
+      after { ENV['BASHLY_EXTRA_LIB_DIRS'] = nil }
+
+      it 'converts comma delimited string to an array' do
+        expect(subject.extra_lib_dirs).to match_array %w[one two]
+      end
+    end
+
+    context 'when provided as an array' do
+      let(:config) { Config.new({ 'extra_lib_dirs' => %w[item1 item2] }) }
+
+      it 'returns the array as is' do
+        allow(subject).to receive(:user_settings).and_return(config)
+        expect(subject.extra_lib_dirs).to match_array %w[item1 item2]
+      end
+    end
+  end
+
   describe '::production?' do
     it 'returns false by default' do
       expect(subject.production?).to be false

support/schema/settings.yml

@@ -63,6 +63,27 @@ properties:
     type: string
     minLength: 1
     default: lib
+  extra_lib_dirs:
+    title: extra lib dirs
+    description: |-
+      One or more paths to use for common library files, relative to the working directory.
+      May be provided as an array or a comma delimited string.
+      https://bashly.dev/usage/settings/#extra_lib_dirs
+    oneOf:
+      - type: "null"
+      - type: string
+        minLength: 1
+        examples:
+        - "common, org_lib"
+        - "lib"
+      - type: array
+        items:
+          type: string
+          minLength: 1
+        examples:
+        - [common, org_lib]
+    default: null
+
   commands_dir:
     title: commands dir
     description: |-