- Add settings.yml as an alternative to environment variables

Author: DannyBen

Runfile

@@ -20,10 +20,14 @@ end
 help   "Run shellcheck on all examples"
 action :shellcheck do
   Example.executables.each do |example|
-    success = system "shellcheck #{example}"
-    color = success ? 'txtgrn' : 'txtred'
-    say "- shellcheck !#{color}!#{example}"
-    exit 1 unless success
+    if File.exist? example
+      success = system "shellcheck #{example}"
+      color = success ? 'txtgrn' : 'txtred'
+      say "- shellcheck !#{color}!#{example}"
+      exit 1 unless success
+    else
+      say "- skip       !txtcyn!#{example}"
+    end
   end
 end
 

examples/README.md

@@ -58,3 +58,4 @@ Each of these examples demonstrates one aspect or feature of bashly.
 ## Other Examples
 
 - [heredoc](heredoc#readme) - using heredoc strings
+- [settings](settings#readme) - using the settings.yml file to adjust bashly's behavior

examples/settings/.gitignore

@@ -0,0 +1,2 @@
+/src/*.sh
+/out/cli

examples/settings/README.md

@@ -0,0 +1,105 @@
+# Settings Example
+
+Demonstrates how to use the bashly `settings.yml` file to configure some 
+aspects of the script generation commands.
+
+This example was generated with:
+
+```bash
+$ bashly add settings
+# ... now edit settings.yml file to match the example ...
+$ bashly init
+$ bashly generate
+```
+
+<!-- include: settings.yml -->
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: cli
+help: Sample application
+version: 0.1.0
+
+environment_variables:
+- name: api_key
+  help: Set your API key
+
+commands:
+- name: download
+  short: d
+  help: Download a file
+
+  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:
+  - cli download example.com
+  - cli download example.com ./output -f
+
+  environment_variables:
+  - name: default_target_location
+    help: Set the default location to download to
+
+- name: upload
+  short: u
+  help: Upload a file
+  args:
+  - name: source
+    required: true
+    help: File to upload
+
+  flags:
+  - long: --user
+    short: -u
+    arg: user
+    help: Username to use for logging in
+    required: true
+  - long: --password
+    short: -p
+    arg: password
+    help: Password to use for logging in
+```
+
+## `settings.yml`
+
+```yaml
+target_dir: out
+strict: true
+
+```
+
+
+## Generated script output
+
+### `$ ./out/cli`
+
+```shell
+cli - Sample application
+
+Usage:
+  cli [command]
+  cli [command] --help | -h
+  cli --version | -v
+
+Commands:
+  download   Download a file
+  upload     Upload a file
+
+
+
+```
+
+
+

examples/settings/out/.keep

@@ -0,0 +1 @@
+me

examples/settings/settings.yml

@@ -0,0 +1,2 @@
+target_dir: out
+strict: true

examples/settings/src/bashly.yml

@@ -0,0 +1,51 @@
+name: cli
+help: Sample application
+version: 0.1.0
+
+environment_variables:
+- name: api_key
+  help: Set your API key
+
+commands:
+- name: download
+  short: d
+  help: Download a file
+
+  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:
+  - cli download example.com
+  - cli download example.com ./output -f
+
+  environment_variables:
+  - name: default_target_location
+    help: Set the default location to download to
+
+- name: upload
+  short: u
+  help: Upload a file
+  args:
+  - name: source
+    required: true
+    help: File to upload
+
+  flags:
+  - long: --user
+    short: -u
+    arg: user
+    help: Username to use for logging in
+    required: true
+  - long: --password
+    short: -p
+    arg: password
+    help: Password to use for logging in

examples/settings/test.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+rm -f ./src/*.sh
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./out/cli

lib/bashly/commands/add.rb

@@ -3,29 +3,31 @@ module Commands
     class Add < Base
       help "Add extra features and customization to your script"
 
-      usage "bashly add strings [--force]"
-      usage "bashly add lib [--force]"
-      usage "bashly add config [--force]"
       usage "bashly add colors [--force]"
-      usage "bashly add yaml [--force]"
-      usage "bashly add validations [--force]"
-      usage "bashly add test [--force]"
       usage "bashly add comp FORMAT [OUTPUT --force]"
+      usage "bashly add config [--force]"
+      usage "bashly add lib [--force]"
+      usage "bashly add settings [--force]"
+      usage "bashly add strings [--force]"
+      usage "bashly add test [--force]"
+      usage "bashly add validations [--force]"
+      usage "bashly add yaml [--force]"
       usage "bashly add (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
 
       param "FORMAT", "Output format, can be one of:\n  function : generate a function file to be included in your script.\n  script   : generate a standalone bash completions script.\n  yaml     : generate a yaml compatible with completely."
       param "OUTPUT", "For the 'comp function' command: Name of the generated function.\nFor the 'comp script' or 'comp yaml' commands: path to output file.\nIn all cases, this is optional and will have sensible defaults."
 
-      command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."
-      command "lib", "Create the additional lib directory for additional user scripts. All *.sh scripts in this folder will be included in the final bash script."
-      command "config", "Add standard functions for handling INI files to the lib directory."
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
-      command "yaml", "Add standard functions for reading YAML files to the lib directory."
-      command "validations", "Add argument validation functions to the lib directory."
-      command "test", "Add approval testing."
       command "comp", "Generate a bash completions script or function."
+      command "config", "Add standard functions for handling INI files to the lib directory."
+      command "lib", "Create the additional lib directory for additional user scripts. All *.sh scripts in this folder will be included in the final bash script."
+      command "settings", "Copy a sample settings.yml file to your project, allowing you to customize some bashly options."
+      command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."
+      command "test", "Add approval testing."
+      command "validations", "Add argument validation functions to the lib directory."
+      command "yaml", "Add standard functions for reading YAML files to the lib directory."
 
       example "bashly add strings --force"
       example "bashly add comp function"
@@ -34,45 +36,51 @@ class Add < Base
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_LIB_DIR", "The path to use for creating the library files, relative to the source dir [default: lib]"
 
-      def strings_command
-        add_lib 'strings'
+      attr_reader :skip_src_check
+
+      def colors_command
+        add_lib 'colors'
       end
 
-      def lib_command
-        add_lib 'lib'
+      def comp_command
+        format = args['FORMAT']
+        output = args['OUTPUT']
+
+        case format
+        when "script"   then add_lib 'completions_script', output
+        when "function" then add_lib 'completions', output
+        when "yaml"     then add_lib 'completions_yaml', output
+        else            raise Error, "Unrecognized format: #{format}"
+        end
       end
 
       def config_command
         add_lib 'config'
       end
 
-      def colors_command
-        add_lib 'colors'
+      def settings_command
+        @skip_src_check = true
+        add_lib 'settings'
       end
 
-      def yaml_command
-        add_lib 'yaml'
+      def strings_command
+        add_lib 'strings'
       end
 
-      def validations_command
-        add_lib 'validations'
+      def lib_command
+        add_lib 'lib'
       end
 
       def test_command
         add_lib 'test'
       end
 
-      def comp_command
-        format = args['FORMAT']
-        output = args['OUTPUT']
-
-        case format
-        when "script"   then add_lib 'completions_script', output
-        when "function" then add_lib 'completions', output
-        when "yaml"     then add_lib 'completions_yaml', output
-        else            raise Error, "Unrecognized format: #{format}"
-        end
+      def yaml_command
+        add_lib 'yaml'
+      end
 
+      def validations_command
+        add_lib 'validations'
       end
 
     private
@@ -89,7 +97,7 @@ def add_lib(name, *args)
       end
 
       def safe_write(path, content)
-        if !Dir.exist? Settings.source_dir
+        if !skip_src_check and !Dir.exist? Settings.source_dir
           raise InitError, "Directory !txtgrn!#{Settings.source_dir}!txtrst! does not exist\nRun !txtpur!bashly init!txtrst! first"
         end
 

lib/bashly/libraries.yml

@@ -3,21 +3,25 @@ colors:
     - source: "templates/lib/colors.sh"
       target: "%{user_lib_dir}/colors.sh"
 
+completions: :CompletionsFunction
+completions_script: :CompletionsScript
+completions_yaml: :CompletionsYAML
+
 config:
   files:
     - source: "templates/lib/config.sh"
       target: "%{user_lib_dir}/config.sh"
 
-yaml:
-  files:
-    - source: "templates/lib/yaml.sh"
-      target: "%{user_lib_dir}/yaml.sh"
-
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
       target: "%{user_lib_dir}/sample_function.sh"
 
+settings:
+  files:
+    - source: "templates/settings.yml"
+      target: "settings.yml"
+
 strings:
   files:
     - source: "templates/strings.yml"
@@ -37,7 +41,6 @@ test:
 
     Docs: !undblu!https://github.com/DannyBen/approvals.bash
 
-
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
@@ -49,6 +52,7 @@ validations:
     - source: "templates/lib/validations/validate_not_empty.sh"
       target: "%{user_lib_dir}/validations/validate_not_empty.sh"
 
-completions: :CompletionsFunction
-completions_script: :CompletionsScript
-completions_yaml: :CompletionsYAML
+yaml:
+  files:
+    - source: "templates/lib/yaml.sh"
+      target: "%{user_lib_dir}/yaml.sh"