- Add 'Global options' caption when appropriate

DannyBen · Apr 23, 2024 · 105a0f8 · 105a0f8
1 parent 0301e27
commit 105a0f8
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 11 deletions.
diff --git a/examples/catch-all/src/root_command.sh b/examples/catch-all/src/root_command.sh
diff --git a/examples/command-default-force/README.md b/examples/command-default-force/README.md
@@ -46,7 +46,7 @@ commands:
 tester - Sample application that uses the forced default command option
 
 Usage:
-  tester COMMAND
+  tester [COMMAND]
   tester [COMMAND] --help | -h
   tester --version | -v
 

diff --git a/examples/command-paths/README.md b/examples/command-paths/README.md
@@ -123,7 +123,7 @@ Commands:
   image       Image commands
   ps          List containers
 
-Options:
+Global Options:
   --debug, -d
     Enable debug mode
 

diff --git a/examples/docker-like/README.md b/examples/docker-like/README.md
@@ -107,7 +107,7 @@ Commands:
   image       Image commands
   ps          List containers
 
-Options:
+Global Options:
   --debug, -d
     Enable debug mode
 

diff --git a/examples/render-mandoc/README.md b/examples/render-mandoc/README.md
@@ -102,7 +102,7 @@ ISSUE TRACKER
 AUTHORS
        Lana Lang.
 
-Version 0.1.0                     March 2024                       download(1)
+Version 0.1.0                     April 2024                       download(1)
 
 
 ````

diff --git a/lib/bashly/libraries/strings/strings.yml b/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:"

diff --git a/lib/bashly/views/command/long_usage.gtx b/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

diff --git a/spec/approvals/examples/command-paths b/spec/approvals/examples/command-paths
@@ -32,7 +32,7 @@ Commands:
   image       Image commands
   ps          List containers
 
-Options:
+Global Options:
   --debug, -d
     Enable debug mode
 

diff --git a/spec/approvals/examples/docker-like b/spec/approvals/examples/docker-like
@@ -32,7 +32,7 @@ Commands:
   image       Image commands
   ps          List containers
 
-Options:
+Global Options:
   --debug, -d
     Enable debug mode
 

diff --git a/spec/approvals/fixtures/global-flags b/spec/approvals/fixtures/global-flags
@@ -14,7 +14,7 @@ Usage:
 Commands:
   show   
 
-Options:
+Global Options:
   --alpha, -a
     Alpha
-Original file line number
+Diff line change
@@ Expand Up / @@ -102,7 +102,7 @@ ISSUE TRACKER @@
     AUTHORS
            Lana Lang.
-    Version 0.1.0                     March 2024                       download(1)
+    Version 0.1.0                     April 2024                       download(1)
     ````
@@ Expand Down @@