diff options
-rwxr-xr-x | .expeditor/run_linux_tests.sh | 2 | ||||
-rw-r--r-- | CHANGELOG.md | 12 | ||||
-rw-r--r-- | README.md | 10 | ||||
-rw-r--r-- | VERSION | 2 | ||||
-rw-r--r-- | lib/mixlib/cli.rb | 4 | ||||
-rw-r--r-- | lib/mixlib/cli/formatter.rb | 2 | ||||
-rw-r--r-- | lib/mixlib/cli/version.rb | 2 | ||||
-rw-r--r-- | spec/mixlib/cli_spec.rb | 2 |
8 files changed, 22 insertions, 14 deletions
diff --git a/.expeditor/run_linux_tests.sh b/.expeditor/run_linux_tests.sh index 4c14c80..2e6c34c 100755 --- a/.expeditor/run_linux_tests.sh +++ b/.expeditor/run_linux_tests.sh @@ -50,4 +50,4 @@ else fi echo "+++ bundle exec task" -bundle exec $1 +bundle exec $@ diff --git a/CHANGELOG.md b/CHANGELOG.md index ccef4ff..0fbebb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,17 @@ # mixlib-cli Changelog -<!-- latest_release --> +<!-- latest_release 2.1.7 --> +## [v2.1.7](https://github.com/chef/mixlib-cli/tree/v2.1.7) (2020-08-21) + +#### Merged Pull Requests +- Fix minor typos [#77](https://github.com/chef/mixlib-cli/pull/77) ([tas50](https://github.com/tas50)) <!-- latest_release --> -<!-- release_rollup --> +<!-- release_rollup since=2.1.6 --> +### Changes not yet released to rubygems.org + +#### Merged Pull Requests +- Fix minor typos [#77](https://github.com/chef/mixlib-cli/pull/77) ([tas50](https://github.com/tas50)) <!-- 2.1.7 --> <!-- release_rollup --> <!-- latest_stable_release --> @@ -109,7 +109,7 @@ Given the following example: ```ruby -# mycli.rb +# my_cli.rb class MyCLI include Mixlib::CLI @@ -166,7 +166,7 @@ In this example, --dep-one will be used. Note that dep_one will not have a valu ```bash -$ ruby mycli.rb --dep-one +$ ruby my_cli.rb --dep-one -1/--dep-one: This flag is deprecated. Use -n/--arg-not-required instead arg_not_required: true @@ -178,12 +178,12 @@ that --arg-required will accept,a nd populate `:arg\_required` with ```bash -$ ruby mycli.rb --dep-two z # 'q' maps to 'invalid' in the value_mapper proc above +$ ruby my_cli.rb --dep-two z # 'q' maps to 'invalid' in the value_mapper proc above -2/--dep-two: This flag is deprecated. Use -a/--arg-required instead. arg_required: a # The value is mapped to its replacement using the function provided. -dep_two: z # the deprected value is kept by default +dep_two: z # the deprecated value is kept by default ``` In this example, the value provided to dep-two will be converted to a value @@ -191,7 +191,7 @@ that --arg-required will reject, showing how content rules are applied even when the input is coming from a deprecated option: ```bash -$ ruby mycli.rb --dep-two q +$ ruby my_cli.rb --dep-two q -2/--dep-two: This flag is deprecated. Use -a/--arg-required instead. -a/--arg-required: invalid is not one of the allowed values: 'a', 'b', or 'c' @@ -1 +1 @@ -2.1.6
\ No newline at end of file +2.1.7
\ No newline at end of file diff --git a/lib/mixlib/cli.rb b/lib/mixlib/cli.rb index a721abf..f69eb04 100644 --- a/lib/mixlib/cli.rb +++ b/lib/mixlib/cli.rb @@ -140,7 +140,7 @@ module Mixlib # and converts it to a value suitable for the new option. # If not provided, the value provided to the deprecated option will be # assigned directly to the converted option. - # keep<Boolean> :: Defaults to true, this ensure sthat `options[:deprecated_flag]` is + # keep<Boolean> :: Defaults to true, this ensures that `options[:deprecated_flag]` is # populated when the deprecated flag is used. If set to false, # only the value in `replacement` will be set. Results undefined # if no replacement is provided. You can use this to enforce the transition @@ -194,7 +194,7 @@ module Mixlib # === Returns # @options<Hash>:: The current options hash. def options=(val) - raise(ArgumentError, "Options must recieve a hash") unless val.is_a?(Hash) + raise(ArgumentError, "Options must receive a hash") unless val.is_a?(Hash) @options = val end diff --git a/lib/mixlib/cli/formatter.rb b/lib/mixlib/cli/formatter.rb index 59f98a4..24a2de7 100644 --- a/lib/mixlib/cli/formatter.rb +++ b/lib/mixlib/cli/formatter.rb @@ -19,7 +19,7 @@ module Mixlib usage end - # @param opt_arry [Array] + # @param opt_array [Array] # # @return [String] a friendly quoted list of items complete with "or" def self.friendly_opt_list(opt_array) diff --git a/lib/mixlib/cli/version.rb b/lib/mixlib/cli/version.rb index a611a0c..c2b805d 100644 --- a/lib/mixlib/cli/version.rb +++ b/lib/mixlib/cli/version.rb @@ -1,5 +1,5 @@ module Mixlib module CLI - VERSION = "2.1.6".freeze + VERSION = "2.1.7".freeze end end diff --git a/spec/mixlib/cli_spec.rb b/spec/mixlib/cli_spec.rb index 91a4a4d..ec9435c 100644 --- a/spec/mixlib/cli_spec.rb +++ b/spec/mixlib/cli_spec.rb @@ -299,7 +299,7 @@ describe Mixlib::CLI do expect(@cli.config[:require_me]).to eql("") end - it "preserves all of the commandline arguments, ARGV" do + it "preserves all of the command line arguments, ARGV" do TestCLI.option(:config_file, short: "-c CONFIG") @cli = TestCLI.new argv_old = ARGV.dup |