bashly 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc29835d6181be972a508c311ad9554e9f57a8ad705804690ed4cb6aa98c6ab7
-  data.tar.gz: 7f052f8027e16e8b3fcc684349aa784342c734e7e6381d0ff0032ec0b2a3da2c
+  metadata.gz: 429df4c59ef5a1dc0f1f9e332ab0b32b702fe5b83124c5ab04d784ef7d82bbc2
+  data.tar.gz: fdef11f71141111dea60129f9a9b855c669129010f5ec6e046fc0cdfafd9907f
 SHA512:
-  metadata.gz: c019868212b40635d602a9e9c2f5bee24bb6cc5b6b78e748a37cb912cff799f932bbb365178f6b74354e8012d54e4e61bb86e47b01793fd340a5fe8a35f17eb2
-  data.tar.gz: 7b4fd782e6e1e3a180a10c947581d9252db38da47a652afc3687d651ebf0eb0aa4a35d6ec0827ff6083d0f6cb935cd9aab9deb90bd2c1bbe411bc11493fd2cf0
+  metadata.gz: 17dcbf38797ebdd77898a53e09271cf7e0522c53af2f223910edc205f02d6ccd254eb4bcd11307f76656f14edaef253472efe0a9f699b9490f2ed3ef90746c85
+  data.tar.gz: 347ec4aebc9be7dcbcaef970db0465edf422b828361d3a37cfaa09337c372a1940a611b24a190af81dbb9857feeb8acc9c2d5662a39eac54df1f4504129c3424

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/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/settings/settings.yml

@@ -84,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/settings.rb

@@ -27,7 +27,8 @@ module Bashly
         :tab_indent,
         :target_dir,
         :usage_colors,
-        :var_aliases
+        :var_aliases,
+        :word_wrap
       )
 
       def commands_dir
@@ -173,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.4'
+  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/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/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/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.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -359,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: []