bashly 0.8.6 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6be5a0594215515e99372cba7e1f6b0a6540429299166e9a2f420d14181af207
-  data.tar.gz: 91498eb6c640f0eb57f68aa974e876a69d624e9830402f10d11f5de874f6684c
+  metadata.gz: 4d91ebd35f74173621d545d29ff7ea404341638c7b06aa0610cb1ab10dfba93a
+  data.tar.gz: 81b1516fd118e2f985d5fd6b88cfa07db8f3b01eb91895d069587de26586bb1d
 SHA512:
-  metadata.gz: f77887a91b45dcba6422d48fc794cd8bc8c50243a6b04df3bd426aa90b837beb53b1a770adf903482a85ad60631c6515f21f6559045aa73475b9321d5432c13e
-  data.tar.gz: 8c05eba6921abcf365c6ab4df5f8632f7136749274708361dfb6dcf6e5a85b9b55c267d65adadb3ed77677fe9a94293a7259e86789e0a754c3ba461118c9701d
+  metadata.gz: f366a6add6ae9c750f07c219393f613dc381e7ade0f18e94fef716364fbcecdbcac7cb8f5cdaf2101ea2c2f0040dab72303e740d87508750f627b71e4dbca39f
+  data.tar.gz: 3327229305d123a6ea878846035fb4fbb0e33a6d7f6fd81ee3e203b1c89cd29d36cc36822908c31faa5fa97edba98a69db941fece386849aeafbdfef4cdea978

data/README.md

@@ -70,10 +70,12 @@ If you experience any issue, have a question or a suggestion, or if you wish
 to contribute, feel free to [open an issue][issues] or
 [start a discussion][discussions].
 
+Visit the *[How to contribute][contributing]* page for more information.
+
 
 
 [issues]: https://github.com/DannyBen/bashly/issues
 [discussions]: https://github.com/DannyBen/bashly/discussions
 [docs]: https://bashly.dannyb.co/
 [examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
-
+[contributing]: https://github.com/DannyBen/bashly/blob/master/CONTRIBUTING.md#how-to-contribute

data/lib/bashly/config_validator.rb

@@ -112,7 +112,7 @@ module Bashly
       assert_hash key, value, Script::Command.option_keys
 
       refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
-      refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
+      refute value['commands'] && value['catch_all'], "#{key} cannot have both commands and catch_all"
 
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
@@ -142,6 +142,10 @@ module Bashly
       assert_uniq "#{key}.flags", value['flags'], 'short'
       assert_uniq "#{key}.args", value['args'], 'name'
 
+      if value['default']
+        assert value['args'], "#{key}.default makes no sense without args"
+      end
+
       if value['catch_all'] and value['args']
         repeatable_arg = value['args'].select { |a| a['repeatable'] }.first&.dig 'name'
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"

data/lib/bashly/script/command.rb

@@ -177,6 +177,12 @@ module Bashly
         parents.any? ? (parents + [name]).join(' ') : name
       end
 
+      # Returns true if this command's flags should be considered as gloal
+      # flags, and cascade to subcommands
+      def global_flags?
+        flags.any? and commands.any?
+      end
+
       # Returns the string for the group caption
       def group_string
         if group
@@ -186,6 +192,19 @@ module Bashly
         end
       end
 
+      # Returns a mode identifier
+      def mode
+        @mode ||= begin
+          if global_flags?               then :global_flags
+          elsif commands.any?            then :commands
+          elsif args.any? and flags.any? then :args_and_flags
+          elsif args.any?                then :args
+          elsif flags.any?               then :flags
+          else                           :empty
+          end
+        end
+      end
+
       # Returns an array of all parents. For example, the command 
       # "docker container run" will have [docker, container] as its parents
       def parents
@@ -239,13 +258,23 @@ module Bashly
       # Returns a constructed string suitable for Usage pattern
       def usage_string
         result = [full_name]
-        result << "[command]" if commands.any?
-        args.each do |arg|
-          result << arg.usage_string
+
+        result.push case mode
+        when :global_flags    then ["[OPTIONS]", "COMMAND"]
+        when :commands        then ["COMMAND"]
+        when :args_and_flags  then usage_string_args + ["[OPTIONS]"]
+        when :args            then usage_string_args
+        when :flags           then ["[OPTIONS]"]
+        else                  nil
         end
-        result << "[options]" unless flags.empty?
-        result << catch_all.usage_string if catch_all.enabled?
-        result.join " "
+
+        result.push catch_all.usage_string if catch_all.enabled? && commands.empty?
+        result.compact.join " "
+      end
+
+      # Returns an array of args usage_string for the command's usage_string
+      def usage_string_args
+        args.map { |arg| arg.usage_string }
       end
 
       # Returns an array of files to include as is inside the script

data/lib/bashly/settings.rb

@@ -1,18 +1,21 @@
 module Bashly
   class Settings
     class << self
-      attr_writer :source_dir, :target_dir, :lib_dir, :strict, :tab_indent
+      include AssetHelper
+
+      attr_writer :compact_short_flags, :source_dir, :target_dir,
+        :lib_dir, :strict, :tab_indent
 
       def source_dir
-        @source_dir ||= get :source_dir, 'src'
+        @source_dir ||= get :source_dir
       end
 
       def target_dir
-        @target_dir ||= get :target_dir, '.'
+        @target_dir ||= get :target_dir
       end
 
       def lib_dir
-        @lib_dir ||= get :lib_dir, 'lib'
+        @lib_dir ||= get :lib_dir
       end
 
       def strict
@@ -23,8 +26,12 @@ module Bashly
         @tab_indent ||= get :tab_indent
       end
 
+      def compact_short_flags
+        @compact_short_flags ||= get :compact_short_flags
+      end
+
       def env
-        @env ||= get(:env, :development)&.to_sym
+        @env ||= get(:env)&.to_sym
       end
 
       def env=(value)
@@ -41,14 +48,33 @@ module Bashly
 
     private
 
-      def get(key, default = nil)
-        ENV["BASHLY_#{key.upcase}"] || user_settings[key.to_s] || default
+      def get(key)
+        case env_value key
+        when nil                 then config[key.to_s]
+        when "0", "false", "no"  then false
+        when "1", "true", "yes"  then true
+        else                     env_value key
+        end
+      end
+
+      def env_value(key)
+        ENV["BASHLY_#{key.upcase}"]
+      end
+
+      def config
+        @config ||= defsult_settings.merge user_settings
       end
 
       def user_settings
-        @user_settings ||= begin
-          File.exist?('settings.yml') ? Config.new('settings.yml') : {}
-        end
+        @user_settings ||= File.exist?('settings.yml') ? Config.new('settings.yml') : {}
+      end
+
+      def defsult_settings
+        @defsult_settings ||= Config.new(default_settings_path)
+      end
+
+      def default_settings_path
+        asset "templates/settings.yml"
       end
 
     end

data/lib/bashly/templates/settings.yml

@@ -1,6 +1,10 @@
 # All settings are optional (with their default values provided below), and
 # can also be set with an environment variable with the same name, capitalized
 # and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
+#
+# When setting environment variables, you can use:
+# - "0", "false" or "no" to represent false
+# - "1", "true" or "yes" to represent true
 
 # The path containing the bashly configuration and source files
 source_dir: src
@@ -18,6 +22,10 @@ strict: false
 # (every 2 leading spaces will be converted to a tab character)
 tab_indent: false
 
+# 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
+
 # Set to 'production' or 'development':
 # - production    generate a smaller script, without file markers
 # - development   generate with file markers

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.8.6"
+  VERSION = "0.8.8"
 end

data/lib/bashly/views/argument/validations.gtx

@@ -3,7 +3,7 @@ if validate
 = view_marker
 
 > if [[ -n $(validate_{{ validate }} "$1") ]]; then
->   printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$(validate_{{ validate }} "$1")"
+>   printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$(validate_{{ validate }} "$1")" >&2
 >   exit 1
 > fi
 > 

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

@@ -2,7 +2,7 @@ if catch_all.required?
   = view_marker
 
   > if [[ ${#other_args[@]} -eq 0 ]]; then
-  >   printf "{{ strings[:missing_required_argument] % { arg: catch_all.label, usage: usage_string } }}\n"
+  >   printf "{{ strings[:missing_required_argument] % { arg: catch_all.label, usage: usage_string } }}\n" >&2
   >   exit 1
   > fi
   >

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

@@ -1,7 +1,7 @@
 = view_marker
 
 > "" )
->   {{ function_name }}_usage
+>   {{ function_name }}_usage >&2
 >   exit 1
 >   ;;
 >
@@ -18,7 +18,7 @@ elsif extensible.is_a? String
   >   if [[ -x "$(command -v "{{ extensible }}")" ]]; then
   >     exec {{ extensible }} "$@"
   >   else
-  >     printf "{{ strings[:invalid_command] }}\n" "$action"
+  >     printf "{{ strings[:invalid_command] }}\n" "$action" >&2
   >     exit 1
   >   fi
   >
@@ -28,13 +28,13 @@ elsif extensible
   >     shift
   >     exec "{{ function_name }}-$action" "$@"
   >   else
-  >     printf "{{ strings[:invalid_command] }}\n" "$action"
+  >     printf "{{ strings[:invalid_command] }}\n" "$action" >&2
   >     exit 1
   >   fi
   >
 
 else
-  >   printf "{{ strings[:invalid_command] }}\n" "$action"
+  >   printf "{{ strings[:invalid_command] }}\n" "$action" >&2
   >   exit 1
   >   ;;
   >

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

@@ -3,7 +3,7 @@ if dependencies
 
   dependencies.each do |dependency|
     > if ! [[ -x "$(command -v {{ dependency }})" ]]; then
-    >   printf "{{ strings[:missing_dependency] % { dependency: dependency } }}\n"
+    >   printf "{{ strings[:missing_dependency] % { dependency: dependency } }}\n" >&2
     >   exit 1
     > fi
   end

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

@@ -0,0 +1,7 @@
+if default_environment_variables.any?
+  = view_marker 
+
+  default_environment_variables.each do |env_var|
+    > export {{ env_var.name.upcase }}="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
+  end
+end

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

@@ -1,16 +1,11 @@
 if default_environment_variables.any? or required_environment_variables.any?
   = view_marker 
-
-  if default_environment_variables.any?
-    default_environment_variables.each do |env_var|
-      > export {{ env_var.name.upcase }}="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
-    end
-  end
+  = render(:environment_variables_default)
 
   if required_environment_variables.any?
     required_environment_variables.each do |env_var|
       > if [[ -z "${<%= env_var.name.upcase %>:-}" ]]; then
-      >   printf "{{ strings[:missing_required_environment_variable] % { var: env_var.name.upcase } }}\n"
+      >   printf "{{ strings[:missing_required_environment_variable] % { var: env_var.name.upcase } }}\n" >&2
       >   exit 1
       > fi
     end

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

@@ -16,5 +16,12 @@ end
 >   exit
 >   ;;
 > 
+
+if global_flags?
+  flags.each do |flag|
+    = flag.render(:case)
+  end
+end
+
 > esac
 >

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

@@ -6,6 +6,10 @@
 >   {{ Settings.strict ? "set -euo pipefail" : "set -e" }}
 > 
 
+if root_command?
+  = render(:environment_variables_default).indent 2
+end
+
 = load_user_file("initialize.sh", placeholder: false).indent 2
 
 > }

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

@@ -11,11 +11,15 @@
 >     elif [[ $arg =~ ^(-[a-zA-Z0-9])=(.+)$ ]]; then
 >       input+=("${BASH_REMATCH[1]}")
 >       input+=("${BASH_REMATCH[2]}")
+
+if Settings.compact_short_flags
 >     elif [[ $arg =~ ^-([a-zA-Z0-9][a-zA-Z0-9]+)$ ]]; then
 >       flags="${BASH_REMATCH[1]}"
 >       for (( i=0 ; i < ${#flags} ; i++ )); do
 >         input+=("-${flags:i:1}")
 >       done
+end
+
 >     else
 >       input+=("$arg")
 >     fi

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

@@ -12,12 +12,12 @@ if args.any?
   end
 
   > else
-  >   printf "{{ strings[:invalid_argument] }}\n" "$key"
+  >   printf "{{ strings[:invalid_argument] }}\n" "$key" >&2
   >   exit 1
   > fi
 
 else
-  > printf "{{ strings[:invalid_argument] }}\n" "$key"
+  > printf "{{ strings[:invalid_argument] }}\n" "$key" >&2
   > exit 1
 
 end

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

@@ -4,8 +4,10 @@
 >   key="$1"
 >   case "$key" in
 
-flags.each do |flag|
-  = flag.render(:case).indent 2
+unless global_flags?
+  flags.each do |flag|
+    = flag.render(:case).indent 2
+  end
 end
 
 >
@@ -17,7 +19,7 @@ if catch_all.enabled?
   >     ;;
 
 else
-  >     printf "<%= strings[:invalid_flag] %>\n" "$key"
+  >     printf "<%= strings[:invalid_flag] %>\n" "$key" >&2
   >     exit 1
   >     ;;
 

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

@@ -3,7 +3,7 @@ if required_args.any?
 
   required_args.each do |arg|
     > if [[ -z ${args[{{ arg.name }}]+x} ]]; then
-    >   printf "{{ strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } }}\n"
+    >   printf "{{ strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } }}\n" >&2
     >   exit 1
     > fi
   end

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

@@ -3,7 +3,7 @@ if required_flags.any?
 
   required_flags.each do |flag|
     > if [[ -z ${args[{{ flag.long }}]+x} ]]; then
-    >   printf "{{ strings[:missing_required_flag] % { usage: flag.usage_string } }}\n"
+    >   printf "{{ strings[:missing_required_flag] % { usage: flag.usage_string } }}\n" >&2
     >   exit 1
     > fi
   end

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

@@ -29,7 +29,7 @@ end
 >   printf "  {{ usage_string }}\n"
 
 if commands.any?
-  >   printf "  {{ full_name }} [command] --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
+  >   printf "  {{ full_name }} [COMMAND] --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
 else
   >   printf "  {{ full_name }} --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
 end

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

@@ -5,7 +5,7 @@ if filters
   filters.each do |filter|
     > filter_error=$(filter_{{ filter }})
     > if [[ -n $filter_error ]]; then
-    >   echo "$filter_error"
+    >   echo "$filter_error" >&2
     >   exit 1
     > fi
     > 

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

@@ -6,14 +6,14 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > eval "input_array=(${args[{{ arg.name }}]})"
       > for i in "${input_array[@]}"; do
       >   if [[ ! $i =~ ^({{ arg.allowed.join '|' }})$ ]]; then
-      >     printf "%s\n" "{{ strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } }}"
+      >     printf "%s\n" "{{ strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } }}" >&2
       >     exit 1
       >   fi
       > done
 
     else
       > if [[ ! ${args[{{ arg.name }}]} =~ ^({{ arg.allowed.join '|' }})$ ]]; then
-      >   printf "%s\n" "{{ strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } }}"
+      >   printf "%s\n" "{{ strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi
 
@@ -25,14 +25,14 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > eval "input_array=(${args[{{ flag.name }}]})"
       > for i in "${input_array[@]}"; do
       >   if [[ ! $i =~ ^({{ flag.allowed.join '|' }})$ ]]; then
-      >     printf "%s\n" "{{ strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } }}"
+      >     printf "%s\n" "{{ strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } }}" >&2
       >     exit 1
       >   fi
       > done
     
     else
       > if [[ ! ${args[{{ flag.name }}]} =~ ^({{ flag.allowed.join '|' }})$ ]]; then
-      >   printf "%s\n" "{{ strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } }}"
+      >   printf "%s\n" "{{ strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi
 

data/lib/bashly/views/flag/case_arg.gtx

@@ -18,7 +18,7 @@ end
 >   shift
 >   shift
 > else
->   printf "%s\n" "{{ strings[:flag_requires_an_argument] % { name: name, usage: usage_string } }}"
+>   printf "%s\n" "{{ strings[:flag_requires_an_argument] % { name: name, usage: usage_string } }}" >&2
 >   exit 1
 > fi
 > ;;

data/lib/bashly/views/flag/conflicts.gtx

@@ -4,7 +4,7 @@ if conflicts
   
   if conflicts.count == 1
     > if [[ -n "${args[{{ conflicts.first }}]:-}" ]]; then
-    >   printf "{{ strings[:conflicting_flags] }}\n" "$key" "{{ conflicts.first }}"
+    >   printf "{{ strings[:conflicting_flags] }}\n" "$key" "{{ conflicts.first }}" >&2
     >   exit 1
     > fi
     >
@@ -12,7 +12,7 @@ if conflicts
   else
     > for conflict in {{ conflicts.join ' ' }}; do
     >   if [[ -n "${args[$conflict]:-}" ]]; then
-    >     printf "{{ strings[:conflicting_flags] }}\n" "$key" "$conflict"
+    >     printf "{{ strings[:conflicting_flags] }}\n" "$key" "$conflict" >&2
     >     exit 1
     >   fi
     > done

data/lib/bashly/views/flag/validations.gtx

@@ -3,7 +3,7 @@ if validate
   = view_marker
 
   > if [[ -n $(validate_{{ validate }} "$2") ]]; then
-  >   printf "{{ strings[:validation_error] }}\n" "{{ usage_string }}" "$(validate_{{ validate }} "$2")"
+  >   printf "{{ strings[:validation_error] }}\n" "{{ usage_string }}" "$(validate_{{ validate }} "$2")" >&2
   >   exit 1
   > fi
   > 

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

@@ -1,7 +1,7 @@
 = view_marker
 
 > if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
->   printf "{{ strings[:unsupported_bash_version] }}\n"
+>   printf "{{ strings[:unsupported_bash_version] }}\n" >&2
 >   exit 1
 > fi
 > 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: completely
@@ -167,6 +167,7 @@ files:
 - 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
 - lib/bashly/views/command/environment_variables_filter.gtx
 - lib/bashly/views/command/fixed_flags_filter.gtx
 - lib/bashly/views/command/footer.gtx