Merge pull request #512 from DannyBen/add/double-dash-usage

DannyBen · web-flow · commit 57217de7927f · 2024-03-29T08:16:28.000+03:00
Add `[--]` to usage text when `catch_all` is used
diff --git a/examples/catch-all-advanced/README.md b/examples/catch-all-advanced/README.md
@@ -90,7 +90,7 @@ cli download - Download a file
 Alias: d
 
 Usage:
-  cli download SOURCE [TARGET] [OPTIONS] [AWS PARAMS...]
+  cli download SOURCE [TARGET] [OPTIONS] [--] [AWS PARAMS...]
   cli download --help | -h
 
 Options:
@@ -143,21 +143,57 @@ args:
 
 ````
 
-### `$ ./cli download source target and --additional stuff`
+### `$ ./cli download source target --force`
 
 ````shell
 # this file is located in 'src/download_command.sh'
 # code for 'cli download' goes here
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
+- ${args[--force]} = 1
+- ${args[source]} = source
+- ${args[target]} = target
+
+
+````
+
+### `$ ./cli download source target --force -abc --option=value`
+
+````shell
+# this file is located in 'src/download_command.sh'
+# code for 'cli download' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--force]} = 1
+- ${args[source]} = source
+- ${args[target]} = target
+
+other_args:
+- ${other_args[*]} = -a -b -c --option value
+- ${other_args[0]} = -a
+- ${other_args[1]} = -b
+- ${other_args[2]} = -c
+- ${other_args[3]} = --option
+- ${other_args[4]} = value
+
+
+````
+
+### `$ ./cli download source target --force -- -abc --option=value`
+
+````shell
+# this file is located in 'src/download_command.sh'
+# code for 'cli download' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--force]} = 1
 - ${args[source]} = source
 - ${args[target]} = target
 
 other_args:
-- ${other_args[*]} = and --additional stuff
-- ${other_args[0]} = and
-- ${other_args[1]} = --additional
-- ${other_args[2]} = stuff
+- ${other_args[*]} = -abc --option=value
+- ${other_args[0]} = -abc
+- ${other_args[1]} = --option=value
 
 
 ````
@@ -170,7 +206,7 @@ cli upload - Upload a file
 Alias: u
 
 Usage:
-  cli upload FILES...
+  cli upload [--] FILES...
   cli upload --help | -h
 
 Options:
@@ -189,7 +225,7 @@ Arguments:
 
 ````shell
 missing required argument: FILES...
-usage: cli upload FILES...
+usage: cli upload [--] FILES...
 
 
 ````
diff --git a/examples/catch-all-stdin/README.md b/examples/catch-all-stdin/README.md
@@ -74,7 +74,7 @@ echo
 cli - Sample application
 
 Usage:
-  cli [OPTIONS] [FILE...]
+  cli [OPTIONS] [--] [FILE...]
   cli --help | -h
   cli --version | -v
 
diff --git a/examples/catch-all/README.md b/examples/catch-all/README.md
@@ -41,7 +41,7 @@ flags:
 
 ````shell
 missing required argument: MESSAGE
-usage: download MESSAGE [OPTIONS] [...]
+usage: download MESSAGE [OPTIONS] [--] [...]
 
 
 ````
@@ -52,7 +52,7 @@ usage: download MESSAGE [OPTIONS] [...]
 download - Catch All Example
 
 Usage:
-  download MESSAGE [OPTIONS] [...]
+  download MESSAGE [OPTIONS] [--] [...]
   download --help | -h
   download --version | -v
 
diff --git a/lib/bashly/script/catch_all.rb b/lib/bashly/script/catch_all.rb
@@ -48,7 +48,7 @@ def required?
       def usage_string
         return nil unless enabled?
 
-        required? ? label : "[#{label}]"
+        required? ? "[--] #{label}" : "[--] [#{label}]"
       end
     end
   end
diff --git a/spec/approvals/examples/catch-all b/spec/approvals/examples/catch-all
@@ -5,12 +5,12 @@ created ./download
 run ./download --help to test your bash script
 + ./download
 missing required argument: MESSAGE
-usage: download MESSAGE [OPTIONS] [...]
+usage: download MESSAGE [OPTIONS] [--] [...]
 + ./download -h
 download - Catch All Example
 
 Usage:
-  download MESSAGE [OPTIONS] [...]
+  download MESSAGE [OPTIONS] [--] [...]
   download --help | -h
   download --version | -v
 
diff --git a/spec/approvals/examples/catch-all-advanced b/spec/approvals/examples/catch-all-advanced
@@ -22,7 +22,7 @@ cli download - Download a file
 Alias: d
 
 Usage:
-  cli download SOURCE [TARGET] [OPTIONS] [AWS PARAMS...]
+  cli download SOURCE [TARGET] [OPTIONS] [--] [AWS PARAMS...]
   cli download --help | -h
 
 Options:
@@ -102,7 +102,7 @@ cli upload - Upload a file
 Alias: u
 
 Usage:
-  cli upload FILES...
+  cli upload [--] FILES...
   cli upload --help | -h
 
 Options:
@@ -115,7 +115,7 @@ Arguments:
 
 + ./cli upload
 missing required argument: FILES...
-usage: cli upload FILES...
+usage: cli upload [--] FILES...
 + ./cli upload file1 'file 2' file3
 # this file is located in 'src/upload_command.sh'
 # code for 'cli upload' goes here
diff --git a/spec/approvals/examples/catch-all-stdin b/spec/approvals/examples/catch-all-stdin
@@ -5,7 +5,7 @@ run ./cli --help to test your bash script
 cli - Sample application
 
 Usage:
-  cli [OPTIONS] [FILE...]
+  cli [OPTIONS] [--] [FILE...]
   cli --help | -h
   cli --version | -v
 
diff --git a/spec/approvals/fixtures/catch-all-no-args b/spec/approvals/fixtures/catch-all-no-args
@@ -11,7 +11,7 @@ args: none
 download - Download something
 
 Usage:
-  download [URLS...]
+  download [--] [URLS...]
   download --help | -h
   download --version | -v
 
diff --git a/spec/approvals/rendering/mandoc/catch-all-advanced/cli-download.md b/spec/approvals/rendering/mandoc/catch-all-advanced/cli-download.md
@@ -10,7 +10,7 @@ NAME
 SYNOPSIS
 ==================================================
 
-**cli download** SOURCE [TARGET] [OPTIONS] [AWS PARAMS...]
+**cli download** SOURCE [TARGET] [OPTIONS] [--] [AWS PARAMS...]
 
 DESCRIPTION
 ==================================================
diff --git a/spec/approvals/rendering/mandoc/catch-all-advanced/cli-upload.md b/spec/approvals/rendering/mandoc/catch-all-advanced/cli-upload.md
@@ -10,7 +10,7 @@ NAME
 SYNOPSIS
 ==================================================
 
-**cli upload** FILES...
+**cli upload** [--] FILES...
 
 DESCRIPTION
 ==================================================
diff --git a/spec/approvals/rendering/markdown/catch-all-advanced/cli download.md b/spec/approvals/rendering/markdown/catch-all-advanced/cli download.md
@@ -9,7 +9,7 @@ Download a file
 ## Usage
 
 ```bash
-cli download SOURCE [TARGET] [OPTIONS] [AWS PARAMS...]
+cli download SOURCE [TARGET] [OPTIONS] [--] [AWS PARAMS...]
 ```
 
 ## Examples
diff --git a/spec/approvals/rendering/markdown/catch-all-advanced/cli upload.md b/spec/approvals/rendering/markdown/catch-all-advanced/cli upload.md
@@ -9,7 +9,7 @@ Upload a file
 ## Usage
 
 ```bash
-cli upload FILES...
+cli upload [--] FILES...
 ```
 
 
diff --git a/spec/bashly/script/catch_all_spec.rb b/spec/bashly/script/catch_all_spec.rb
@@ -97,23 +97,23 @@
       let(:fixture) { :catch_all_hash }
 
       it 'returns a usage help without []' do
-        expect(subject.usage_string).to eq 'ADDITIONAL_PARAMS...'
+        expect(subject.usage_string).to eq '[--] ADDITIONAL_PARAMS...'
       end
     end
 
     context "when catch_all['required'] is false" do
       let(:fixture) { :catch_all_string }
 
       it 'returns a usage help with []' do
-        expect(subject.usage_string).to eq '[EXTRA_PARAMS...]'
+        expect(subject.usage_string).to eq '[--] [EXTRA_PARAMS...]'
       end
     end
 
     context 'when catch_all is true' do
       let(:fixture) { :catch_all }
 
       it 'returns [...]' do
-        expect(subject.usage_string).to eq '[...]'
+        expect(subject.usage_string).to eq '[--] [...]'
       end
     end
   end
diff --git a/spec/bashly/script/command_spec.rb b/spec/bashly/script/command_spec.rb
@@ -617,23 +617,23 @@
       let(:fixture) { :mode_args_and_flags }
 
       it 'returns the correct string' do
-        expect(subject.usage_string).to eq 'get SOURCE [TARGET] [OPTIONS] [PARAMS...]'
+        expect(subject.usage_string).to eq 'get SOURCE [TARGET] [OPTIONS] [--] [PARAMS...]'
       end
     end
 
     context 'when only args are defined' do
       let(:fixture) { :mode_args }
 
       it 'returns the correct string' do
-        expect(subject.usage_string).to eq 'get SOURCE [TARGET] [PARAMS...]'
+        expect(subject.usage_string).to eq 'get SOURCE [TARGET] [--] [PARAMS...]'
       end
     end
 
     context 'when only flags are defined' do
       let(:fixture) { :mode_flags }
 
       it 'returns the correct string' do
-        expect(subject.usage_string).to eq 'get [OPTIONS] [PARAMS...]'
+        expect(subject.usage_string).to eq 'get [OPTIONS] [--] [PARAMS...]'
       end
 
       context 'when it has a parent' do
@@ -649,7 +649,7 @@
       let(:fixture) { :mode_empty }
 
       it 'returns the correct string' do
-        expect(subject.usage_string).to eq 'get [PARAMS...]'
+        expect(subject.usage_string).to eq 'get [--] [PARAMS...]'
       end
 
       context 'when it has a parent' do
