- Add COMPLETELY_DEBUG environment setting

Author: DannyBen

lib/completely/commands/base.rb

@@ -12,6 +12,10 @@ def config_path_usage
         def function_usage
           option "-f --function NAME", "Modify the name of the function in the generated script"
         end
+
+        def debug_usage
+          environment "COMPLETELY_DEBUG", "It not empty, the generated script will include an additional debugging snippet that outputs the compline and current word to a text file when a completion is requested"
+        end
       end
 
     protected

lib/completely/commands/generate.rb

@@ -13,6 +13,7 @@ class Generate < Base
 
       config_path_usage
       param "OUTPUT_PATH", "Path to the output bash script [default: completely.bash]"
+      debug_usage
 
       def run
         wrap = args['--wrap']

lib/completely/commands/preview.rb

@@ -10,6 +10,7 @@ class Preview < Base
 
       function_usage
       config_path_usage
+      debug_usage
 
       def run
         puts script

lib/completely/commands/test.rb

@@ -21,6 +21,7 @@ class Test < Base
       environment "COMPLETELY_CONFIG_PATH", "Path to a completely configuration file [default: completely.yaml]"
       environment "COMPLETELY_SCRIPT_PATH", "Path to a completions script. When set, this script will be tested instead of the completely configuration file"
       environment "COMPLETELY_SCRIPT_FUNCTION", "The main completion function to call when using a custom script. If not set, the basename of the script path will be used, prefixed by an underscore"
+      debug_usage
 
       example %q[completely test "mygit pu"]
       example %q[completely test "mygit pull "]

spec/approvals/cli/generate/help

@@ -21,3 +21,9 @@ Parameters:
 
   OUTPUT_PATH
     Path to the output bash script [default: completely.bash]
+
+Environment Variables:
+  COMPLETELY_DEBUG
+    It not empty, the generated script will include an additional debugging
+    snippet that outputs the compline and current word to a text file when a
+    completion is requested

spec/approvals/cli/preview/help

@@ -14,3 +14,9 @@ Options:
 Parameters:
   CONFIG_PATH
     Path to the YAML configuration file [default: completely.yaml]
+
+Environment Variables:
+  COMPLETELY_DEBUG
+    It not empty, the generated script will include an additional debugging
+    snippet that outputs the compline and current word to a text file when a
+    completion is requested

spec/approvals/cli/test/help

@@ -37,6 +37,11 @@ Environment Variables:
     The main completion function to call when using a custom script. If not set,
     the basename of the script path will be used, prefixed by an underscore
 
+  COMPLETELY_DEBUG
+    It not empty, the generated script will include an additional debugging
+    snippet that outputs the compline and current word to a text file when a
+    completion is requested
+
 Examples:
   completely test "mygit pu"
   completely test "mygit pull "

spec/approvals/completions/script-with-debug

@@ -0,0 +1,18 @@
+# completely completion                                    -*- shell-script -*-
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+
+_completely_completions() {
+  local cur compline
+  _init_completion -s || return
+  cur=${COMP_WORDS[COMP_CWORD]}
+  compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
+
+  if [[ -n "$COMPLETELY_DEBUG" ]]; then
+    echo "compline: '$compline'" > 'completely-debug.txt'
+    echo "cur:      '$cur'" >> 'completely-debug.txt'
+  fi
+
+  ...

spec/completely/completions_spec.rb

@@ -40,6 +40,17 @@
         expect(subject.script).to match_approval "completions/script-only-spaces"
       end
     end
+
+    context "when COMPLETELY_DEBUG is set", :focus do
+      before { ENV['COMPLETELY_DEBUG'] = '1' }
+      after  { ENV['COMPLETELY_DEBUG'] = nil }
+
+      it "adds an additional debug snippet to the script" do
+        expect(subject.script).to match_approval("completions/script-with-debug")
+          .except(/case.*/m)
+
+      end
+    end
   end
 
   describe '#wrapper_function' do

spec/completely/pattern_spec.rb

@@ -43,7 +43,7 @@
     end
   end
 
-  describe '#case_string', :focus do
+  describe '#case_string' do
     it "returns the quoted pattern (excluding command name) with a wildcard suffix" do
       expect(subject.case_string).to eq "'commit'*"
     end