Merge pull request #301 from DannyBen/add/help-command-library

Add help command library (bashly add help)

Author: DannyBen

examples/help-command/README.md

@@ -8,10 +8,9 @@ This example was generated with:
 
 ```bash
 $ bashly init
+$ bashly add help
 # ... now edit src/bashly.yml to match the example ...
 $ bashly generate
-# ... now edit src/help_command.sh to match the example ...
-$ bashly generate
 
 ```
 
@@ -88,6 +87,18 @@ commands:
 ## `src/help_command.sh`
 
 ```bash
+## Help command [@bashly-upgrade help]
+## This file is a part of Bashly standard library
+##
+## Add this as a command to your bashly.yml:
+##
+##   commands:
+##     - name: help
+##       help: Show help about a command
+##       args:
+##       - name: command
+##         help: Help subject
+##
 command="${args[command]}"
 long_usage=yes
 
@@ -107,7 +118,6 @@ else
   exit 1
 fi
 
-
 ```
 
 

examples/help-command/src/help_command.sh

@@ -1,3 +1,15 @@
+## Help command [@bashly-upgrade help]
+## This file is a part of Bashly standard library
+##
+## Add this as a command to your bashly.yml:
+##
+##   commands:
+##     - name: help
+##       help: Show help about a command
+##       args:
+##       - name: command
+##         help: Help subject
+##
 command="${args[command]}"
 long_usage=yes
 
@@ -16,4 +28,3 @@ else
   echo "No help available for this command"
   exit 1
 fi
-

examples/help-command/test.sh

@@ -1,7 +1,10 @@
 #!/usr/bin/env bash
 
+rm -f src/*.sh
+
 set -x
 
+bashly add help
 bashly generate
 
 ### Try Me ###

lib/bashly/commands/add.rb

@@ -6,6 +6,7 @@ class Add < Base
       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]'
@@ -32,6 +33,7 @@ class Add < Base
       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', 'Create the additional lib directory for additional user scripts. All *.sh scripts in this ' \
         'folder will be included in the final bash script.'
 
@@ -74,6 +76,10 @@ def config_command
         add_lib 'config'
       end
 
+      def lib_command
+        add_lib 'lib'
+      end
+
       def settings_command
         @skip_src_check = true
         add_lib 'settings'
@@ -83,22 +89,22 @@ def strings_command
         add_lib 'strings'
       end
 
-      def lib_command
-        add_lib 'lib'
-      end
-
       def test_command
         add_lib 'test'
       end
 
-      def yaml_command
-        add_lib 'yaml'
+      def help_command
+        add_lib 'help'
       end
 
       def validations_command
         add_lib 'validations'
       end
 
+      def yaml_command
+        add_lib 'yaml'
+      end
+
     private
 
       def add_lib(name, *args)

lib/bashly/libraries.yml

@@ -12,6 +12,8 @@ config:
     - source: "templates/lib/config.sh"
       target: "%{user_lib_dir}/config.sh"
 
+help: :Help
+
 lib:
   files:
     - source: "templates/lib/sample_function.sh"

lib/bashly/libraries/base.rb

@@ -14,6 +14,16 @@ def files
       def post_install_message
         nil
       end
+
+    protected
+
+      def command
+        @command ||= Script::Command.new config
+      end
+
+      def config
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+      end
     end
   end
 end

lib/bashly/libraries/completions.rb

@@ -1,6 +1,6 @@
 module Bashly
   module Libraries
-    class CompletionsFunction < Completions
+    class CompletionsFunction < Base
       def files
         [
           {

lib/bashly/libraries/completions_function.rb

@@ -1,6 +1,6 @@
 module Bashly
   module Libraries
-    class CompletionsScript < Completions
+    class CompletionsScript < Base
       def files
         [
           {

lib/bashly/libraries/completions_script.rb

@@ -1,6 +1,6 @@
 module Bashly
   module Libraries
-    class CompletionsYAML < Completions
+    class CompletionsYAML < Base
       def files
         [
           {