philiprehberger-cli_kit 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4606c83ce0c95c7b047c9db662457bce97852169987a96a44566d4811e78313
-  data.tar.gz: 907327c09e57175ca6e1c07d03369fdfe5f157534836e64acf348b79dc439a5e
+  metadata.gz: eae06fcc20ac2c4b561e9344b149ce324226182696988a8a80409dd21b95fb13
+  data.tar.gz: 1f3717ee7a4fd6a60f3ba3df8f716538c8c7300deb2d3f7f54085a1d87e8c4c8
 SHA512:
-  metadata.gz: '08bb60e7b9c05a9e6d5572a8a393f61b987c07a136f7cb1eaf6e6ac58168fea50230f5855d073c47bd0516b178d19e138d223ccc7ff4e529248b9aef16f08699'
-  data.tar.gz: 20864d8ed45d20aabe85d072ba1adcb44590c76f346329e51314b4163bce07951b2759327ef852112bccaec05f82705e28b5534502d5b5dde6e2b0efaddb4733
+  metadata.gz: da8187a4ef2b10558b7d1950318da743851f60423580550c001dc61059a579fccedcca8a29161d2252b2a242fd61d7f8877fee666ed57e0cc6f73a97398b56fe
+  data.tar.gz: 4ef31ad27f1536ba102f013cad027d0d38597a5e3f6492307f2ff0a328d63de572cf42476c63e33cb73d44cb72ddc0182c8b8e9afafe706507114bb970c33d04

data/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2026-05-02
+
+### Added
+- `CliKit.strip_color(text)` (and `Colorize.strip(text)`) to remove ANSI escape sequences from a string — useful for testing colored output and writing colored messages to log files
+
+## [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
@@ -68,7 +79,8 @@ 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.4.0...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

data/README.md

@@ -177,6 +177,21 @@ 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')
+
+# Strip ANSI escapes (useful for tests or logging colored output to a file)
+colored = Philiprehberger::CliKit.color('OK', :green)
+Philiprehberger::CliKit.strip_color(colored)  # => 'OK'
+```
+
 ## API
 
 | Method | Description |
@@ -189,6 +204,10 @@ 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 |
+| `.strip_color(text)` | Remove ANSI escape sequences from text |
 | `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 |

data/lib/philiprehberger/cli_kit/colorize.rb

@@ -0,0 +1,64 @@
+# 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
+
+      # Remove ANSI escape sequences (color, bold, dim, reset, etc.) from text.
+      # Idempotent on already-plain strings. Returns text unchanged when input
+      # is not a String (e.g. nil → nil).
+      #
+      # @param text [String, Object]
+      # @return [String, Object]
+      def strip(text)
+        return text unless text.is_a?(String)
+
+        text.gsub(/\e\[[0-9;]*m/, '')
+      end
+    end
+  end
+end

data/lib/philiprehberger/cli_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module CliKit
-    VERSION = '0.4.0'
+    VERSION = '0.6.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,35 @@ 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
+
+    # Remove ANSI escape sequences from text. Useful for testing colored output
+    # or for logging colored messages without escape codes leaking through.
+    #
+    # @param text [String]
+    # @return [String]
+    def self.strip_color(text)
+      Colorize.strip(text)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-cli_kit
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-19 00:00:00.000000000 Z
+date: 2026-05-03 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