bashly 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51726b1606a72cbed1bd541c1ec4043e1d3ee8fd84dcea162746cb953e6684f9
-  data.tar.gz: 965346a4e52205af43220f893b9c30978df49f376f1067ce4a25d8a4dda3c0b8
+  metadata.gz: 7839064a69e5280ef2fcf0112ee9a4442912f99308a8c99dd3cf57c48fc905d2
+  data.tar.gz: '0923d678dd93f16ec6beb2bb796e679b355fe971fc7141910c5b62d025ccfc4b'
 SHA512:
-  metadata.gz: bb165ce7cd9ed5a399d1792993d15e3939879e4462d23b89cb3ebad8e8964d75ab629c2ab5286b293a456a78d9daf567b2ac0235c00fc568da20cd4c201d2137
-  data.tar.gz: b87760cde516cb1964a90ce6017ea922198d67530c741e95c1c75e6568d9bb57653b3ed79b5613307ef188827ada05f4f4c97ba4f7e576e07d15962a126fddbb
+  metadata.gz: ec45676addca44ee7ce775b505d368b29723ed689e890592608a96a36fc64f8570dfd15a2df3a82b6a7e4bd2081db6338d11de0b285488d4af8145a83205cdb1
+  data.tar.gz: cd6303a9834570a1d7a4a8d17ee796c72a116454cc1831af7a8897113419557840e1e1c94117abb06f9510dfb4b2aa4e7aafc67ce65eca2fcd0cd8ee56d0f8cd

data/README.md

@@ -41,11 +41,11 @@ Bahsly is responsible for:
 
 - Generating a **single, standalone bash script**.
 - Generating **usage texts** and help screens, showing your tool's arguments, 
-  flags and subcommands (works for subcommands also).
+  flags and commands (works for subcommands also).
 - Parsing the user's command line and extracting:
   - Optional or required **positional arguments**.
   - Optional or required **option flags** (with or without flag arguments).
-  - **Subcommands** (and sub-subcommands).
+  - **Commands** (and subcommands).
   - Standard flags (like **--help** and **--version**).
 - Providing you with a place to input your code for each of the functions 
   your tool performs, and merging it back to the final script.
@@ -67,7 +67,7 @@ $ bashly init --minimal
 ```
 
 This will create a sample `src/bashly.yml` file.
-You can edit this file to specify which arguments, flags and subcommands you
+You can edit this file to specify which arguments, flags and commands you
 need in your bash script.
 
 Then, generate an initial bash script and function placeholder scripts by
@@ -92,24 +92,24 @@ Examples
 
 The `bashly.yml` file can be set up to generate two types of scripts:
 
-1. Script with subcommands (for example, like `docker` or `git`).
-2. Script without subcommands (for example, like `ls`)
+1. Script with commands (for example, like `docker` or `git`).
+2. Script without commands (for example, like `ls`)
 
 This is detected automatically by the contents of the configuration: If it
-contains a `commands` definition, it will generate a script with subcommands.
+contains a `commands` definition, it will generate a script with commands.
 
 
-### Sample configuraiton for a script without subcommands
+### Sample configuraiton for a script without commands
 
 - Generate this script by running `bashly generate --minimal`
 - [See the initial sample bashly.yml file](examples/minimal/src/bashly.yml)
 - [See the generated bash script](examples/minimal/download)
 
-### Sample configuraiton for a script with subcommands
+### Sample configuraiton for a script with commands
 
 - Generate this script by running `bashly generate`
-- [See the initial sample bashly.yml file](examples/subcommands/src/bashly.yml)
-- [See the generated bash script](examples/subcommands/cli)
+- [See the initial sample bashly.yml file](examples/commands/src/bashly.yml)
+- [See the generated bash script](examples/commands/cli)
 
 
 See the [examples](examples) folder for more examples.
@@ -140,13 +140,14 @@ command and subcommands (under the `commands` definition).
 `short`    | An additional, optional pattern - usually used to denote a one letter variation of the command name. You can add `*` as a suffix, to denote a "starts with" pattern - for example `short: m*`. *Applicable only in subcommands*.
 `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 `yes` on any subcommand, will make unrecognized command line arguments to be passed to this command. *Applicable only in subcommands*.
+`default`  | Setting this to `yes` on any command, will make unrecognized command line arguments to be passed to this command. *Applicable only in subcommands*.
 `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 needed by your script. 
-`commands` | Specify the array of subcommands. Each subcommand will have its own args and flags. Note: if `commands` is provided, you cannot specify flags or args at the same level.
+`commands` | Specify the array of commands. Each command will have its own args and flags. Note: if `commands` is provided, you cannot specify flags or args at the same level.
 `args`     | Specify the array of positional arguments this script needs.
 `flags`    | Specify the array of option flags this script needs.
 `dependencies` | Specify an array of any required external dependencies (commands). The script execution will be halted with a friendly error unless all dependency commands exist.
+`group`    | In case you have many commands, use this option to specify a caption to display before this command. This option is purely for display purposes, and needs to be specified only for the first command in each group.
 
 ### Argument options
 

data/lib/bashly/commands/init.rb

@@ -7,7 +7,7 @@ module Bashly
       usage "bashly init [--minimal]"
       usage "bashly init (-h|--help)"
 
-      option "-m --minimal", "Use a minimal configuration file (without subcommands)"
+      option "-m --minimal", "Use a minimal configuration file (without commands)"
 
       environment "BASHLY_SOURCE_DIR", "The path to use for creating the configuration file [default: src]"
 

data/lib/bashly/models/base.rb

@@ -13,6 +13,7 @@ module Bashly
         environment_variables
         examples
         flags
+        group
         help
         long
         name

data/lib/bashly/models/command.rb

@@ -28,12 +28,12 @@ module Bashly
         help ? "#{full_name} - #{summary}" : full_name
       end
 
-      # Returns only the names of the subcommands (Commands)
+      # Returns only the names of the Commands
       def command_names
         commands.map &:name
       end
 
-      # Returns an array of the subcommands (Commands)
+      # Returns an array of the Commands
       def commands
         return [] unless options["commands"]
         options["commands"].map do |options|

data/lib/bashly/templates/minimal.yml

@@ -1,5 +1,5 @@
 name: download
-help: Sample minimal application without subcommands
+help: Sample minimal application without commands
 version: 0.1.0
 
 args:

data/lib/bashly/templates/strings.yml

@@ -8,6 +8,7 @@ arguments: "Arguments:"
 commands: "Commands:"
 examples: "Examples:"
 environment_variables: "Environment Variables:"
+group: "%{group} Commands:"
 
 # Usage helpers
 command_shortcut: "Shortcut: %{short}"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

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

@@ -1,9 +1,18 @@
 # :command.usage_commands
+<%- unless commands.first.group -%>
 printf "<%= strings[:commands] %>\n"
+<%- end -%>
 <%- maxlen = command_names.map(&:size).max -%>
 <%- commands.each do |command| -%>
 <%- summary = command.summary -%>
 <%- summary = strings[:default_command_summary] % { summary: summary } if command.default -%>
+<%- if command.group -%>
+<%- if command.name == commands.first.name -%>
+printf "<%= strings[:group] % { group: command.group } %>\n"
+<%- else -%>
+printf "\n<%= strings[:group] % { group: command.group } %>\n"
+<%- end -%>
+<%- end -%>
 echo "  <%= command.name.ljust maxlen %>   <%= summary %>"
 <%- end -%>
 echo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole