bashly 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebe193249a02f2a5d25cd5a80a3172dbbc43ea16d18653368e4687841f19846c
-  data.tar.gz: d38bbde76e731eaf5a0455edc8b47ef011c6c8dba40ec9a220f7747bb98b238c
+  metadata.gz: 6b573ae52d9c93016675adc209eeb011d3f6897791b0e159e25af5a76e7290d6
+  data.tar.gz: 69b99fb9b6729dd21d748688c11041130f3e35852212d148afe8af715b13804f
 SHA512:
-  metadata.gz: d0963491e70542e96061395cbe7568d8c77014024ca53bdf2e56c93c3a2588bd5d46ea9e6952d8d0c1166772e46d47f69227c0e45e763970120a805079cd60a8
-  data.tar.gz: 9896cbf1635cf43f30c42452273c93bed40fbb4d126d9dcf921fdc6a9609b3db70a0a2cee5e7753e8974a182b550c3976ac8d45d968399ed870f0c27ca43d73e
+  metadata.gz: f624d54df411325e3b4b6c8446a56d6e6bbd22e9caa2310c13d4c9d254920f84db1f19684355255374cbfa41653020a9f9d848acfa97afb88d76e448928f00d7
+  data.tar.gz: 1a98f13669d2de4a9b092afba7fdaebff16c0647a41ccf1696b6abdcda114661e6fb9995cfba1e0da348e30c79a9ae0777078bff3fc8a82cdcfd650c152c528b

data/README.md

@@ -31,6 +31,7 @@ Create beautiful bash scripts from simple YAML configuration
   - [Argument options](#argument-options)
   - [Flag options](#flag-options)
   - [Environment Variable options](#environment-variable-options)
+- [Extensible Commands](#extensible-commands)
 - [Real World Examples](#real-world-examples)
 - [Contributing / Support](#contributing--support)
 
@@ -203,6 +204,7 @@ command and subcommands (under the `commands` definition).
 `help`     | The header text to display when using `--help`. This option can have multiple lines. In this case, the first line will be used as summary wherever appropriate.
 `version`  | The string to display when using `--version`. *Applicable only in the main command*.
 `default`  | Setting this to `true` on any command, will cause any unrecognized command line to be passed to this command. *Applicable only in subcommands*.
+`extensible` | Specify that this command can be [externally extended](#extensible-commands).
 `examples` | Specify an array of examples to show when using `--help`. Each example can have multiple lines.
 `environment_variables` | Specify an array of [environment variables](#environment-variable-options) needed by your script. 
 `commands` | Specify the array of [commands](#command-options). Each command will have its own args and flags. Note: if `commands` is provided, you cannot specify flags or args at the same level.
@@ -262,6 +264,82 @@ set.
 `required` | Specify if this variable is required.
 
 
+## Extensible Commands
+
+You may configure your generated bash script to delegate any unknown command
+to an external executable, by setting the `extensible` option to either `true`,
+or to a different external command.
+
+This is similar to how `git` works. When you execute `git whatever`, the `git`
+command will look for a file named `git-whatever` in the path, and execute it.
+
+Note that this option cannot be specified together with the `default` option,
+since both specify a handler for unknown commands.
+
+Bashly supports two operation modes.
+
+### Extension Mode (`extensible: true`)
+
+By setting `extensible` to `true`, a specially named executable will be called
+when an unknown command is called by the user.
+
+Given this `bashly.yml` configuration:
+
+```yaml
+name: myscript
+help: Example
+version: 0.1.0
+extensible: true
+
+commands:
+- name: upload
+  help: Upload a file
+```
+
+And this user command:
+
+```
+$ myscript something
+
+```
+
+The generated script will look for an executable named `myscript-something` 
+in the path. If found, it will be called.
+
+See the [extensible example](examples/extensible).
+
+
+### Delegate Mode (`extensible: <executable name>`)
+
+By setting `extensible` to any string, unknown command calls by the user will
+be delegated to the executable with that name.
+
+Given this `bashly.yml` configuration:
+
+```yaml
+name: mygit
+help: Example
+version: 0.1.0
+extensible: git
+
+commands:
+- name: push
+  help: Push to my repository
+```
+
+And this user command:
+
+```
+$ mygit status
+
+```
+
+The generated script will execute `git status`.
+
+See the [extensible-delegate example](examples/extensible-delegate).
+
+
+
 ## Real World Examples
 
 - [Rush][rush] - a Personal Package Manager

data/lib/bashly/models/base.rb

@@ -14,6 +14,7 @@ module Bashly
         description
         environment_variables
         examples
+        extensible
         flags
         group
         help

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.4.5"
+  VERSION = "0.5.0"
 end

data/lib/bashly/views/command/command_fallback.erb

@@ -0,0 +1,45 @@
+# :command.command_fallback
+<%- if default_command -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  action="<%= default_command.name %>"
+  <%= default_command.function_name %>_parse_requirements "$@"
+  shift $#
+  ;;
+<%- elsif extensible.is_a? String -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  if [[ -x "$(command -v "<%= extensible %>")" ]]; then
+    exec <%= extensible %> "$@"
+  else
+    <%= function_name %>_usage
+    exit 1
+  fi
+<%- elsif extensible -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  if [[ -x "$(command -v "<%= function_name %>-$action")" ]]; then
+    shift
+    exec "<%= function_name %>-$action" "$@"
+  else
+    <%= function_name %>_usage
+    exit 1
+  fi
+<%- else -%>
+* )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+<%- end -%>

data/lib/bashly/views/command/command_filter.erb

@@ -15,25 +15,7 @@ case $action in
   ;;    
 
 <%- end -%>
-<%- if default_command -%>
-"" )
-  <%= function_name %>_usage
-  exit 1
-  ;;
-
-* )
-  action="<%= default_command.name %>"
-  <%= default_command.function_name %>_parse_requirements "$@"
-  shift $#
-  ;;
-
-<%- else -%>
-* )
-  <%= function_name %>_usage
-  exit 1
-  ;;
-
-<%- end -%>
+<%= render :command_fallback %>
 esac
 <%- else -%>
 action="<%= action_name %>"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -92,6 +92,7 @@ files:
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
+- lib/bashly/views/command/command_fallback.erb
 - lib/bashly/views/command/command_filter.erb
 - lib/bashly/views/command/command_functions.erb
 - lib/bashly/views/command/default_assignments.erb