- Allow setting the CONFIG_PATH argument via the COMPLETELY_CONFIG_PATH environment variable

Author: DannyBen

lib/completely/commands/base.rb

@@ -5,15 +5,15 @@ module Commands
     class Base < MisterBin::Command
 
       class << self
-        def config_path_usage
+        def param_config_path
           param "CONFIG_PATH", "Path to the YAML configuration file [default: completely.yaml]"
         end
 
-        def function_usage
+        def option_function
           option "-f --function NAME", "Modify the name of the function in the generated script"
         end
 
-        def debug_usage
+        def environment_debug
           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
@@ -29,7 +29,11 @@ def completions
       end
 
       def config_path
-        args['CONFIG_PATH'] || 'completely.yaml'
+        args['CONFIG_PATH'] || ENV['COMPLETELY_CONFIG_PATH'] || 'completely.yaml'
+      end
+
+      def config_basename
+        File.basename config_path, File.extname(config_path)
       end
 
       def syntax_warning

lib/completely/commands/generate.rb

@@ -8,12 +8,12 @@ class Generate < Base
       usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]"
       usage "completely generate (-h|--help)"
 
-      function_usage
+      option_function
       option "-w --wrap NAME", "Wrap the completion script inside a function that echos the script. This is useful if you wish to embed it directly in your script"
 
-      config_path_usage
-      param "OUTPUT_PATH", "Path to the output bash script [default: completely.bash]"
-      debug_usage
+      param_config_path
+      param "OUTPUT_PATH", "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension"
+      environment_debug
 
       def run
         wrap = args['--wrap']
@@ -30,7 +30,7 @@ def wrapper_function(wrapper_name)
       end
 
       def output_path
-        @output_path ||= args['OUTPUT_PATH'] || "completely.bash"
+        @output_path ||= args['OUTPUT_PATH'] || "#{config_basename}.bash"
       end
 
     end

lib/completely/commands/init.rb

@@ -8,7 +8,7 @@ class Init < Base
       usage "completely init [CONFIG_PATH]"
       usage "completely init (-h|--help)"
 
-      config_path_usage
+      param_config_path
 
       def run
         if File.exist? config_path

lib/completely/commands/preview.rb

@@ -8,9 +8,9 @@ class Preview < Base
       usage "completely preview [CONFIG_PATH --function NAME]"
       usage "completely preview (-h|--help)"
 
-      function_usage
-      config_path_usage
-      debug_usage
+      option_function
+      param_config_path
+      environment_debug
 
       def run
         puts script

lib/completely/commands/test.rb

@@ -21,7 +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
+      environment_debug
 
       example %q[completely test "mygit pu"]
       example %q[completely test "mygit pull "]

lib/completely/templates/template.erb

@@ -7,6 +7,7 @@
 <%= function_name %>() {
   local cur compline
   _init_completion -s || return
+
   cur=${COMP_WORDS[COMP_CWORD]}
   compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
@@ -20,7 +21,10 @@
   case "$compline" in
 % patterns.each do |pattern|
 % next if pattern.empty?
-    <%= pattern.case_string %>) COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur")) ;;
+    <%= pattern.case_string %>)
+      COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur"))
+      ;;
+
 % end
   esac
 } &&

spec/approvals/cli/generate/help

@@ -20,7 +20,8 @@ Parameters:
     Path to the YAML configuration file [default: completely.yaml]
 
   OUTPUT_PATH
-    Path to the output bash script [default: completely.bash]
+    Path to the output bash script. When not provided, the name of the input
+    file will be used with a .bash extension
 
 Environment Variables:
   COMPLETELY_DEBUG

spec/approvals/cli/generated-script

@@ -7,14 +7,27 @@
 _mygit_completions() {
   local cur compline
   _init_completion -s || return
+
   cur=${COMP_WORDS[COMP_CWORD]}
   compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
   case "$compline" in
-    'status'*) COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur")) ;;
-    'commit'*) COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur")) ;;
-    'init'*) COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur")) ;;
-    *) COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur")) ;;
+    'status'*)
+      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))
+      ;;
+
+    'commit'*)
+      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))
+      ;;
+
+    'init'*)
+      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))
+      ;;
+
+    *)
+      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))
+      ;;
+
   esac
 } &&
 complete -F _mygit_completions mygit

spec/approvals/cli/generated-script-alt

@@ -7,14 +7,27 @@
 _mycomps() {
   local cur compline
   _init_completion -s || return
+
   cur=${COMP_WORDS[COMP_CWORD]}
   compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
   case "$compline" in
-    'status'*) COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur")) ;;
-    'commit'*) COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur")) ;;
-    'init'*) COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur")) ;;
-    *) COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur")) ;;
+    'status'*)
+      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))
+      ;;
+
+    'commit'*)
+      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))
+      ;;
+
+    'init'*)
+      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))
+      ;;
+
+    *)
+      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))
+      ;;
+
   esac
 } &&
 complete -F _mycomps mygit

spec/approvals/cli/generated-wrapped-script

@@ -8,14 +8,27 @@ give_comps() {
   echo $'_mygit_completions() {'
   echo $'  local cur compline'
   echo $'  _init_completion -s || return'
+  echo $''
   echo $'  cur=${COMP_WORDS[COMP_CWORD]}'
   echo $'  compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"'
   echo $''
   echo $'  case "$compline" in'
-  echo $'    \'status\'*) COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur")) ;;'
-  echo $'    \'commit\'*) COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur")) ;;'
-  echo $'    \'init\'*) COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur")) ;;'
-  echo $'    *) COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur")) ;;'
+  echo $'    \'status\'*)'
+  echo $'      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))'
+  echo $'      ;;'
+  echo $''
+  echo $'    \'commit\'*)'
+  echo $'      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))'
+  echo $'      ;;'
+  echo $''
+  echo $'    \'init\'*)'
+  echo $'      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))'
+  echo $'      ;;'
+  echo $''
+  echo $'    *)'
+  echo $'      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))'
+  echo $'      ;;'
+  echo $''
   echo $'  esac'
   echo $'} &&'
   echo $'complete -F _mygit_completions mygit'