implement 'bashly add comp'

Author: DannyBen

bashly.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.7.0"
 
   s.add_runtime_dependency 'colsole', '~> 0.6'
-  s.add_runtime_dependency 'completely', '~> 0.1'
+  s.add_runtime_dependency 'completely', '~> 0.1', '>= 0.1.2'
   s.add_runtime_dependency 'mister_bin', '~> 0.7'
   s.add_runtime_dependency 'requires', '~> 0.1'
 end

lib/bashly/commands/add.rb

@@ -8,15 +8,20 @@ class Add < Base
       usage "bashly add config [--force]"
       usage "bashly add colors [--force]"
       usage "bashly add yaml [--force]"
+      usage "bashly add comp FORMAT [OUTPUT]"
       usage "bashly add (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
 
+      param "FORMAT", "Output format, can be one of:\n  function : generate a function file to be included in your script.\n  script   : generate a standalone bash completions script\n  yaml     : generate a yaml compatible with 'completely'"
+      param "OUTPUT", "For the 'comp function' command: Name of the generated function.\nFor the 'comp script' or 'comp yaml' commands: path to output file.\nIn all cases, this is optional and will have sensible defaults."
+
       command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."
       command "lib", "Create the additional lib directory for additional user scripts. All *.sh scripts in this folder will be included in the final bash script."
       command "config", "Add standard functions for handling INI files to the lib directory."
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
       command "yaml", "Add standard functions for reading YAML files to the lib directory."
+      command "comp", "Generate a bash completions script or function."
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
@@ -40,6 +45,23 @@ def yaml_command
         safe_copy_lib "yaml.sh"
       end
 
+      def comp_command
+        format = args['FORMAT']
+        output = args['OUTPUT']
+        
+        case format
+        when "function"
+          save_comp_function output
+        when "yaml"
+          save_comp_yaml output
+        when "script"
+          save_comp_script output
+        else
+          raise Error, "Unrecognized format: #{format}"
+        end
+
+      end
+
     private
 
       def safe_copy_lib(libfile)
@@ -64,6 +86,50 @@ def deep_copy(source, target)
         FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
         FileUtils.cp source, target
       end
+
+      def config
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+      end
+
+      def command
+        @command ||= Models::Command.new config
+      end
+
+      def completions
+        @completions ||= command.completion_data
+      end
+
+      def completions_script
+        @completions_script ||= command.completion_script
+      end
+
+      def completions_function
+        @completions_function ||= command.completion_function
+      end
+
+      def save_comp_yaml(filename = nil)
+        filename ||= "completions.yaml"
+        File.write filename, completions.to_yaml
+        say "created !txtgrn!#{filename}"
+      end
+
+      def save_comp_script(filename = nil)
+        filename ||= "completions.bash"
+        File.write filename, completions_script
+        say "created !txtgrn!#{filename}"
+      end
+
+      def save_comp_function(name = nil)
+        name ||= "send_completions"
+        target_dir = "#{Settings.source_dir}/lib"
+        filename = "#{target_dir}/#{name}.sh"
+        
+        FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
+        File.write filename, completions_function
+        
+        say "created !txtgrn!#{filename}"
+      end
+
     end
   end
 end

lib/bashly/concerns/completions.rb

@@ -1,3 +1,5 @@
+require 'completely'
+
 module Bashly
   # This is a `Command` concern responsible for providing bash completion data
   module Completions
@@ -11,8 +13,20 @@ def completion_data(with_version: true)
       result
     end
 
+    def completion_script
+      completion_generator.script
+    end
+
+    def completion_function(name = nil)
+      completion_generator.wrapper_function(name)
+    end
+
   private
 
+    def completion_generator
+      Completely::Completions.new(completion_data)
+    end
+
     def completion_flag_names
       flags.map(&:name) + flags.map(&:short)
     end

spec/approvals/cli/add/help

@@ -6,6 +6,7 @@ Usage:
   bashly add config [--force]
   bashly add colors [--force]
   bashly add yaml [--force]
+  bashly add comp FORMAT [OUTPUT]
   bashly add (-h|--help)
 
 Commands:
@@ -27,13 +28,28 @@ Commands:
   yaml
     Add standard functions for reading YAML files to the lib directory.
 
+  comp
+    Generate a bash completions script or function.
+
 Options:
   -f --force
     Overwrite existing files
 
   -h --help
     Show this help
 
+Parameters:
+  FORMAT
+    Output format, can be one of:
+      function : generate a function file to be included in your script.
+      script   : generate a standalone bash completions script
+      yaml     : generate a yaml compatible with 'completely'
+
+  OUTPUT
+    For the 'comp function' command: Name of the generated function.
+    For the 'comp script' or 'comp yaml' commands: path to output file.
+    In all cases, this is optional and will have sensible defaults.
+
 Environment Variables:
   BASHLY_SOURCE_DIR
     The path containing the bashly configuration and source files [default: src]

spec/approvals/cli/generate/usage

@@ -4,4 +4,5 @@ Usage:
   bashly add config [--force]
   bashly add colors [--force]
   bashly add yaml [--force]
+  bashly add comp FORMAT [OUTPUT]
   bashly add (-h|--help)