- Allow setting the SCRIPT_PATH argument via the COMPLETELY_SCRIPT_PATH environment variable

Author: DannyBen

lib/completely/commands/base.rb

@@ -33,7 +33,11 @@ def completions
       end
 
       def config_path
-        args['CONFIG_PATH'] || ENV['COMPLETELY_CONFIG_PATH'] || 'completely.yaml'
+        @config_path ||= args['CONFIG_PATH'] || ENV['COMPLETELY_CONFIG_PATH'] || 'completely.yaml'
+      end
+
+      def script_path
+        @script_path ||= args['SCRIPT_PATH'] || ENV['COMPLETELY_SCRIPT_PATH'] || "#{config_basename}.bash"
       end
 
       def config_basename

lib/completely/commands/generate.rb

@@ -5,23 +5,24 @@ module Commands
     class Generate < Base
       help "Generate the bash completion script to a file"
 
-      usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]"
+      usage "completely generate [CONFIG_PATH SCRIPT_PATH --function NAME --wrap NAME]"
       usage "completely generate (-h|--help)"
 
       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"
 
       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"
+      param "SCRIPT_PATH", "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension\nCan also be set by an environment variable"
 
       environment_config_path
+      environment "COMPLETELY_SCRIPT_PATH", "Path to the output bash script"
       environment_debug
 
       def run
         wrap = args['--wrap']
         output = wrap ? wrapper_function(wrap) : script
-        File.write output_path, output
-        say "Saved !txtpur!#{output_path}"
+        File.write script_path, output
+        say "Saved !txtpur!#{script_path}"
         syntax_warning unless completions.valid?
       end
 
@@ -31,10 +32,6 @@ def wrapper_function(wrapper_name)
         completions.wrapper_function wrapper_name
       end
 
-      def output_path
-        @output_path ||= args['OUTPUT_PATH'] || "#{config_basename}.bash"
-      end
-
     end
   end
 end

spec/approvals/cli/generate/help

@@ -1,7 +1,7 @@
 Generate the bash completion script to a file
 
 Usage:
-  completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]
+  completely generate [CONFIG_PATH SCRIPT_PATH --function NAME --wrap NAME]
   completely generate (-h|--help)
 
 Options:
@@ -20,14 +20,18 @@ Parameters:
     Path to the YAML configuration file [default: completely.yaml]
     Can also be set by an environment variable
 
-  OUTPUT_PATH
+  SCRIPT_PATH
     Path to the output bash script. When not provided, the name of the input
     file will be used with a .bash extension
+    Can also be set by an environment variable
 
 Environment Variables:
   COMPLETELY_CONFIG_PATH
     Path to a completely configuration file [default: completely.yaml]
 
+  COMPLETELY_SCRIPT_PATH
+    Path to the output bash script
+
   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

spec/completely/commands/generate_spec.rb

@@ -44,8 +44,7 @@
     end
   end
 
-
-  context "with CONFIG_PATH OUTPUT_PATH" do
+  context "with CONFIG_PATH SCRIPT_PATH" do
     before { reset_tmp_dir }
 
     it "generates the bash script to the specified path" do