- Refactor 'bashly add libraries' command

Author: DannyBen

examples/completions/README.md

@@ -7,7 +7,7 @@ This example was generated with:
 ```bash
 $ bashly init
 # ... now edit src/bashly.yml to match the example ...
-$ bashly add comp function
+$ bashly add completions
 $ bashly generate
 # ... now edit src/completions_command.sh ...
 $ bashly generate
@@ -112,7 +112,7 @@ commands:
 ```bash
 # Call the `send_completions` function which was added by running:
 #
-#   $ bashly add comp function
+#   $ bashly add completions
 #
 # Users can now enable bash completion for this script by running:
 #

examples/completions/src/completions_command.sh

@@ -1,6 +1,6 @@
 # Call the `send_completions` function which was added by running:
 #
-#   $ bashly add comp function
+#   $ bashly add completions
 #
 # Users can now enable bash completion for this script by running:
 #

examples/completions/test.sh

@@ -2,7 +2,7 @@
 
 set -x
 
-bashly add comp function --force
+bashly add completions --force
 bashly generate
 
 ### Try Me ###

lib/bashly/commands/add.rb

@@ -3,113 +3,45 @@ module Commands
     class Add < Base
       help 'Add extra features and customization to your script'
 
-      usage 'bashly add colors [--force]'
-      usage 'bashly add comp FORMAT [OUTPUT --force]'
-      usage 'bashly add config [--force]'
-      usage 'bashly add help [--force]'
-      usage 'bashly add lib [--force]'
-      usage 'bashly add settings [--force]'
-      usage 'bashly add strings [--force]'
-      usage 'bashly add test [--force]'
-      usage 'bashly add validations [--force]'
-      usage 'bashly add yaml [--force]'
+      usage 'bashly add LIBRARY [ARGS...] [--force]'
+      usage 'bashly add --list'
       usage 'bashly add (-h|--help)'
 
       option '-f --force', 'Overwrite existing files'
-
-      param 'FORMAT', <<~USAGE
-        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.
-      USAGE
-
-      param 'OUTPUT', <<~USAGE
-        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.
-      USAGE
-
-      command 'colors', 'Add standard functions for printing colorful and formatted text to the lib directory.'
-      command 'comp', 'Generate a bash completions script or function.'
-      command 'config', 'Add standard functions for handling INI files to the lib directory.'
-      command 'help', 'Add a help command, in addition to the standard --help flag.'
-      command 'lib', <<~USAGE
-        Create the lib directory for any additional user scripts.
-        All *.sh scripts in this directory will be included in the final bash script.
-        Note that if you configured a different partials_extension, then the extensions of the files in this directory need to match.
-      USAGE
-
-      command 'settings', 'Copy a sample settings.yml file to your project, allowing you to customize some ' \
-        'bashly options.'
-
-      command 'strings', 'Copy an additional configuration file to your project, allowing you to customize all the ' \
-        'tips and error strings.'
-
-      command 'test', 'Add approval testing.'
-      command 'validations', 'Add argument validation functions to the lib directory.'
-      command 'yaml', 'Add standard functions for reading YAML files to the lib directory.'
-      example 'bashly add strings --force'
-      example 'bashly add comp function'
-      example 'bashly add comp script completions.bash'
+      option '-l --list', 'Show available libraries'
 
       attr_reader :skip_src_check
 
-      def colors_command
-        add_lib 'colors'
-      end
-
-      def comp_command
-        format = args['FORMAT']
-        output = args['OUTPUT']
-
-        case format
-        when 'script'   then add_lib 'completions_script', output
-        when 'function' then add_lib 'completions', output
-        when 'yaml'     then add_lib 'completions_yaml', output
-        else            raise Error, "Unrecognized format: #{format}"
+      def run
+        if args['--list']
+          show_list
+        else
+          add_lib args['LIBRARY']
         end
       end
+      
+    private
 
-      def config_command
-        add_lib 'config'
-      end
-
-      def lib_command
-        add_lib 'lib'
-      end
-
-      def settings_command
-        @skip_src_check = true
-        add_lib 'settings'
-      end
-
-      def strings_command
-        add_lib 'strings'
-      end
-
-      def test_command
-        add_lib 'test'
-      end
-
-      def help_command
-        add_lib 'help'
-      end
-
-      def validations_command
-        add_lib 'validations'
+      def lib_source
+        @lib_source ||= Bashly::LibrarySource.new
       end
 
-      def yaml_command
-        add_lib 'yaml'
+      def show_list
+        lib_source.config.each do |key, config|
+          usage = key
+          usage += " #{config['usage']}" if config['usage']
+          say "g`bashly add #{usage}`"
+          say word_wrap("  #{config['help']}")
+          say ''
+        end
       end
 
-    private
+      def add_lib(name)
+        library = lib_source.libraries[name.to_sym]
+        raise "Unknown library: g`#{name}`\nRun m`bashly add --list` to see available libraries" unless library
 
-      def add_lib(name, *args)
-        source = Bashly::LibrarySource.new
-        library = source.libraries[name.to_sym]
-        library.args = args
+        library.args = args['ARGS']
+        @skip_src_check = lib_source.config.dig name, 'skip_src_check'
 
         files_created = 0
         library.files.each do |file|

lib/bashly/docs/command.yml

@@ -75,7 +75,7 @@ command.commands:
       help: Register a local repository
 
 command.completions:
-  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add comp`.
+  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`.
   url: https://bashly.dannyb.co/configuration/command/#completions
   example: |-
     commands:

lib/bashly/docs/flag.yml

@@ -46,7 +46,7 @@ flag.arg:
       help: Clone using SSH
 
 flag.completions:
-  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add comp`. Must be accompanied by `arg`.
+  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`. Must be accompanied by `arg`.
   url: https://bashly.dannyb.co/configuration/flag/#completions
   example: |-
     flags:

lib/bashly/libraries/libraries.yml

@@ -1,35 +1,58 @@
 colors:
+  help: Add standard functions for printing colorful and formatted text to the lib directory.
   files:
     - source: "colors/colors.sh"
       target: "%{user_lib_dir}/colors.%{user_ext}"
 
-completions: Bashly::Libraries::CompletionsFunction
-completions_script: Bashly::Libraries::CompletionsScript
-completions_yaml: Bashly::Libraries::CompletionsYAML
+completions: 
+  help: Generate a bash completions function.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsFunction
+
+completions_script:
+  help: Generate a standalone bash completions script.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsScript
+
+completions_yaml:
+  help: Generate a completions YAML configuration for Completely.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsYAML
 
 config:
+  help: Add standard functions for handling INI files to the lib directory.
   files:
     - source: "config/config.sh"
       target: "%{user_lib_dir}/config.%{user_ext}"
 
-help: Bashly::Libraries::Help
+help:
+  help: Add a help command, in addition to the standard --help flag.
+  handler: Bashly::Libraries::Help
 
 lib:
+  help: |-
+    Create the lib directory for any additional user scripts.
+    All *.sh scripts in this directory will be included in the final bash script.
+    Note that if you configured a different partials_extension, then the extensions of the files in this directory need to match.
   files:
     - source: "lib/sample_function.sh"
       target: "%{user_lib_dir}/sample_function.%{user_ext}"
 
 settings:
+  help: Copy a sample settings.yml file to your project, allowing you to customize some bashly options.
+  skip_src_check: true
   files:
     - source: "settings/settings.yml"
       target: "settings.yml"
 
 strings:
+  help: Copy an additional configuration file to your project, allowing you to customize all the tips and error strings.
   files:
     - source: "strings/strings.yml"
       target: "%{user_source_dir}/bashly-strings.yml"
 
 test:
+  help: Add approval testing.
   files:
     - source: "test/approvals.bash"
       target: "%{user_target_dir}/test/approvals.bash"
@@ -44,6 +67,7 @@ test:
     Docs: bu`https://github.com/DannyBen/approvals.bash`
 
 validations:
+  help: Add argument validation functions to the lib directory.
   files:
     - source: "validations/validate_dir_exists.sh"
       target: "%{user_lib_dir}/validations/validate_dir_exists.%{user_ext}"
@@ -55,6 +79,7 @@ validations:
       target: "%{user_lib_dir}/validations/validate_not_empty.%{user_ext}"
 
 yaml:
+  help: Add standard functions for reading YAML files.
   files:
     - source: "yaml/yaml.sh"
       target: "%{user_lib_dir}/yaml.%{user_ext}"

lib/bashly/library.rb

@@ -37,9 +37,9 @@ def find_file(path)
   private
 
     def custom_handler
-      return nil unless config.is_a? String
+      return nil unless config['handler']
 
-      @custom_handler ||= Module.const_get(config).new(*args)
+      @custom_handler ||= Module.const_get(config['handler']).new(*args)
     end
 
     def target_file_args

spec/approvals/cli/add/comp-error

@@ -1,76 +1,16 @@
 Add extra features and customization to your script
 
 Usage:
-  bashly add colors [--force]
-  bashly add comp FORMAT [OUTPUT --force]
-  bashly add config [--force]
-  bashly add help [--force]
-  bashly add lib [--force]
-  bashly add settings [--force]
-  bashly add strings [--force]
-  bashly add test [--force]
-  bashly add validations [--force]
-  bashly add yaml [--force]
+  bashly add LIBRARY [ARGS...] [--force]
+  bashly add --list
   bashly add (-h|--help)
 
-Commands:
-  colors
-    Add standard functions for printing colorful and formatted text to the lib
-    directory.
-
-  comp
-    Generate a bash completions script or function.
-
-  config
-    Add standard functions for handling INI files to the lib directory.
-
-  help
-    Add a help command, in addition to the standard --help flag.
-
-  lib
-    Create the lib directory for any additional user scripts.
-    All *.sh scripts in this directory will be included in the final bash
-    script.
-    Note that if you configured a different partials_extension, then the
-    extensions of the files in this directory need to match.
-
-  settings
-    Copy a sample settings.yml file to your project, allowing you to customize
-    some bashly options.
-
-  strings
-    Copy an additional configuration file to your project, allowing you to
-    customize all the tips and error strings.
-
-  test
-    Add approval testing.
-
-  validations
-    Add argument validation functions to the lib directory.
-
-  yaml
-    Add standard functions for reading YAML files to the lib directory.
-
 Options:
   -f --force
     Overwrite existing files
 
+  -l --list
+    Show available libraries
+
   -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.
-
-Examples:
-  bashly add strings --force
-  bashly add comp function
-  bashly add comp script completions.bash