bashly 1.1.10 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0857ce9cc52b919c113242568610ed9abbd447221b6d473bbf05f1cd8f29de69'
-  data.tar.gz: 3eb8279ffdbf23a69a5c7eb52d98f2f0c3ca1730f54eb6a18b4957038b69810a
+  metadata.gz: 5000e81ecf047c31547832097355e0d1b5de630041ef2533a80ce70f146e8282
+  data.tar.gz: 9c03b8ef9215a317ebfd75333304065c271e77296a55753de65e612f9d1a8432
 SHA512:
-  metadata.gz: 2aa95822cebdc83d0e3a1af47a2d75886994a7d79976188049b8ea6732ca3d6a83003bfea48c3789e8d3a4db562e16f8f9ed169da414065567c7abf2d2d4c40b
-  data.tar.gz: 3cf237064dfe7f9cfb2523c85d838141f9869e246619b9ed2bf9862499a0345ea1da12178802ee6d7a654e1ad8fec674b751442566b8b8ca1e22b77055105fd1
+  metadata.gz: c6dc6b49075f6e250aec3204f6b9ff2bd6e4236da1bcc5229691565dcc8a4ff4c1d1c06a139c092eae33c61123753cdb542583a69596caf299f87c6ccf3d4f07
+  data.tar.gz: ab9d9fc13a779bfd4d71adbae49e66961c697a46e5cb386875dac1d9e1b021828a2821332f2687d16b87b3fb820cdc006b61d86e7425dd6fdb37ac7aceb12b33

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

@@ -55,6 +55,10 @@ 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
+
 # Display various usage elements in color by providing the name of the color
 # function. The value for each property is a name of a function that is
 # available in your script, for example: `green` or `bold`.

data/lib/bashly/libraries/strings/strings.yml

@@ -4,6 +4,7 @@
 # Usage captions
 usage: "Usage:"
 options: "Options:"
+global_options: "Global Options:"
 arguments: "Arguments:"
 commands: "Commands:"
 examples: "Examples:"
@@ -32,6 +33,7 @@ missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
 missing_required_flag: "missing required flag: %{usage}"
 missing_required_environment_variable: "missing required environment variable: %{var}"
 missing_dependency: "missing dependency: %{dependency}"
+examples_caption_on_error: 'examples:'
 disallowed_flag: "%{name} must be one of: %{allowed}"
 disallowed_argument: "%{name} must be one of: %{allowed}"
 disallowed_environment_variable: "%{name} environment variable must be one of: %{allowed}"

data/lib/bashly/script/command.rb

@@ -307,11 +307,12 @@ module Bashly
 
       # Returns a constructed string suitable for Usage pattern
       def usage_string
-        result = [full_name]
+        result = [base_usage_pattern]
+        command_string = default_command&.default == 'force' ? '[COMMAND]' : 'COMMAND'
 
         result.push case mode
-        when :global_flags    then ['[OPTIONS]', 'COMMAND']
-        when :commands        then ['COMMAND']
+        when :global_flags    then ['[OPTIONS]', command_string]
+        when :commands        then [command_string]
         when :args_and_flags  then usage_string_args + ['[OPTIONS]']
         when :args            then usage_string_args
         when :flags           then ['[OPTIONS]']
@@ -326,6 +327,11 @@ module Bashly
         args.map(&:usage_string)
       end
 
+      def base_usage_pattern
+        usage_pattern = default ? "[#{name}]" : name
+        parents.any? ? (parents + [usage_pattern]).join(' ') : usage_pattern
+      end
+
       # Returns an array of files to include as is inside the script
       # This is meant to provide the user with the ability to add custom
       # functions

data/lib/bashly/settings.rb

@@ -10,6 +10,7 @@ module Bashly
         :config_path,
         :lib_dir,
         :partials_extension,
+        :show_examples_on_error,
         :source_dir,
         :strict,
         :tab_indent,
@@ -57,6 +58,10 @@ module Bashly
         env == :production
       end
 
+      def show_examples_on_error
+        @show_examples_on_error ||= get :show_examples_on_error
+      end
+
       def source_dir
         @source_dir ||= get :source_dir
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.1.10'
+  VERSION = '1.2.0'
 end

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

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

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

@@ -1,7 +1,8 @@
 = view_marker
 
 > if [[ -n $long_usage ]]; then
->   printf "%s\n" "{{ strings[:options].color(:caption) }}"
+options_caption = public_commands.any? && public_flags.any? ? strings[:global_options] : strings[:options]
+>   printf "%s\n" "{{ options_caption.color(:caption) }}"
 >
 = render(:usage_flags).indent 2 if public_flags.any?
 = render(:usage_fixed_flags).indent 2

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

@@ -4,10 +4,10 @@ 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" >&2
+    = render(:examples_on_error).indent 2
     >   exit 1
     > fi
   end
 
   >
-
-end
+end

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

@@ -1,24 +1,17 @@
 = view_marker
 
 > {{ function_name }}_usage() {
->   if [[ -n $long_usage ]]; then
-
 if summary == help
-  >     printf "{{ caption_string.sanitize_for_print }}\n"
-  >     echo 
+  >   printf "{{ caption_string.sanitize_for_print }}\n\n"
 else
-  >     printf "{{ full_name }}\n"
-  >     echo 
-  >     printf "{{ help.wrap(78).indent(2).sanitize_for_print }}\n"
-  >     echo 
+  >   if [[ -n $long_usage ]]; then
+  >     printf "{{ full_name }}\n\n"
+  >     printf "{{ help.wrap(78).indent(2).sanitize_for_print }}\n\n"
+  >   else
+  >     printf "{{ caption_string.sanitize_for_print }}\n\n"
+  >   fi
 end
 
->   else
->     printf "{{ caption_string.sanitize_for_print }}\n"
->     echo 
->   fi
-> 
-
 if alt&.any?
   >   printf "{{ strings[:command_alias] % { alias: alt.join(', ') } }}\n"
   >   echo
@@ -48,3 +41,5 @@ end
 commands.each do |command|
   = command.render 'usage'
 end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -240,6 +240,7 @@ files:
 - 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/examples_on_error.gtx
 - lib/bashly/views/command/fixed_flags_filter.gtx
 - lib/bashly/views/command/footer.gtx
 - lib/bashly/views/command/function.gtx
@@ -307,7 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: Bash Command Line Tool Generator