bashly 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9f48152171cac044c5f26ec11f6fcdad64d9bb5fcf3363ab23a609d24c5b3b
-  data.tar.gz: 7ffcba2d9cc3448f0e08972086c5518dfc7d5c0b2969f5f112045b6b5f114f4f
+  metadata.gz: ebe193249a02f2a5d25cd5a80a3172dbbc43ea16d18653368e4687841f19846c
+  data.tar.gz: d38bbde76e731eaf5a0455edc8b47ef011c6c8dba40ec9a220f7747bb98b238c
 SHA512:
-  metadata.gz: 6fe841722c54b62f72ddce5afdd8448feb30e973a034e623146981b1166be57826238eec5d5e2ac18e3d8357872b5305709110302ae13a7ce5130a0aa46d3a87
-  data.tar.gz: 6d93748b46b22c2e42f5abcd8751e99454545da4293e7a8deeca28869be8df4eccc980d21ca4e4e2acb6b682a2b5451fddc5e339759f40bbb4202e15923cdceb
+  metadata.gz: d0963491e70542e96061395cbe7568d8c77014024ca53bdf2e56c93c3a2588bd5d46ea9e6952d8d0c1166772e46d47f69227c0e45e763970120a805079cd60a8
+  data.tar.gz: 9896cbf1635cf43f30c42452273c93bed40fbb4d126d9dcf921fdc6a9609b3db70a0a2cee5e7753e8974a182b550c3976ac8d45d968399ed870f0c27ca43d73e

data/README.md

@@ -22,10 +22,10 @@ Create beautiful bash scripts from simple YAML configuration
 - [Prerequisites](#prerequisites)
 - [What is Bashly](#what-is-bashly)
 - [Usage](#usage)
-  - [Using the input arguemnts in your code](#using-the-input-arguemnts-in-your-code)
+  - [Using the input arguments in your code](#using-the-input-arguments-in-your-code)
 - [Examples](#examples)
-  - [Sample configuraiton for a script without commands](#sample-configuraiton-for-a-script-without-commands)
-  - [Sample configuraiton for a script with commands](#sample-configuraiton-for-a-script-with-commands)
+  - [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)
@@ -113,7 +113,7 @@ Finally, edit the files in the `src` folder. Each of your script's commands
 get their own file. Once you edit, run `bashly generate` again to merge the
 content from your functions back into the script.
 
-### Using the input arguemnts in your code
+### Using the input arguments in your code
 
 In order to access the parsed arguments in any of your partial scripts, you
 may simply access the `$args` associative array.
@@ -163,13 +163,13 @@ This is detected automatically by the contents of the configuration: If it
 contains a `commands` definition, it will generate a script with commands.
 
 
-### Sample configuraiton for a script without 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 configuraiton for a script with commands
+### 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)
@@ -193,7 +193,7 @@ The `bashly.yml` configuration file consists of these types:
 
 ### Command options
 
-Unless otherwise specified, these definitiona can be used for both the root
+Unless otherwise specified, these definitions can be used for both the root
 command and subcommands (under the `commands` definition).
 
  Option    | Description
@@ -202,12 +202,12 @@ 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 `true` on any command, will make unrecognized command line arguments to be passed to this command. *Applicable only in subcommands*.
+`default`  | Setting this to `true` on any command, will cause any unrecognized command line 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 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.
+`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.
+`args`     | Specify the array of [positional arguments](#argument-options) this script needs.
+`flags`    | Specify the array of option [flags](#flag-options) this script needs.
 `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.
@@ -274,9 +274,9 @@ set.
 If you experience any issue, have a question or a suggestion, or if you wish
 to contribute, feel free to [open an issue][issues].
 
+
+
 [issues]: https://github.com/DannyBen/bashly/issues
 [rush]: https://github.com/DannyBen/rush-cli
 [alf]: https://github.com/DannyBen/alf
 [git-changelog]: https://github.com/DannyBen/git-changelog
-
-

data/lib/bashly/extensions/string.rb

@@ -16,7 +16,6 @@ class String
     strip!
     split("\n").collect! do |line|
       if line.length > length
-        line.gsub!(/([^\s]{#{length}})([^\s$])/, "\\1 \\2")
         line.gsub(/(.{1,#{length}})(\s+|$)/, "\\1\n").rstrip
       else
         line

data/lib/bashly/models/command.rb

@@ -41,6 +41,7 @@ module Bashly
         end
       end
 
+      # Returns a used defined help string for the catch_all directive
       def catch_all_help
         return nil unless catch_all
 

data/lib/bashly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole