bashly 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99f485c3101793ea955bdf125a42278f0e3a81af69e6cf9e4f51e07c4179ce04
-  data.tar.gz: ca309bd6179a11a15423ee6e442e587321347e5142706ce66c5861e22e3394a8
+  metadata.gz: fa7187087fc2f921c6631e901db4a6a1e4af476e870bd272b4fa11c1f6650a29
+  data.tar.gz: 33dc09b9df4a807cb1fdae1538eced45214e5d029f25b8ed4ca40c2760210fb8
 SHA512:
-  metadata.gz: fc5a0d81b08eef9c029c88fa6bb118c1f9e8154e52e86f113c8d2ae74c170f768fb48d310128df64b67c00e4c66855886ca1d57635c82118ff5c4737d1eaea29
-  data.tar.gz: 61c451a16352dd7b3ba28fcb6f2209b980eb5ff416d8656f3b0db802e0e5cea2b20334102e2a73eefc6f2e06b72059e1dfae80deaeee106484fc6e558d79fb48
+  metadata.gz: 44d91f1ab44daa047bf40d2a22c4e422cdba92d884bfb27bed4e6749156b66fdd6fd54465a64f72a3c18bf5fa691daca3d60ead18b91e22e94096c38f655dbed
+  data.tar.gz: 00d6f327d759e79ec2856858f3f3a8db16ce91fa0eaa87d1336870b1ae3e776d70069d33c4dc2c6afe8c0544fadadd7401111463fde0f69ac6f6c507ae537289

data/lib/bashly/cli.rb

@@ -9,15 +9,15 @@ module Bashly
         header: 'Bashly - Bash CLI Generator',
         footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dannyb.co`"
 
-      runner.route 'init',        to: Commands::Init
-      runner.route 'preview',     to: Commands::Preview
-      runner.route 'validate',    to: Commands::Validate
-      runner.route 'generate',    to: Commands::Generate
-      runner.route 'add',         to: Commands::Add
-      runner.route 'doc',         to: Commands::Doc
-      runner.route 'completions', to: Commands::Completions
-      runner.route 'render',      to: Commands::Render
-      runner.route 'shell',       to: Commands::Shell unless ENV['BASHLY_SHELL']
+      runner.route 'init',             to: Commands::Init
+      runner.route 'preview',          to: Commands::Preview
+      runner.route 'validate',         to: Commands::Validate
+      runner.route %w[generate build], to: Commands::Generate
+      runner.route 'add',              to: Commands::Add
+      runner.route 'doc',              to: Commands::Doc
+      runner.route 'completions',      to: Commands::Completions
+      runner.route 'render',           to: Commands::Render
+      runner.route 'shell',            to: Commands::Shell unless ENV['BASHLY_SHELL']
 
       runner
     end

data/lib/bashly/commands/generate.rb

@@ -3,7 +3,8 @@ require 'filewatcher'
 module Bashly
   module Commands
     class Generate < Base
-      help 'Generate the bash script and required files'
+      summary "Generate the bash script and required files"
+      help "This command is also aliased as 'build'"
 
       usage 'bashly generate [options]'
       usage 'bashly generate (-h|--help)'
@@ -22,6 +23,7 @@ module Bashly
 
       example 'bashly generate --force'
       example 'bashly generate --wrap my_function'
+      example 'bashly build --watch --env production'
       example 'bashly g -uw'
 
       attr_reader :watching
@@ -131,7 +133,7 @@ module Bashly
       end
 
       def create_root_command_file
-        create_file "#{Settings.source_dir}/#{command.filename}", command.render(:default_root_script)
+        create_file "#{Settings.source_dir}/#{command.filename}", command.render(:default_script)
       end
 
       def create_all_command_files

data/lib/bashly/concerns/renderable.rb

@@ -16,7 +16,7 @@ module Bashly
     # Outputs a comment that describes the view unless in production mode
     def view_marker(id = nil)
       id ||= ":#{caller_locations(1..1).first.path}"
-      "# #{id}" unless Settings.production?
+      "# #{id}" if Settings.enabled? :view_markers
     end
 
     # Reads a file from the userspace (Settings.source_dir) and returns
@@ -32,7 +32,7 @@ module Bashly
         ''
       end
 
-      Settings.production? ? content : "#{view_marker path}\n#{content}"
+      Settings.enabled?(:view_markers) ? "#{view_marker path}\n#{content}" : content
     end
 
     # Returns a path to a file in the user's source_dir. The file argument

data/lib/bashly/libraries/settings/settings.yml

@@ -9,6 +9,11 @@
 # If you wish to change the path to this file, set the environment variable
 # BASHLY_SETTINGS_PATH.
 
+
+#-------------------------------------------------------------------------------
+# PATH OPTIONS
+#-------------------------------------------------------------------------------
+
 # The path containing the bashly source files
 source_dir: src
 
@@ -27,6 +32,14 @@ lib_dir: lib
 # directory, and each command will get its own subdirectory
 commands_dir: ~
 
+# The extension to use when reading/writing partial script snippets
+partials_extension: sh
+
+
+#-------------------------------------------------------------------------------
+# FORMAT OPTIONS
+#-------------------------------------------------------------------------------
+
 # Configure the bash options that will be added to the initialize function:
 # strict: true       Bash strict mode (set -euo pipefail)
 # strict: false      Only exit on errors (set -e)
@@ -38,6 +51,11 @@ strict: false
 # (every 2 leading spaces will be converted to a tab character)
 tab_indent: false
 
+
+#-------------------------------------------------------------------------------
+# INTERFACE OPTIONS
+#-------------------------------------------------------------------------------
+
 # When true, the generated script will consider any argument in the form of
 # `-abc` as if it is `-a -b -c`.
 compact_short_flags: true
@@ -47,14 +65,6 @@ compact_short_flags: true
 # respectively.
 conjoined_flag_args: true
 
-# Set to 'production' or 'development':
-# env: production    Generate a smaller script, without file markers
-# env: development   Generate with file markers
-env: development
-
-# The extension to use when reading/writing partial script snippets
-partials_extension: sh
-
 # Show command examples (if any) whenever the user does not provide the
 # required arguments
 show_examples_on_error: false
@@ -75,3 +85,43 @@ usage_colors:
   arg: ~
   flag: ~
   environment_variable: ~
+
+
+#-------------------------------------------------------------------------------
+# FEATURE TOGGLES
+#-------------------------------------------------------------------------------
+
+# Set to 'production' or 'development'.
+# Determines which features are enabled in the rendered script.
+# Use the `enable_*` options below to adjust settings for each environment.
+# It is recommended to leave this set to 'development' and run
+# `bashly generate --production` when the slimmer production script is needed.
+env: development
+
+# Tweak the script output by enabling or disabling some script output.
+# These options accept one of the following strings:
+# - production      render this feature only when env == production
+# - development     render this feature only when env == development
+# - always          render this feature in any environment
+# - never           do not render this feature
+enable_header_comment: always
+enable_bash3_bouncer: always
+enable_view_markers: development
+enable_inspect_args: development
+enable_deps_array: always
+enable_env_var_names_array: always
+
+
+#-------------------------------------------------------------------------------
+# SCRIPTING OPTIONS
+#-------------------------------------------------------------------------------
+
+# These are the public global variables available for use in your partial
+# scripts. Adding a new name here will create a reference variable using
+# `declare -gn`, allowing you to access the original variable under the new
+# name in addition to its original name.
+var_aliases:
+  args: ~
+  other_args: ~
+  deps: ~
+  env_var_names: ~

data/lib/bashly/script/dependency.rb

@@ -1,6 +1,6 @@
 module Bashly
   module Script
-    class Dependency
+    class Dependency < Base
       attr_reader :label, :commands, :help
 
       class << self

data/lib/bashly/script/introspection/commands.rb

@@ -2,6 +2,11 @@ module Bashly
   module Script
     module Introspection
       module Commands
+        # Returns true if the command or any of its descendants has `catch_all`
+        def catch_all_used_anywhere?
+          deep_commands(include_self: true).any? { |x| x.catch_all.enabled? }
+        end
+
         # Returns a full list of the Command names and aliases combined
         def command_aliases
           commands.map(&:aliases).flatten

data/lib/bashly/script/wrapper.rb

@@ -40,7 +40,7 @@ module Bashly
 
       def default_header
         result = render 'header'
-        result += render('bash3_bouncer') unless function_name
+        result += render('bash3_bouncer') unless function_name || !Settings.enabled?(:bash3_bouncer)
         result
       end
 

data/lib/bashly/settings.rb

@@ -8,6 +8,12 @@ module Bashly
         :compact_short_flags,
         :conjoined_flag_args,
         :config_path,
+        :enable_bash3_bouncer,
+        :enable_deps_array,
+        :enable_env_var_names_array,
+        :enable_header_comment,
+        :enable_inspect_args,
+        :enable_view_markers,
         :lib_dir,
         :partials_extension,
         :private_reveal_key,
@@ -16,7 +22,8 @@ module Bashly
         :strict,
         :tab_indent,
         :target_dir,
-        :usage_colors
+        :usage_colors,
+        :var_aliases
       )
 
       def commands_dir
@@ -35,6 +42,36 @@ module Bashly
         @config_path ||= get(:config_path) % { source_dir: source_dir }
       end
 
+      def enabled?(feature)
+        send(:"enable_#{feature}") == 'always' ||
+          (send(:"enable_#{feature}") == 'production' && production?) ||
+          (send(:"enable_#{feature}") == 'development' && !production?)
+      end
+
+      def enable_header_comment
+        @enable_header_comment ||= get :enable_header_comment
+      end
+
+      def enable_bash3_bouncer
+        @enable_bash3_bouncer ||= get :enable_bash3_bouncer
+      end
+
+      def enable_view_markers
+        @enable_view_markers ||= get :enable_view_markers
+      end
+
+      def enable_inspect_args
+        @enable_inspect_args ||= get :enable_inspect_args
+      end
+
+      def enable_deps_array
+        @enable_deps_array ||= get :enable_deps_array
+      end
+
+      def enable_env_var_names_array
+        @enable_env_var_names_array ||= get :enable_env_var_names_array
+      end
+
       def env
         @env ||= get(:env)&.to_sym
       end
@@ -97,6 +134,10 @@ module Bashly
         @usage_colors ||= get :usage_colors
       end
 
+      def var_aliases
+        @var_aliases ||= get :var_aliases
+      end
+
     private
 
       def get(key)

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.2.6'
+  VERSION = '1.2.7'
 end

data/lib/bashly/views/command/default_script.gtx

@@ -1,5 +1,8 @@
-> echo "# this file is located in '{{ "#{Settings.source_dir}/#{filename}" }}'"
-> echo "# code for '{{ full_name }}' goes here"
-> echo "# you can edit it freely and regenerate (it will not be overwritten)"
-> inspect_args
+> echo "# This file is located at '{{ "#{Settings.source_dir}/#{filename}" }}'."
+> echo "# It contains the implementation for the '{{ full_name }}' command."
+> echo "# The code you write here will be wrapped by a function named '{{ function_name }}_command()'."
+> echo "# Feel free to edit this file; your changes will persist when regenerating."
+if Settings.enabled? :inspect_args
+  > inspect_args
+end
 >

data/lib/bashly/views/command/dependencies_filter.gtx

@@ -1,16 +1,12 @@
 if dependencies.any?
   = view_marker
 
+  > missing_deps=
   dependencies.each do |dependency|
-    > if command -v {{ dependency.commands.join(' ') }} >/dev/null 2>&1; then
-    >   deps['{{ dependency.label }}']="$(command -v {{ dependency.commands.join(' ') }} | head -n1)"
-    > else
-    >   printf "{{ strings[:missing_dependency] % { dependency: dependency.name } }}\n" >&2
-    if dependency.help
-      >   printf "%s\n" "{{ dependency.help.sanitize_for_print }}" >&2
-    end
-    >   exit 1
-    > fi
-    >
+    = dependency.render :filter
   end
+
+  > if [[ -n $missing_deps ]]; then
+  >   exit 1
+  > fi
 end

data/lib/bashly/views/command/environment_variables_filter.gtx

@@ -2,8 +2,10 @@ if environment_variables.any?
   = view_marker
   = render(:environment_variables_default)
 
-  environment_variables.each do |env_var|
-    > env_var_names+=("{{ env_var.name.upcase }}")
+  if Settings.enabled? :env_var_names_array
+    environment_variables.each do |env_var|
+      > env_var_names+=("{{ env_var.name.upcase }}")
+    end
   end
 end
 

data/lib/bashly/views/command/globals.gtx

@@ -0,0 +1,29 @@
+= view_marker
+
+> declare -g -A args=()
+
+if catch_all_used_anywhere?
+  > declare -g -a other_args=()
+end
+
+if Settings.enabled? :deps_array
+  > declare -g -A deps=()
+end
+
+if Settings.enabled? :env_var_names_array
+  > declare -g -a env_var_names=()
+end
+
+> declare -g -a input=()
+
+if has_unique_args_or_flags?
+  > declare -g -A unique_lookup=()
+end
+
+>
+Settings.var_aliases.each do |original, refname|
+  if refname
+    > declare -gn {{ refname }}={{ original }}
+  end
+end
+>

data/lib/bashly/views/command/initialize.gtx

@@ -11,6 +11,8 @@ if root_command?
   = render(:environment_variables_default).indent 2
 end
 
+= render(:globals).indent(2)
+
 if user_file_exist?('initialize')
   > 
   = load_user_file('initialize').indent 2

data/lib/bashly/views/command/inspect_args.gtx

@@ -11,6 +11,8 @@
 >     echo args: none
 >   fi
 > 
+
+if catch_all_used_anywhere?
 >   if ((${#other_args[@]})); then
 >     echo
 >     echo other_args:
@@ -20,22 +22,29 @@
 >     done
 >   fi
 >
->   if ((${#deps[@]})); then
->     readarray -t sorted_keys < <(printf '%s\n' "${!deps[@]}" | sort)
->     echo
->     echo deps:
->     for k in "${sorted_keys[@]}"; do
->       echo "- \${deps[$k]} = ${deps[$k]}"
->     done
->   fi
->
->   if ((${#env_var_names[@]})); then
->     readarray -t sorted_names < <(printf '%s\n' "${env_var_names[@]}" | sort)
->     echo
->     echo "environment variables:"
->     for k in "${sorted_names[@]}"; do
->       echo "- \$$k = ${!k:-}"
->     done
->   fi
+end
+
+if Settings.enabled? :deps_array
+  >   if ((${#deps[@]})); then
+  >     readarray -t sorted_keys < <(printf '%s\n' "${!deps[@]}" | sort)
+  >     echo
+  >     echo deps:
+  >     for k in "${sorted_keys[@]}"; do
+  >       echo "- \${deps[$k]} = ${deps[$k]}"
+  >     done
+  >   fi
+  >
+end
+
+if Settings.enabled? :env_var_names_array
+  >   if ((${#env_var_names[@]})); then
+  >     readarray -t sorted_names < <(printf '%s\n' "${env_var_names[@]}" | sort)
+  >     echo
+  >     echo "environment variables:"
+  >     for k in "${sorted_names[@]}"; do
+  >       echo "- \$$k = ${!k:-}"
+  >     done
+  >   fi
+end
 > }
 > 

data/lib/bashly/views/command/master_script.gtx

@@ -4,7 +4,7 @@
 = render :version_command
 = render :usage
 = render :normalize_input
-= render :inspect_args unless Settings.production?
+= render :inspect_args if Settings.enabled? :inspect_args
 = render :user_lib if user_lib.any?
 = render :command_functions
 = render :parse_requirements

data/lib/bashly/views/command/parse_requirements_while.gtx

@@ -40,4 +40,4 @@ end
 > 
 >   esac
 > done
-
+>

data/lib/bashly/views/command/required_args_filter.gtx

@@ -7,7 +7,8 @@ if required_args.any?
     = render(:examples_on_error).indent 2
     >   exit 1
     > fi
+    >
   end
 
   >
-end
+end

data/lib/bashly/views/command/run.gtx

@@ -1,22 +1,15 @@
 = view_marker
 
 > run() {
->   declare -g -A args=()
->   declare -g -A deps=()
->   declare -g -a other_args=()
->   declare -g -a env_var_names=()
->   declare -g -a input=()
-if has_unique_args_or_flags?
-  >   declare -g -A unique_lookup=()
-end
 >   normalize_input "$@"
 >   parse_requirements "${input[@]}"
+
 if user_file_exist?('before')
   >   before_hook
 end
+
 > 
 >   case "$action" in
-
 deep_commands.each do |command|
   >     "{{ command.action_name }}") {{ command.function_name }}_command ;;
 end

data/lib/bashly/views/dependency/filter.gtx

@@ -0,0 +1,14 @@
+= view_marker
+
+> if ! command -v {{ commands.join(' ') }} >/dev/null 2>&1; then
+>   printf "{{ strings[:missing_dependency] % { dependency: name } }}\n" >&2
+if help
+  >   printf "%s\n\n" "{{ help.sanitize_for_print }}" >&2
+end
+>   missing_deps=1
+if Settings.enabled? :deps_array
+  > else
+  >   deps['{{ label }}']="$(command -v {{ commands.join(' ') }} | head -n1)"
+end
+> fi
+>

data/lib/bashly/views/wrapper/header.gtx

@@ -1,5 +1,7 @@
 > #!/usr/bin/env bash
-> # This script was generated by bashly {{ Bashly::VERSION }} (https://bashly.dannyb.co)
-> # Modifying it manually is not recommended
+if Settings.enabled? :header_comment
+  > # This script was generated by bashly {{ Bashly::VERSION }} (https://bashly.dannyb.co)
+  > # Modifying it manually is not recommended
+end
 > 
 >

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -34,16 +34,22 @@ dependencies:
   name: completely
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: filewatcher
   requirement: !ruby/object:Gem::Requirement
@@ -64,70 +70,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: lp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: requires
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: tty-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -168,26 +174,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -299,7 +285,6 @@ files:
 - lib/bashly/views/command/command_filter.gtx
 - lib/bashly/views/command/command_functions.gtx
 - lib/bashly/views/command/default_assignments.gtx
-- lib/bashly/views/command/default_root_script.gtx
 - lib/bashly/views/command/default_script.gtx
 - lib/bashly/views/command/dependencies_filter.gtx
 - lib/bashly/views/command/environment_variables_default.gtx
@@ -308,6 +293,7 @@ files:
 - lib/bashly/views/command/fixed_flags_filter.gtx
 - lib/bashly/views/command/footer.gtx
 - lib/bashly/views/command/function.gtx
+- lib/bashly/views/command/globals.gtx
 - lib/bashly/views/command/initialize.gtx
 - lib/bashly/views/command/inspect_args.gtx
 - lib/bashly/views/command/long_usage.gtx
@@ -340,6 +326,7 @@ files:
 - lib/bashly/views/command/variables.gtx
 - lib/bashly/views/command/version_command.gtx
 - lib/bashly/views/command/whitelist_filter.gtx
+- lib/bashly/views/dependency/filter.gtx
 - lib/bashly/views/environment_variable/usage.gtx
 - lib/bashly/views/environment_variable/validations.gtx
 - lib/bashly/views/flag/case.gtx
@@ -377,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Bash Command Line Tool Generator

data/lib/bashly/views/command/default_root_script.gtx

@@ -1,4 +0,0 @@
-> echo "# this file is located in '{{ "#{Settings.source_dir}/#{filename}" }}'"
-> echo "# you can edit it freely and regenerate (it will not be overwritten)"
-> inspect_args
->