bashly 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b573ae52d9c93016675adc209eeb011d3f6897791b0e159e25af5a76e7290d6
-  data.tar.gz: 69b99fb9b6729dd21d748688c11041130f3e35852212d148afe8af715b13804f
+  metadata.gz: ca34648c628c4e7fe167d5f5b0d253792e9b4d3c494b253ed68d0127e4935572
+  data.tar.gz: 5247da7780a8424dd0a808ace6d182ed4284597e094122d94a8716bfca8f343b
 SHA512:
-  metadata.gz: f624d54df411325e3b4b6c8446a56d6e6bbd22e9caa2310c13d4c9d254920f84db1f19684355255374cbfa41653020a9f9d848acfa97afb88d76e448928f00d7
-  data.tar.gz: 1a98f13669d2de4a9b092afba7fdaebff16c0647a41ccf1696b6abdcda114661e6fb9995cfba1e0da348e30c79a9ae0777078bff3fc8a82cdcfd650c152c528b
+  metadata.gz: 2145d1f4125d762c3d583f560c4caa9f4b98cfc2500e7e7b9ac977f4284a190a150a26da6e935c4e59c689f5efcd627924a10091cff0d4d91f00c3f60d26b943
+  data.tar.gz: 9df4695f43e4c57371f876de1dee3eab587bb227b7b0ee51d52d1772faf119cbd59cb117f5a1e3cbb06ef49b5796cd02b6fecba685b733aa35c51442fe9baf19

data/README.md

@@ -15,6 +15,7 @@ Create beautiful bash scripts from simple YAML configuration
 
 </div>
 
+
 ## Table of Contents
 
 - [Table of Contents](#table-of-contents)
@@ -24,19 +25,18 @@ Create beautiful bash scripts from simple YAML configuration
 - [Usage](#usage)
   - [Using the input arguments in your code](#using-the-input-arguments-in-your-code)
 - [Examples](#examples)
-  - [Sample configuration for a script without commands](#sample-configuration-for-a-script-without-commands)
-  - [Sample configuration for a script with commands](#sample-configuration-for-a-script-with-commands)
 - [Configuration Reference](#configuration-reference)
   - [Command options](#command-options)
   - [Argument options](#argument-options)
   - [Flag options](#flag-options)
   - [Environment Variable options](#environment-variable-options)
-- [Extensible Commands](#extensible-commands)
+- [Extensible Scripts](#extensible-scripts)
 - [Real World Examples](#real-world-examples)
 - [Contributing / Support](#contributing--support)
 
 ---
 
+
 ## Installation
 
 ```shell
@@ -84,8 +84,17 @@ Bahsly is responsible for:
   - **YAML parsing**.
   - and more.
 
+
 ## Usage
 
+The `bashly.yml` file can be set up to generate two types of scripts:
+
+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 commands.
+
 In an empty directory, create a sample configuration file by running
 
 ```shell
@@ -153,32 +162,11 @@ $ ./download a --force
 downloading a with --force
 ```
 
-## Examples
 
-The `bashly.yml` file can be set up to generate two types of scripts:
-
-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 commands.
-
-
-### Sample configuration 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 configuration for a script with commands
-
-- Generate this script by running `bashly generate`
-- [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.
+## Examples
 
+The [examples folder](examples#readme) contains many detailed and documented 
+example configuration files, with their output.
 
 
 ## Configuration Reference
@@ -204,7 +192,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).
+`extensible` | Specify that this command can be [externally extended](#extensible-scripts). *Applicable only in the main command*.
 `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.
@@ -213,6 +201,7 @@ command and subcommands (under the `commands` definition).
 `catch_all` | Specify that this command should allow for additional arbitrary arguments or flags. It can be set in one of three ways:<br>- Set to `true` to just enable it.<br>- Set to a string, to use this string in the usage help text.<br>- Set to a hash containing `label` and `help` keys, to show a detailed help for it when running with `--help`.
 `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.
+`footer` | Add a custom message that will be displayed at the end of the `--help` text. 
 
 ### Argument options
 
@@ -249,9 +238,7 @@ The `-v` and `-h` flags will be used as the short options for `--version` and
 `--help` respectively **only if you are not using them in any of your own
 flags**.
 
-### Environment Variable options
-
-The below configuration generates this environment variable usage text:
+### Environment variable options
 
 If an environment variable is defined as required (false by default), the
 execution of the script will be halted with a friendly error if it is not
@@ -264,7 +251,7 @@ set.
 `required` | Specify if this variable is required.
 
 
-## Extensible Commands
+## Extensible Scripts
 
 You may configure your generated bash script to delegate any unknown command
 to an external executable, by setting the `extensible` option to either `true`,
@@ -339,7 +326,6 @@ 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

@@ -16,6 +16,7 @@ module Bashly
         examples
         extensible
         flags
+        footer
         group
         help
         long

data/lib/bashly/version.rb

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

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

@@ -0,0 +1,2 @@
+printf "<%= footer.gsub("\n", '\n').gsub('"', '\"') %>\n"
+echo

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

@@ -40,6 +40,7 @@
 <%= render(:usage_args).indent 4 if args.any? or catch_all_help %>
 <%= render(:usage_environment_variables).indent 4 if environment_variables.any? %>
 <%= render(:usage_examples).indent 4 if examples %>
+<%= render(:footer).indent 4 if footer %>
 
   fi
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -102,6 +102,7 @@ files:
 - lib/bashly/views/command/dependencies_filter.erb
 - lib/bashly/views/command/environment_variables_filter.erb
 - lib/bashly/views/command/fixed_flags_filter.erb
+- lib/bashly/views/command/footer.erb
 - lib/bashly/views/command/function.erb
 - lib/bashly/views/command/initialize.erb
 - lib/bashly/views/command/inspect_args.erb