bashly 1.3.3 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d80ba9b8ae35371153a3610de0d3d76e64a7a18e3fcc3500c112634b38ec13e
-  data.tar.gz: 908bd0775b5568471da0fe0b113fcddfefa1d1063ecafdd12019eacae8392e3d
+  metadata.gz: 429df4c59ef5a1dc0f1f9e332ab0b32b702fe5b83124c5ab04d784ef7d82bbc2
+  data.tar.gz: fdef11f71141111dea60129f9a9b855c669129010f5ec6e046fc0cdfafd9907f
 SHA512:
-  metadata.gz: f11a315e7d68230adedb9b73916619b30893871711cb5716f119b53621813eae23ac9c72a76248d13349924343cc3e77834f0b12c3699130309ecd0c0b9b699d
-  data.tar.gz: 3a19eada91503c3535b47643e18bb43b4c04d5548f5f18aac0195b8b14f3e18fb548f60a81cccf59d76ed714f8684dcdc9eec3a413b73b1e63d71d8c2d4cf875
+  metadata.gz: 17dcbf38797ebdd77898a53e09271cf7e0522c53af2f223910edc205f02d6ccd254eb4bcd11307f76656f14edaef253472efe0a9f699b9490f2ed3ef90746c85
+  data.tar.gz: 347ec4aebc9be7dcbcaef970db0465edf422b828361d3a37cfaa09337c372a1940a611b24a190af81dbb9857feeb8acc9c2d5662a39eac54df1f4504129c3424

data/README.md

@@ -27,6 +27,7 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
 
 - [Bashly Homepage][docs]
 - [Examples][examples]
+- [Bashly AI Assistant][gpt]
 
 ## How it works
 
@@ -73,5 +74,6 @@ Visit the *[How to contribute][contributing]* page for more information.
 [issues]: https://github.com/bashly-framework/bashly/issues
 [discussions]: https://github.com/bashly-framework/bashly/discussions
 [docs]: https://bashly.dev/
+[gpt]: https://bashly.dev/chat
 [examples]: https://github.com/bashly-framework/bashly/tree/master/examples#bashly-examples
 [contributing]: https://github.com/bashly-framework/bashly/blob/master/CONTRIBUTING.md#how-to-contribute

data/lib/bashly/concerns/renderable.rb

@@ -51,6 +51,13 @@ module Bashly
       File.exist? user_file_path(file)
     end
 
+    # Returns a wrapped, indented and sanitized string
+    # Designed to place help and example messages inside bash's 'printf'
+    def user_string(text, indent: 0)
+      wrap = Settings.word_wrap - indent
+      text.wrap(wrap).indent(indent).sanitize_for_print
+    end
+
   private
 
     def view_path(view)

data/lib/bashly/config_validator.rb

@@ -35,6 +35,7 @@ module Bashly
       assert_string "#{key}.label", value['label']
       assert_optional_string "#{key}.help", value['help']
       assert_boolean "#{key}.required", value['required']
+      assert_boolean "#{key}.catch_help", value['catch_help']
     end
 
     def assert_default_command(key, value)

data/lib/bashly/extensions/string.rb

@@ -33,7 +33,7 @@ class String
     tr(' ', '/').downcase
   end
 
-  def wrap(length = 80)
+  def wrap(length)
     strip!
     split("\n").collect! do |line|
       if line.length > length

data/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() {

data/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
@@ -78,6 +84,9 @@ strict: false
 # (every 2 leading spaces will be converted to a tab character)
 tab_indent: false
 
+# Set the character width used to wrap help and example messages
+word_wrap: 80
+
 # Choose a post-processor for the generated script:
 # formatter: internal     # Use Bashly’s built-in formatter (removes extra newlines)
 # formatter: external     # Run the external command `shfmt --case-indent --indent 2`

data/lib/bashly/library_source_config.rb

@@ -34,6 +34,7 @@ module Bashly
       assert_optional_string "#{key}.usage", value['usage']
       assert_optional_string "#{key}.handler", value['handler']
       assert_optional_string "#{key}.post_install_message", value['post_install_message']
+      assert_boolean "#{key}.skip_src_check", value['skip_src_check']
 
       return if value['handler']
 

data/lib/bashly/script/catch_all.rb

@@ -3,7 +3,7 @@ module Bashly
     class CatchAll
       class << self
         def option_keys
-          @option_keys ||= %i[label help required]
+          @option_keys ||= %i[label help required catch_help]
         end
 
         def from_config(config)
@@ -13,7 +13,7 @@ module Bashly
           when String
             { label: config }
           when Hash
-            { label: config['label'], help: config['help'], required: config['required'] }
+            config.transform_keys(&:to_sym).slice(*option_keys)
           else
             {}
           end
@@ -22,11 +22,12 @@ module Bashly
         end
       end
 
-      def initialize(label: nil, help: nil, required: false, enabled: true)
+      def initialize(label: nil, help: nil, required: false, catch_help: false, enabled: true)
         @label = label
         @help = help
         @required = required
         @enabled = enabled
+        @catch_help = catch_help
       end
 
       def enabled?
@@ -45,6 +46,10 @@ module Bashly
         @required
       end
 
+      def catch_help?
+        @catch_help
+      end
+
       def usage_string
         return nil unless enabled?
 

data/lib/bashly/script/command.rb

@@ -153,7 +153,13 @@ module Bashly
       # 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

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

@@ -16,6 +16,13 @@ module Bashly
           end
         end
 
+        # Returns true if there is at least one fixed flag (--version / --help)
+        # Root command always has --version and subcommands always have --help
+        # except when it is consumed by catch_all
+        def fixed_flags?
+          root_command? || !catch_all.catch_help?
+        end
+
         # Returns true if this command's flags should be considered as gloal
         # flags, and cascade to subcommands
         def global_flags?

data/lib/bashly/settings.rb

@@ -15,6 +15,7 @@ module Bashly
         :enable_inspect_args,
         :enable_sourcing,
         :enable_view_markers,
+        :extra_lib_dirs,
         :formatter,
         :function_names,
         :lib_dir,
@@ -26,7 +27,8 @@ module Bashly
         :tab_indent,
         :target_dir,
         :usage_colors,
-        :var_aliases
+        :var_aliases,
+        :word_wrap
       )
 
       def commands_dir
@@ -107,6 +109,21 @@ module Bashly
         @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
@@ -157,6 +174,10 @@ module Bashly
         @var_aliases ||= get :var_aliases
       end
 
+      def word_wrap
+        @word_wrap ||= get :word_wrap
+      end
+
     private
 
       def get(key)

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.3.3'
+  VERSION = '1.3.5'
 end

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

@@ -1,7 +1,7 @@
 = view_marker
 
 > printf "  %s\n" "{{ label.color(:arg) }}"
-> printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
+> printf "{{ user_string help, indent: 4 }}\n"
 
 if allowed
   > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"

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

@@ -3,6 +3,6 @@ if Settings.show_examples_on_error && examples
 
   > printf "{{ strings[:examples_caption_on_error] }}\n" >&2
   examples.each do |example|
-    > printf "{{ example.wrap(78).indent(2).sanitize_for_print }}\n" >&2
+    > printf "{{ user_string example, indent: 2 }}\n" >&2
   end
 end

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

@@ -12,12 +12,14 @@ if root_command?
   > 
 end
 
-= (short_flag_exist?("-h") ? "--help)" : "--help | -h)").indent(4)
->       long_usage=yes
->       <%= function_name %>_usage
->       exit
->       ;;
-> 
+unless catch_all.catch_help?
+  = (short_flag_exist?("-h") ? "--help)" : "--help | -h)").indent(4)
+  >       long_usage=yes
+  >       <%= function_name %>_usage
+  >       exit
+  >       ;;
+  > 
+end
 
 if global_flags?
   flags.each do |flag|

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

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

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

@@ -1,6 +1,8 @@
 = view_marker
 
 > inspect_args() {
+>   local k
+>
 >   if ((${#args[@]})); then
 >     readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
 >     echo args:
@@ -17,8 +19,8 @@ if catch_all_used_anywhere?
 >     echo
 >     echo other_args:
 >     echo "- \${other_args[*]} = ${other_args[*]}"
->     for i in "${!other_args[@]}"; do
->       echo "- \${other_args[$i]} = ${other_args[$i]}"
+>     for k in "${!other_args[@]}"; do
+>       echo "- \${other_args[$k]} = ${other_args[$k]}"
 >     done
 >   fi
 >

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

@@ -1,15 +1,7 @@
 = view_marker
 
 > if [[ -n "$long_usage" ]]; then
-options_caption = strings[:options]
-if commands.any? && (public_flags.any? || (flags.any? && Settings.private_reveal_key))
-  options_caption = strings[:global_options]
-end
-
->   printf "%s\n" "{{ options_caption.color(:caption) }}"
->
-= render(:usage_flags).indent 2 if flags.any?
-= render(:usage_fixed_flags).indent 2
+= render(:usage_options).indent 2 if flags.any? || fixed_flags?
 = render(:usage_args).indent 2 if args.any? or catch_all.help
 = render(:usage_environment_variables).indent 2 if environment_variables.any?
 = render(:usage_examples).indent 2 if examples

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

@@ -5,6 +5,8 @@ if root_command?
 else
   > {{ function_name }}_parse_requirements() {
 end
+>   local key
+>
 
 = render(:fixed_flags_filter).indent 2
 = render(:environment_variables_filter).indent 2

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

@@ -9,7 +9,7 @@ else
     = help_header_override.indent 4
   else
     >     printf "{{ full_name }}\n\n"
-    >     printf "{{ help.wrap(78).indent(2).sanitize_for_print }}\n\n"
+    >     printf "{{ user_string help, indent: 2 }}\n\n"
   end
   >   else
   >     printf "{{ caption_string.sanitize_for_print }}\n\n"

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

@@ -12,7 +12,7 @@ end
 if catch_all.help
   >
   > echo "  {{ catch_all.label }}"
-  > printf "{{ catch_all.help.wrap(76).indent(4).sanitize_for_print }}\n"
+  > printf "{{ user_string catch_all.help, indent: 4 }}\n"
   > echo
 end
 

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

@@ -3,7 +3,7 @@
 > printf "%s\n" "{{ strings[:examples].color(:caption) }}"
 
 examples.each do |example|
-  > printf "{{ example.wrap(78).indent(2).sanitize_for_print }}\n"
+  > printf "{{ user_string example, indent: 2 }}\n"
 end
 
 > echo

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

@@ -1,13 +1,15 @@
 = view_marker
 
-if short_flag_exist?("-h")
-  > printf "  %s\n" "{{ '--help'.color(:flag) }}"
-else
-  > printf "  %s\n" "{{ '--help, -h'.color(:flag) }}"
-end
+unless catch_all.catch_help?
+  if short_flag_exist?("-h")
+    > printf "  %s\n" "{{ '--help'.color(:flag) }}"
+  else
+    > printf "  %s\n" "{{ '--help, -h'.color(:flag) }}"
+  end
 
-> printf "    {{ strings[:help_flag_text] }}\n"
-> echo
+  > printf "    {{ strings[:help_flag_text] }}\n"
+  > echo
+end
 
 if root_command?
   if short_flag_exist?("-v")

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

@@ -0,0 +1,11 @@
+= view_marker
+
+options_caption = strings[:options]
+if commands.any? && (public_flags.any? || (flags.any? && Settings.private_reveal_key))
+  options_caption = strings[:global_options]
+end
+
+> printf "%s\n" "{{ options_caption.color(:caption) }}"
+>
+= render(:usage_flags) if flags.any?
+= render(:usage_fixed_flags)

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

@@ -1,7 +1,7 @@
 = view_marker
 
 > printf "  %s\n" "{{ usage_string(extended: true).color(:environment_variable) }}"
-> printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
+> printf "{{ user_string help, indent: 4 }}\n"
 
 if allowed
   > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"

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

@@ -1,7 +1,7 @@
 = view_marker
 
 > printf "  %s\n" "{{ usage_string(extended: true).color(:flag) }}"
-> printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
+> printf "{{ user_string help, indent: 4 }}\n"
 
 if allowed
   > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -314,6 +314,7 @@ files:
 - lib/bashly/views/command/usage_examples.gtx
 - lib/bashly/views/command/usage_fixed_flags.gtx
 - lib/bashly/views/command/usage_flags.gtx
+- lib/bashly/views/command/usage_options.gtx
 - lib/bashly/views/command/user_filter.gtx
 - lib/bashly/views/command/user_hooks.gtx
 - lib/bashly/views/command/user_lib.gtx
@@ -358,7 +359,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.0
 specification_version: 4
 summary: Bash Command Line Tool Generator
 test_files: []