command_kit 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d04119403fa9585e0258d2b20bb7c307d124aafb70c88e03749395c7b4eedb97
-  data.tar.gz: 3ec992adf12bbc98313bb6ff8f3038091b50b31abbf8950765a71edd771378fb
+  metadata.gz: 306f055fa898d4d82c14ba8e79b397ae413280bb7144ce69e1787081620827e9
+  data.tar.gz: e79e640f7d4ae566401e7543d3ba98aa42b1e2396657734e29ab3cd3b383b41c
 SHA512:
-  metadata.gz: faeeaa08921ab315a825d4b1ff69f6b254c53b6675dd4278478b77200d6d2afb688d110757685ed33d74b90a6b1e9394c12135c3ab5f08e2ca3ca5834ead248d
-  data.tar.gz: 6b4ba3da0434c9fbd93d92a4c9d91e8eb53f1185df15edb21283c09b2ddf9ec4dc9fcb3708bdf83a1158cef92c988ccb5133ec5664ac9dcb213bdcde45aacf3d
+  metadata.gz: ee4268377db8c2398b5157feda9fa106a0b156537c6085b71fcfd8c7710f898c3bc0ef5d4408d9c6cbcae932e4f4ee4dd49070003e6c5734da06da33fbbace9a
+  data.tar.gz: 03b6a48369bea030002f9432d0d8645d8c0f5cdefba81778922e73a54f267611419bdb63e5033e98b09aa1c6ae97af1e8c3b8135cb7ed4b807fce666c6c379b8

data/.github/workflows/ruby.yml

@@ -12,6 +12,7 @@ jobs:
         ruby:
           - 2.7
           - 3.0
+          - 3.1
           # TODO: uncomment when jruby supports ruby >= 2.7
           # - jruby
           # TODO: uncomment when truffleruby supports splatting empty kwargs

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
 # our rules
 #
 
-Layout/FirstArrayElementIndentation: { EnforcedStyle: consistent }
+Layout/FirstArrayElementIndentation: { Exclude: ['spec/**/*'] }
 Layout/LineLength: { Enabled: false }
 Layout/SpaceAroundEqualsInParameterDefault: { EnforcedStyle: no_space }
 Lint/ConstantDefinitionInBlock: { Exclude: ['spec/**/*'] }

data/ChangeLog.md

@@ -1,3 +1,67 @@
+### 0.3.0 / 2021-12-26
+
+* Added {CommandKit::FileUtils}.
+
+#### CommandKit::FileUtils
+
+* Added {CommandKit::FileUtils#erb #erb}.
+
+#### CommandKit::Colors
+
+* Added {CommandKit::Colors::ANSI::RESET_FG RESET_FG}.
+* Added {CommandKit::Colors::ANSI.bright_black bright_black}.
+* Added {CommandKit::Colors::ANSI.gray gray}.
+* Added {CommandKit::Colors::ANSI.bright_red bright_red}.
+* Added {CommandKit::Colors::ANSI.bright_green bright_green}.
+* Added {CommandKit::Colors::ANSI.bright_yellow bright_yellow}.
+* Added {CommandKit::Colors::ANSI.bright_blue bright_blue}.
+* Added {CommandKit::Colors::ANSI.bright_magenta bright_magenta}.
+* Added {CommandKit::Colors::ANSI.bright_cyan bright_cyan}.
+* Added {CommandKit::Colors::ANSI.bright_white bright_white}.
+* Added {CommandKit::Colors::ANSI.on_bright_black on_bright_black}.
+* Added {CommandKit::Colors::ANSI.on_gray on_gray}.
+* Added {CommandKit::Colors::ANSI.on_bright_red on_bright_red}.
+* Added {CommandKit::Colors::ANSI.on_bright_green on_bright_green}.
+* Added {CommandKit::Colors::ANSI.on_bright_yellow on_bright_yellow}.
+* Added {CommandKit::Colors::ANSI.on_bright_blue on_bright_blue}.
+* Added {CommandKit::Colors::ANSI.on_bright_magenta on_bright_magenta}.
+* Added {CommandKit::Colors::ANSI.on_bright_cyan on_bright_cyan}.
+* Added {CommandKit::Colors::ANSI.on_bright_white on_bright_white}.
+
+#### ComandKit::Options
+
+* Allow grouping options into categories:
+
+      option :opt1, category: 'Foo Options',
+                    desc: 'Option 1'
+
+      option :opt2, category: 'Foo Options',
+                    desc: 'Option 1'
+
+* Allow options to have multi-line descriptions:
+
+      option :opt1, short: '-o',
+                    desc: [
+                            'line1',
+                            'line2',
+                            '...'
+                          ]
+
+#### CommandKit::Arguments
+
+* Allow arguments to have multi-line descriptions:
+
+      argument :arg1, desc: [
+                              'line1',
+                              'line2',
+                              '...'
+                            ]
+
+
+#### CommandKit::ProgramName
+
+* Added {CommandKit::ProgramName#command_name}.
+
 ### 0.2.2 / 2021-12-26
 
 #### CommandKit::Help::Man

data/lib/command_kit/arguments/argument.rb

@@ -16,7 +16,7 @@ module CommandKit
 
       # The argument's description.
       #
-      # @return [String]
+      # @return [String, Array<String>]
       attr_reader :desc
 
       #
@@ -34,7 +34,7 @@ module CommandKit
       # @param [Boolean] repeats
       #   Specifies whether the argument can be repeated multiple times.
       #
-      # @param [String] desc
+      # @param [String, Array<String>] desc
       #   The description for the argument.
       #
       # @yield [(value)]

data/lib/command_kit/arguments.rb

@@ -46,6 +46,14 @@ module CommandKit
   #     def run(*files)
   #     end
   #
+  # ### Multi-line descriptions
+  #
+  #     argument :arg, desc: [
+  #                            'line1',
+  #                            'line2',
+  #                            '...'
+  #                          ]
+  #
   module Arguments
     include Usage
     include Main
@@ -114,7 +122,7 @@ module CommandKit
       # @option kwargs [Boolean] repeats
       #   Specifies whether the argument can be repeated multiple times.
       #
-      # @option kwargs [String] desc
+      # @option kwargs [String, Array<String>] desc
       #   The description for the argument.
       #
       # @return [Argument]
@@ -123,6 +131,12 @@ module CommandKit
       # @example Define an argument:
       #     argument :bar, desc: "Bar argument"
       #
+      # @example Defines an argument with a multi-line description:
+      #     argument :bar, desc: [
+      #                            "Line 1 ...",
+      #                            "Line 2 ..."
+      #                          ]
+      #
       # @example With a custom usage string:
       #     argument :bar, usage: 'BAR',
       #                    desc: "Bar argument"
@@ -191,7 +205,18 @@ module CommandKit
         puts 'Arguments:'
 
         arguments.each_value do |arg|
-          puts "    #{arg.usage.ljust(33)}#{arg.desc}"
+          case arg.desc
+          when Array
+            arg.desc.each_with_index do |line,index|
+              if index == 0
+                puts "    #{arg.usage.ljust(33)}#{line}"
+              else
+                puts "    #{' '.ljust(33)}#{line}"
+              end
+            end
+          else
+            puts "    #{arg.usage.ljust(33)}#{arg.desc}"
+          end
         end
       end
     end