clack 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4723c11dc0a0944ea3a56337800aac60ec1ae3db29094f7f98e77f87b38caa2
-  data.tar.gz: 8b9bc87d58955147a0d000e94db0094832cb02dea4a92fd13d11618322fe5578
+  metadata.gz: 01366d1d6cc81f2514adc5c7bbdc726b3dec22d6697ae2bf26077c2db84efa1b
+  data.tar.gz: e1e96b35ef913ee377ed38c0fd98612aa1d758760991ee39ba27ac1cf8dc6136
 SHA512:
-  metadata.gz: 70f8abc4ace88dd272abb4022b29819acc7ce3be50b6d1fa0926a4e3e70cc46f48de71ec3840229b55ac7f4cf857d7551d5ff55d35063e96992e1d73e418d1ff
-  data.tar.gz: 82950f8271b8e672c95d4f05c77749566e54d01db88fe62635ff7dd45b75fb846076497e8d5d6fee41fbf45f3088939f1f4eab13020fcbcc482ad0e7d2366e66
+  metadata.gz: ac79a1a3887e261b9d2f14b989381430c35796a1acac47a449e44c773314bcea8985b294880a646213c53bd004900e9e749f9a0d69db55a19dfecd2b4d6eab34
+  data.tar.gz: 891cea3cc9b0047602a627396c40950c4397a968aa2ca021b4e2f71719ce40463d62b01db19c3b59ea92fd9efd9e0807b9120afa6cfacbbe5df90fcb391d328a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.6.1] - 2026-06-21
+
+### Added
+- `CLACK_ESCAPE_TIMEOUT` env var to tune the Escape-sequence detection window (milliseconds) for high-latency links like slow SSH, where arrow keys could otherwise be misread as a standalone Escape
+
+### Changed
+- `multiselect`, `group_multiselect`, and `autocomplete_multiselect` now warn on stderr when `initial_values` contains values that don't match any option (still dropped, but no longer silently)
+
 ## [0.6.0] - 2026-05-30
 
 ### Added

data/README.md

@@ -7,6 +7,9 @@
   <i>CLI prompts for Ruby. Zero dependencies.</i>
   <br>
   <br>
+  <sub>A faithful Ruby port of <a href="https://github.com/bombshell-dev/clack"><code>@clack/prompts</code></a>.</sub>
+  <br>
+  <br>
   <a href="https://rubygems.org/gems/clack"><img src="https://img.shields.io/gem/v/clack?style=flat-square&color=cc342d" alt="Gem Version"></a>
   <a href="https://github.com/swhitt/clackrb/actions"><img src="https://img.shields.io/github/actions/workflow/status/swhitt/clackrb/ci.yml?style=flat-square&label=tests" alt="Tests"></a>
   <a href="https://www.ruby-lang.org"><img src="https://img.shields.io/badge/ruby-3.2%2B-cc342d?style=flat-square" alt="Ruby 3.2+"></a>
@@ -782,7 +785,7 @@ COVERAGE=true bundle exec rake spec  # With coverage
 
 ## Credits
 
-This is a Ruby port of [Clack](https://github.com/bombshell-dev/clack), created by [Nate Moore](https://github.com/natemoo-re) and the [Astro](https://astro.build) team.
+This is a Ruby port of [`@clack/prompts`](https://github.com/bombshell-dev/clack), created by [Nate Moore](https://github.com/natemoo-re) and the [Astro](https://astro.build) team.
 
 ## License
 

data/lib/clack/core/key_reader.rb

@@ -6,15 +6,10 @@ module Clack
   module Core
     # Reads single keystrokes from the terminal in raw mode.
     # Handles escape sequences for arrow keys and other special keys.
+    #
+    # The Escape detection window is tunable via the +CLACK_ESCAPE_TIMEOUT+
+    # env var (see {Environment.escape_timeout}) for high-latency links.
     module KeyReader
-      # Timeout for detecting if Escape is part of a sequence (50ms).
-      # If no follow-up character arrives, treat Escape as a standalone key.
-      ESCAPE_TIMEOUT = 0.05
-
-      # Timeout for reading additional characters in a CSI sequence (10ms).
-      # Short because subsequent bytes in a sequence arrive almost instantly.
-      SEQUENCE_TIMEOUT = 0.01
-
       class << self
         # Read a single keystroke in raw mode.
         # When input is an IO backed by a console, uses raw mode.
@@ -42,14 +37,20 @@ module Clack
           return char if char.nil? # EOF
           return char unless char == "\e"
 
+          escape_timeout = Environment.escape_timeout
+          # Subsequent bytes in a sequence normally arrive almost instantly, so
+          # the inter-byte wait stays much shorter, but it scales with the
+          # escape timeout so high-latency links still assemble full sequences.
+          sequence_timeout = escape_timeout / 5.0
+
           # Check for escape sequence - wait briefly for follow-up
-          return char unless io.respond_to?(:wait_readable) && io.wait_readable(ESCAPE_TIMEOUT)
+          return char unless io.respond_to?(:wait_readable) && io.wait_readable(escape_timeout)
 
           seq = io.getc.to_s
           return "\e#{seq}" unless seq == "["
 
           # Read CSI sequence until no more characters arrive
-          while io.respond_to?(:wait_readable) && io.wait_readable(SEQUENCE_TIMEOUT)
+          while io.respond_to?(:wait_readable) && io.wait_readable(sequence_timeout)
             seq += io.getc.to_s
           end
           "\e[#{seq[1..]}"

data/lib/clack/core/selection_manager.rb

@@ -11,6 +11,24 @@ module Clack
     module SelectionManager
       REQUIRED_ERROR = "Please select at least one option. Press %s to select, %s to submit"
 
+      # Resolve requested pre-selections against the selectable option values.
+      #
+      # Values that don't match any current option are dropped and reported on
+      # stderr, since they're almost always a typo in +initial_values+ rather
+      # than an intentional no-op.
+      #
+      # @param initial_values [Array] the requested pre-selections
+      # @param valid_values [Set] the set of selectable option values
+      # @return [Set] the subset of initial_values that map to real options
+      def resolve_initial_selection(initial_values, valid_values)
+        requested = Set.new(initial_values)
+        unknown = requested - valid_values
+        unless unknown.empty?
+          warn "[clack] ignoring unknown initial_values: #{unknown.to_a.inspect}"
+        end
+        requested & valid_values
+      end
+
       # Toggle a value in the selection set.
       # @param value [Object] the value to toggle
       def toggle_value(value)

data/lib/clack/environment.rb

@@ -6,6 +6,9 @@ module Clack
   # Environment detection utilities for cross-platform compatibility
   # and CI/terminal environment awareness.
   module Environment
+    # Default Escape-sequence detection timeout, in seconds.
+    DEFAULT_ESCAPE_TIMEOUT = 0.05
+
     class << self
       # Check if running on Windows
       # @return [Boolean]
@@ -127,6 +130,29 @@ module Clack
         end
       end
 
+      # Escape-sequence detection timeout, in seconds.
+      #
+      # After an Escape byte arrives, the key reader waits this long for a
+      # follow-up byte to decide whether it's a standalone Escape or the start
+      # of an arrow-key / CSI sequence. The 50ms default is fine locally but too
+      # tight over high-latency links (slow SSH, mosh), where the follow-up
+      # bytes lag and arrow keys get misread as a bare Escape (cancelling the
+      # prompt). Override with the +CLACK_ESCAPE_TIMEOUT+ env var, in
+      # milliseconds, e.g. +CLACK_ESCAPE_TIMEOUT=250+ for a slow connection.
+      #
+      # Invalid or non-positive values fall back to the default.
+      #
+      # @return [Float] timeout in seconds
+      def escape_timeout
+        raw = ENV["CLACK_ESCAPE_TIMEOUT"]
+        return DEFAULT_ESCAPE_TIMEOUT unless raw
+
+        ms = Float(raw, exception: false)
+        return DEFAULT_ESCAPE_TIMEOUT unless ms&.positive?
+
+        ms / 1000.0
+      end
+
       # Reset cached environment checks (useful for testing)
       def reset!
         remove_instance_variable(:@windows) if defined?(@windows)

data/lib/clack/prompts/autocomplete_multiselect.rb

@@ -56,7 +56,7 @@ module Clack
         @option_index = 0
         @scroll_offset = 0
         valid_values = Set.new(@all_options.map { |o| o.value })
-        @selected = Set.new(initial_values) & valid_values
+        @selected = resolve_initial_selection(initial_values, valid_values)
         update_filtered
       end
 

data/lib/clack/prompts/group_multiselect.rb

@@ -61,7 +61,7 @@ module Clack
         @groups = normalize_groups(options)
         @flat_items = build_flat_items
         valid_values = Set.new(@flat_items.select { |item| item.is_a?(Core::GroupOption) }.map(&:value))
-        @selected = Set.new(initial_values) & valid_values
+        @selected = resolve_initial_selection(initial_values, valid_values)
         @required = required
         @selectable_groups = selectable_groups
         @group_spacing = group_spacing

data/lib/clack/prompts/multiselect.rb

@@ -45,7 +45,7 @@ module Clack
         super(message:, **opts)
         @options = normalize_options(options)
         valid_values = Set.new(@options.map { |o| o.value })
-        @selected = Set.new(initial_values) & valid_values
+        @selected = resolve_initial_selection(initial_values, valid_values)
         @required = required
         @max_items = max_items
         @scroll_offset = 0

data/lib/clack/version.rb

@@ -2,5 +2,5 @@
 
 module Clack
   # Current gem version.
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clack
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Steve Whittaker
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Beautiful, minimal CLI prompts
 test_files: []