bashly 1.2.9 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 835cd138c47f6519a1fc6ca21c5dfc4b3a9b276e8ea8d082104d7206cc1ed75e
-  data.tar.gz: 8688035834ceb891b28cc6b22f6f9a9a215332a674e5f900e89339862e49d993
+  metadata.gz: 69bab1b1c954940d944ed30bbf0b30627cf02cb793bed1220006d0e232e69871
+  data.tar.gz: d2219c883f7f12ca243f5cd60aac8feeb1eb7659811ee3f3ae6a48ec0fd33e1d
 SHA512:
-  metadata.gz: b01a2ece1903bafb37e2dcf8fd28797272ec99e226484e34bf8a4927aa9368cef31a6f21a89cc51b807d5ba3da53eaaf83fb0683a929a5e43de07899334e82c6
-  data.tar.gz: 47a1aa8c24dba99340d98f3f348b1aa24b4c2907ba6ffd37968ce6b4aa54c74dca75057397d1ba58c73934e49b63aad20a3f62b3d1e228af903fe90a8ddf6f97
+  metadata.gz: '096d99390ec2f1e00501f86e062d22d3a4ea85b545e504afd631615bea0e09e6c802d4e40a9fb29ada02f5ec2353ce2c6d0a936259b496c02563fc78a85857f5'
+  data.tar.gz: f258e0a87ccf7ab2a4972bc6f784e909a9b6289d5eb00906fd58ebb21972d0e14611599716191dee3115e5c4d544758f4828328020db993105abaadb54097ba9

data/lib/bashly/commands/generate.rb

@@ -3,7 +3,7 @@ require 'filewatcher'
 module Bashly
   module Commands
     class Generate < Base
-      summary "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]'

data/lib/bashly/config_validator.rb

@@ -186,6 +186,7 @@ module Bashly
 
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
+      assert_optional_string "#{key}.help_header_override", value['help_header_override']
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
       assert_optional_string "#{key}.filename", value['filename']

data/lib/bashly/docs/command.yml

@@ -289,6 +289,20 @@ command.help:
     - name: images
       help: Manage images
 
+command.help_header_override:
+  help: Provide an alternative bash code (or function call) that will be executed at the beginning of the help message.
+
+  url: https://bashly.dev/configuration/command/#help_header_override
+  example: |-
+    name: font-explorer
+    help: Font manager utility
+
+    help_header_override: |
+      echo '┏┓       ┏┓    ┓        '
+      echo '┣ ┏┓┏┓╋  ┣ ┓┏┏┓┃┏┓┏┓┏┓┏┓'
+      echo '┻ ┗┛┛┗┗  ┗┛┛┗┣┛┗┗┛┛ ┗ ┛ '
+      echo '             ┛      v1.0'
+
 command.name:
   help: Specify the name of the command. This option is required.
   url: https://bashly.dev/configuration/command/#name

data/lib/bashly/script/command.rb

@@ -17,7 +17,7 @@ module Bashly
             alias args catch_all commands completions
             default dependencies environment_variables examples
             extensible expose filename filters flags
-            footer function group help name
+            footer function group help help_header_override name
             private variables version
           ]
         end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.2.9'
+  VERSION = '1.2.10'
 end

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

@@ -1,12 +1,16 @@
 = view_marker
 
 > {{ function_name }}_usage() {
-if summary == help
+if summary == help && !help_header_override
   >   printf "{{ caption_string.sanitize_for_print }}\n\n"
 else
   >   if [[ -n $long_usage ]]; then
-  >     printf "{{ full_name }}\n\n"
-  >     printf "{{ help.wrap(78).indent(2).sanitize_for_print }}\n\n"
+  if help_header_override
+    = help_header_override.indent 4
+  else
+    >     printf "{{ full_name }}\n\n"
+    >     printf "{{ help.wrap(78).indent(2).sanitize_for_print }}\n\n"
+  end
   >   else
   >     printf "{{ caption_string.sanitize_for_print }}\n\n"
   >   fi

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.10
 platform: ruby
 authors:
 - Danny Ben Shitrit
 bindir: bin
 cert_chain: []
-date: 2025-01-27 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -362,7 +362,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Bash Command Line Tool Generator
 test_files: []