philiprehberger-cli_kit 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62b7b5d92fab1ecd92a23be447b3fbc30954178eee755845f9a7f37e6de6e079
-  data.tar.gz: 9ea01598fc9e677cb480d92b66c00594df89dced14179144bd630052a97ad73c
+  metadata.gz: 895e4a8ff9edcfa13591e60cd91454c81840404c61b724e3394d234b71f8e496
+  data.tar.gz: b789d3b41ab39145500841661603728c8edccc438ab577319c6166bdf27230cb
 SHA512:
-  metadata.gz: 3fd67e90ab104d28e6a759c360fc7609f4d0fee691bf0a0f21d828c54ca38b56974abd10e965293c96b7e98a9152e8c73fc90f6e1d5afcbe3a0d648386bbdc2a
-  data.tar.gz: '0459248772c329302ed8fdd2c798cb153e29e131f8f93656250a75fd7537edfef6f37c10c48b829533dafe33f272ed5e824d7a0958135cc8cb7adfebbbbe8360'
+  metadata.gz: 6b708dc9eadf82852b3d683f32dd4adeeaae2bc0f3985ce2c338930a58cc1cb8bbe2cff17a929578907ffe68ae1c63a38ff115129fefdb68a531a18c467d0650
+  data.tar.gz: 94e8d68950132d59d2ed894d356374269989d5f73db2837897f957cc3fd70011f5f1b4c96f8ba75554b7069c65900c1385bf357885ba925346009da154ba011f

data/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2026-04-25
+
+### Added
+- ANSI color helpers via `CliKit.color`, `CliKit.bold`, `CliKit.dim` and the `CliKit::Colorize` module
+- Automatic disable when stdout is not a TTY or `NO_COLOR` is set
+
+## [0.4.0] - 2026-04-18
+
+### Added
+- `option :name, required: true` — DSL flag that raises `CliKit::Error` at parse time when the option is omitted; help output appends `(required)` to the option's description
+
 ## [0.3.1] - 2026-04-15
 
 ### Changed
@@ -63,7 +74,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Animated spinner for long-running operations
 - Positional argument collection
 
-[Unreleased]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.3.1...HEAD
+[Unreleased]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/philiprehberger/rb-cli-kit/compare/v0.2.0...v0.2.1

data/README.md

@@ -105,6 +105,20 @@ port = Philiprehberger::CliKit.ask('Port:', error: 'Must be a number') do |answe
 end
 ```
 
+### Required options
+
+```ruby
+result = Philiprehberger::CliKit.parse(ARGV) do
+  option :env, short: :e, required: true, desc: 'Target environment'
+end
+
+# Invoked without --env raises Philiprehberger::CliKit::Error:
+#   Missing required option(s): --env
+#
+# Help text appends "(required)" to the option's description:
+#   -e, --env VALUE     Target environment (required)
+```
+
 ### Repeatable Options
 
 ```ruby
@@ -163,6 +177,17 @@ data = Philiprehberger::CliKit.spinner('Loading data...') do
 end
 ```
 
+### Color Output
+
+Colors are auto-disabled when stdout is not a TTY or the `NO_COLOR` environment variable is set.
+
+```ruby
+require "philiprehberger/cli_kit"
+
+puts Philiprehberger::CliKit.color('OK', :green)
+puts Philiprehberger::CliKit.bold('Important')
+```
+
 ## API
 
 | Method | Description |
@@ -175,7 +200,11 @@ end
 | `.select(message, choices)` | Present numbered menu and return one selection |
 | `.multi_select(message, choices, defaults:)` | Present numbered menu and return multiple selections |
 | `.spinner(message) { ... }` | Show spinner during block execution |
+| `.color(text, name)` | Wrap text in ANSI color (no-op when not a TTY or NO_COLOR set) |
+| `.bold(text)` | Wrap text in ANSI bold |
+| `.dim(text)` | Wrap text in ANSI dim |
 | `Parser#option(name, multi: true)` | Collect repeated option values into an array |
+| `Parser#option(name, required: true)` | Raise `CliKit::Error` at parse time when the option is omitted |
 | `Parser#flags` | Hash of boolean flag values |
 | `Parser#options` | Hash of option values (arrays when `multi: true`) |
 | `Parser#arguments` | Array of positional arguments |

data/lib/philiprehberger/cli_kit/colorize.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CliKit
+    # ANSI color and style helpers. Output is auto-disabled when stdout is not a
+    # TTY or the NO_COLOR environment variable is set (per https://no-color.org).
+    module Colorize
+      CODES = {
+        red: 31, green: 32, yellow: 33, blue: 34,
+        magenta: 35, cyan: 36, white: 37, gray: 90
+      }.freeze
+
+      module_function
+
+      # @return [Boolean] true when ANSI escape codes should be emitted
+      def enabled?
+        return false if ENV.key?('NO_COLOR')
+
+        $stdout.tty?
+      end
+
+      # Wraps text in an ANSI color escape, or returns it untouched when colors
+      # are disabled.
+      #
+      # @param text [String]
+      # @param name [Symbol] one of :red, :green, :yellow, :blue, :magenta, :cyan, :white, :gray
+      # @return [String]
+      def color(text, name)
+        return text unless enabled?
+
+        code = CODES.fetch(name) { raise ArgumentError, "unknown color: #{name.inspect}" }
+        "\e[#{code}m#{text}\e[0m"
+      end
+
+      # @param text [String]
+      # @return [String]
+      def bold(text)
+        return text unless enabled?
+
+        "\e[1m#{text}\e[0m"
+      end
+
+      # @param text [String]
+      # @return [String]
+      def dim(text)
+        return text unless enabled?
+
+        "\e[2m#{text}\e[0m"
+      end
+    end
+  end
+end

data/lib/philiprehberger/cli_kit/parser.rb

@@ -13,6 +13,7 @@ module Philiprehberger
         @flags = {}
         @options = {}
         @arguments = []
+        @supplied_options = []
         @command_name = nil
         @program_name = nil
       end
@@ -35,9 +36,12 @@ module Philiprehberger
       # @param default [Object, nil] default value
       # @param desc [String, nil] description for help text
       # @param multi [Boolean] when true, collect repeated values into an array
+      # @param required [Boolean] when true, raise if the option is not supplied at parse time
       # @return [void]
-      def option(name, short: nil, default: nil, desc: nil, multi: false)
-        @option_definitions[name] = { short: short, default: default, desc: desc, multi: multi }
+      def option(name, short: nil, default: nil, desc: nil, multi: false, required: false)
+        @option_definitions[name] = {
+          short: short, default: default, desc: desc, multi: multi, required: required
+        }
         @options[name] = multi ? [] : default
       end
 
@@ -131,6 +135,7 @@ module Philiprehberger
             @arguments << arg
           end
         end
+        validate_required_options!
         self
       end
 
@@ -172,6 +177,7 @@ module Philiprehberger
 
       def assign_option(name, value)
         defn = @option_definitions[name]
+        @supplied_options << name
         if defn && defn[:multi]
           @options[name] = [] unless @options[name].is_a?(Array)
           @options[name] << value unless value.nil?
@@ -180,6 +186,16 @@ module Philiprehberger
         end
       end
 
+      def validate_required_options!
+        missing = @option_definitions.each_with_object([]) do |(name, defn), acc|
+          acc << name if defn[:required] && !@supplied_options.include?(name)
+        end
+        return if missing.empty?
+
+        names = missing.map { |n| "--#{n.to_s.tr('_', '-')}" }.join(', ')
+        raise Error, "Missing required option(s): #{names}"
+      end
+
       def format_flag_help(name, defn)
         long = "--#{name.to_s.tr('_', '-')}"
         if defn[:short]
@@ -204,8 +220,10 @@ module Philiprehberger
         else
           label = "      #{long}"
         end
-        if defn[:desc]
-          "#{label.ljust(24)}#{defn[:desc]}"
+        desc = defn[:desc]
+        desc = desc ? "#{desc} (required)" : '(required)' if defn[:required]
+        if desc
+          "#{label.ljust(24)}#{desc}"
         else
           label
         end

data/lib/philiprehberger/cli_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module CliKit
-    VERSION = '0.3.1'
+    VERSION = '0.5.0'
   end
 end

data/lib/philiprehberger/cli_kit.rb

@@ -5,6 +5,7 @@ require_relative 'cli_kit/parser'
 require_relative 'cli_kit/prompt'
 require_relative 'cli_kit/spinner'
 require_relative 'cli_kit/menu'
+require_relative 'cli_kit/colorize'
 
 module Philiprehberger
   module CliKit
@@ -105,5 +106,26 @@ module Philiprehberger
     def self.multi_select(message, choices, defaults: [], input: $stdin, output: $stdout)
       Menu.multi_select(message, choices, defaults: defaults, input: input, output: output)
     end
+
+    # Wraps text in ANSI color (auto-disabled when not a TTY or NO_COLOR is set).
+    #
+    # @param text [String]
+    # @param name [Symbol]
+    # @return [String]
+    def self.color(text, name)
+      Colorize.color(text, name)
+    end
+
+    # @param text [String]
+    # @return [String]
+    def self.bold(text)
+      Colorize.bold(text)
+    end
+
+    # @param text [String]
+    # @return [String]
+    def self.dim(text)
+      Colorize.dim(text)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-cli_kit
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-15 00:00:00.000000000 Z
+date: 2026-04-26 00:00:00.000000000 Z
 dependencies: []
 description: Lightweight CLI toolkit combining argument parsing with flags and options,
   interactive prompts with confirmation, and animated spinners for long-running operations.
@@ -22,6 +22,7 @@ files:
 - LICENSE
 - README.md
 - lib/philiprehberger/cli_kit.rb
+- lib/philiprehberger/cli_kit/colorize.rb
 - lib/philiprehberger/cli_kit/menu.rb
 - lib/philiprehberger/cli_kit/parser.rb
 - lib/philiprehberger/cli_kit/prompt.rb