irb-autosuggestions 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d8279c02d62499ce7d58d2b8c4c47c7f8289fa4e601b140106219ea4d0d472
-  data.tar.gz: f35c372e76961a2b91fc65bdf1fe94e6ec6daa7fec810461b49eb8dd11c34379
+  metadata.gz: df8665e8ded51b93cb8c175133f17a82bdf369ffe8dfc191740d65958821ab9c
+  data.tar.gz: 8c37639ad88f22439a243b5f59e4794feb1edd744dcfaf0caa65c59e662eefb7
 SHA512:
-  metadata.gz: 838a7272d857247def598a2989cd8c43eb35b8272183ce3623c25c53faa8e3bb2c375ed3b0006ec9942c2a34537e8fdc644961ab61477dfd86118fbc9f4ccf33
-  data.tar.gz: 85643f9c47045b2accbceb5a0f84b4eb13ae988b39550a541a21e320fec2f81d75e56128a73a59a9ab5061f0ccce1a2c8e984fcebb8b5a083b2927fcd0c6171f
+  metadata.gz: eefd9feddd378c75bc6052223b9873460dcc4cf52dc07762eab5c7541bf9bd34d9efb37ed9ceedb74d4dc5acac7ee734cf547a52dd659021e3df00139d97da0c
+  data.tar.gz: 1ff38d6e5db43910299127bd891780b6e9a82c781af7d9febd7627eda9acfecae578fcbe1dc655fa25ffb006a602d1051c59fe42b4eeb666689e8ca8eea890da

data/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Changelog
+
+## [0.2.2] - 2026-07-08
+
+### Added
+
+- Alternative key bindings to accept ghost suggestion: Tab, Ctrl+F, Ctrl+E (configurable via
+  `IRB.conf[:AUTOSUGGESTION_ACCEPT_KEYS]`) ([#15], [#157])
+- Configurable ghost color/style via `IRB.conf[:AUTOSUGGESTION_GHOST_COLOR]` (ANSI string) and
+  `IRB.conf[:AUTOSUGGESTION_GHOST_STYLE]` (declarative hash) ([#16], [#163])
+- GitHub issue templates (bug report, feature request) and pull request template
+
+### Fixed
+
+- Ghost text artifacts and cursor misalignment after accepting multiline (10+ lines) suggestions ([#19], [#256])
+- Auto-execute guard — verified Enter always fires exactly once regardless of ghost visibility ([#18], [#159])
+
+## [0.2.1] - 2026-07-05
+
+### Fixed
+
+- Ruby 4.0 compatibility: arrow (`ed_next_char`) not erasing after suggestion accept ([#13])
+
+## [0.2.0] - 2026-06-30
+
+### Added
+
+- Syntax-colored ghost text via `IRB::Color.colorize_code` (dimmed)
+- Prefix-filtered history navigation (up/down arrows match typed prefix)
+- Ruby 2.7 support
+
+### Changed
+
+- Ghost text now uses dim syntax colors when `IRB.conf[:USE_COLORIZE]` is enabled
+
+## [0.1.1] - 2026-06-25
+
+### Added
+
+- `IRB.conf[:USE_AUTOSUGGESTIONS]` toggle
+- Environment variable `IRB_AUTOSUGGESTIONS` override
+- RBS type signatures
+
+### Fixed
+
+- Gem metadata (licenses, homepage)
+
+## [0.1.0] - 2026-06-20
+
+### Added
+
+- Initial release: fish-like autosuggestions from `Reline::HISTORY`
+- Right arrow key accepts ghost suggestion
+- Gray ghost text (`\e[90m`)
+- Configuration via `IRB.conf[:USE_AUTOSUGGESTIONS]`
+
+[#15]: https://github.com/unurgunite/irb-autosuggestions/pull/15
+
+[#16]: https://github.com/unurgunite/irb-autosuggestions/pull/16
+
+[#18]: https://github.com/unurgunite/irb-autosuggestions/pull/18
+
+[#19]: https://github.com/unurgunite/irb-autosuggestions/pull/19
+
+[#157]: https://github.com/unurgunite/irb-autosuggestions/issues/157
+
+[#163]: https://github.com/unurgunite/irb-autosuggestions/issues/163
+
+[#159]: https://github.com/unurgunite/irb-autosuggestions/issues/159
+
+[#256]: https://github.com/unurgunite/irb-autosuggestions/issues/256

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    irb-autosuggestions (0.2.1)
+    irb-autosuggestions (0.2.2)
       reline
 
 GEM
@@ -9,11 +9,11 @@ GEM
   specs:
     ast (2.4.3)
     diff-lcs (1.6.2)
-    docscribe (1.3.3)
+    docscribe (1.5.1)
       parser (>= 3.3)
       prism (~> 1.8)
     io-console (0.8.2)
-    json (2.19.5)
+    json (2.20.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -43,7 +43,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.86.2)
+    rubocop (1.88.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -60,10 +60,11 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
-    rubocop-sorted_methods_by_call (1.2.2)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
+    rubocop-sorted_methods_by_call (1.2.3)
       lint_roller
       rubocop (>= 1.72.0)
     ruby-progressbar (1.13.0)
@@ -91,4 +92,4 @@ DEPENDENCIES
   yard (>= 0.9.38)
 
 BUNDLED WITH
-  4.0.11
+   2.4.22

data/Gemfile_2_7.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    irb-autosuggestions (0.2.1)
+    irb-autosuggestions (0.2.2)
       reline
 
 GEM
@@ -9,11 +9,11 @@ GEM
   specs:
     ast (2.4.3)
     diff-lcs (1.6.2)
-    docscribe (1.3.3)
+    docscribe (1.5.1)
       parser (>= 3.3)
       prism (~> 1.8)
     io-console (0.8.2)
-    json (2.19.5)
+    json (2.20.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     parallel (1.28.0)
@@ -40,7 +40,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.86.2)
+    rubocop (1.88.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -57,10 +57,11 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
-    rubocop-sorted_methods_by_call (1.2.2)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
+    rubocop-sorted_methods_by_call (1.2.3)
       lint_roller
       rubocop (>= 1.72.0)
     ruby-progressbar (1.13.0)

data/README.md

@@ -18,7 +18,9 @@ No need to explain. Fish-like autosuggestions for IRB — ghost text from histor
     * [Usage](#usage)
         * [Prefix-filtered history navigation](#prefix-filtered-history-navigation)
     * [Configuration](#configuration)
+        * [Ghost color](#ghost-color)
         * [Colors](#colors)
+        * [Accept keys](#accept-keys)
         * [How it works](#how-it-works)
     * [Development](#development)
     * [License](#license)
@@ -48,7 +50,8 @@ irb(main):002*   el.succ      <- "cc" in gray
 irb(main):003> end            <- "d" in gray
 ```
 
-Press **right arrow** (`->`) to accept the full multiline suggestion.
+Press **right arrow** (`->`), **Tab**, **Ctrl+F**, or **Ctrl+E** to accept the full multiline suggestion. Tab falls
+back to normal completion when no suggestion is visible. Accept keys are configurable (see below).
 
 ### Prefix-filtered history navigation
 
@@ -96,6 +99,29 @@ Or via environment variable:
 export IRB_AUTOSUGGESTIONS=0
 ```
 
+### Ghost color
+
+The plain gray fallback color can be customized. Syntax-colored ghost text (when `IRB::Color` is available) always
+takes precedence over these settings.
+
+Set a raw ANSI escape code:
+
+```ruby
+IRB.conf[:AUTOSUGGESTION_GHOST_COLOR] = "\e[32m" # green
+```
+
+Or use the declarative style hash:
+
+```ruby
+IRB.conf[:AUTOSUGGESTION_GHOST_STYLE] = { fg: :bright_black, italic: true }
+```
+
+Supported colors: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `default`,
+`bright_black`, `bright_red`, `bright_green`, `bright_yellow`, `bright_blue`, `bright_magenta`,
+`bright_cyan`, `bright_white`.
+
+Supported attributes: `bold`, `dim`, `italic`, `underline`, `blink`, `reverse`.
+
 ### Colors
 
 Syntax-colored ghost text is **enabled by default** when `IRB::Color` is available and `IRB.conf[:USE_COLORIZE]` is
@@ -118,6 +144,19 @@ irb --nocolorize
 > schemes. If you notice visual artifacts (e.g., wrong colors, underlines, or unusual brightness), try disabling the
 > feature or switch to the gray fallback or create new issue.
 
+### Accept keys
+
+Configure which keys accept the ghost suggestion:
+
+```ruby
+IRB.conf[:AUTOSUGGESTION_ACCEPT_KEYS] = %i[ed_next_char tab ed_end_of_line]
+```
+
+Defaults: `[:ed_next_char, :ed_end_of_line, :tab]` (right arrow/Ctrl+F, Ctrl+E, Tab).
+
+Available symbols: `:ed_next_char` (right arrow/Ctrl+F), `:ed_end_of_line` (Ctrl+E), `:tab`, or
+any Reline method symbol. When no suggestion is visible, the key falls through to its normal behavior.
+
 ### How it works
 
 - Each keystroke queries `Reline::HISTORY` for the most recent entry whose prefix matches the current buffer.
@@ -127,7 +166,7 @@ irb --nocolorize
 - Extra ghost lines (for multiline history entries) are drawn below the prompt.
 - Ghost artifacts are cleared each frame using cursor save/restore (`\e[s`/`\e[u`) and per-line clearing (`\e[2K`),
   avoiding `\e[J` which interfered with Reline's cursor tracking.
-- Right arrow triggers `ed_next_char`, which replaces the buffer with the ghost text.
+- Configurable accept keys (right arrow, Tab, Ctrl+F, Ctrl+E by default) replace the buffer with the ghost text.
 - Up/down arrows use prefix-filtered navigation when the buffer is non-empty, falling back to unfiltered browsing
   when nothing was typed.
 

data/lib/irb/autosuggestions/line_editor_patch.rb

@@ -14,8 +14,22 @@ module Irb
       ENV_KEY = 'IRB_AUTOSUGGESTIONS'
       CONFIG_NAV_KEY = :USE_PREFIX_HISTORY_NAVIGATION
       ENV_NAV_KEY = 'IRB_PREFIX_HISTORY_NAVIGATION'
-
-      # Intercepts key input to accept autosuggestions on right arrow
+      ACCEPT_KEYS_CONFIG = :AUTOSUGGESTION_ACCEPT_KEYS
+      DEFAULT_ACCEPT_KEYS = %i[ed_next_char ed_end_of_line tab].freeze
+      GHOST_COLOR_CONFIG = :AUTOSUGGESTION_GHOST_COLOR
+      GHOST_STYLE_CONFIG = :AUTOSUGGESTION_GHOST_STYLE
+      DEFAULT_GHOST_COLOR = "\e[90m"
+      FG_MAP = {
+        black: 30, red: 31, green: 32, yellow: 33, blue: 34, magenta: 35, cyan: 36, white: 37,
+        default: 39,
+        bright_black: 90, bright_red: 91, bright_green: 92, bright_yellow: 93,
+        bright_blue: 94, bright_magenta: 95, bright_cyan: 96, bright_white: 97
+      }.freeze
+      ATTR_MAP = {
+        bold: 1, dim: 2, italic: 3, underline: 4, blink: 5, reverse: 7
+      }.freeze
+
+      # Intercepts key input to accept autosuggestions on configured keys
       # and clears the prefix navigation anchor on non-history keys.
       #
       # @param [Object] key A Reline key event.
@@ -23,7 +37,7 @@ module Irb
       def input_key(key)
         clear_prefix_anchor if navigation_enabled? && !history_navigation_key?(key)
 
-        if enabled? && right_arrow?(key)
+        if enabled? && accept_key?(key)
           buffer = whole_buffer
           suggestion = find_suggestion(buffer)
 
@@ -41,13 +55,17 @@ module Irb
       # Works on both Reline 0.3.x (rerender is the main rendering entry) and
       # Reline 0.4+ (rerender calls render internally).
       #
+      # Ghost is cleared BEFORE super to avoid cursor-position-dependent
+      # escapes targeting wrong lines after accept_suggestion changes buffer.
+      #
       # @return [Object] The result of +super+.
       def rerender
+        clear_previous_ghost if enabled?
+
         result = super
-        if enabled?
-          clear_previous_ghost
-          render_ghost_suggestion
-        end
+
+        render_ghost_suggestion if enabled?
+
         result
       end
 
@@ -212,14 +230,34 @@ module Irb
         end
       end
 
-      # Checks if a key event is a right arrow press.
+      # Checks if a key event matches any configured accept key.
+      # Defaults to right arrow (:ed_next_char).
+      # Tab is matched specially — method_symbol == :ed_insert + char == "\t".
       #
       # @private
       # @param [Object] key A Reline key event.
       # @return [Boolean]
-      def right_arrow?(key)
-        key.respond_to?(:method_symbol) &&
-          key.method_symbol == :ed_next_char
+      def accept_key?(key)
+        accept_keys = IRB.conf.fetch(ACCEPT_KEYS_CONFIG, DEFAULT_ACCEPT_KEYS)
+        accept_keys.any? { |k| key_match?(key, k) }
+      end
+
+      # Checks if a key matches a given config symbol.
+      #
+      # @private
+      # @param [Object] key A Reline key event.
+      # @param [Symbol] config_symbol One of :ed_next_char, :ed_end_of_line, :tab, etc.
+      # @return [Boolean]
+      def key_match?(key, config_symbol)
+        return false unless key.respond_to?(:method_symbol)
+
+        if config_symbol == :tab
+          key.method_symbol == :ed_insert &&
+            key.respond_to?(:char) &&
+            key.char == "\t"
+        else
+          key.method_symbol == config_symbol
+        end
       end
 
       # Finds the index of the previous (older) history entry starting with +buffer+.
@@ -354,7 +392,6 @@ module Irb
       #
       # When colorization is enabled, the full suggestion is colorized via
       # IRB::Color and the ghost portion is extracted from the colored output.
-      # Otherwise, each line is wrapped in GRAY/RESET.
       #
       # @private
       # @param [String] ghost The ghost text (suffix of the suggestion).
@@ -365,10 +402,35 @@ module Irb
         if suggestion && use_colorize?
           colorize_ghost_lines(ghost, suggestion)
         else
-          ghost.split("\n").map { |line| "#{GRAY}#{line}#{RESET}" }
+          ghost.split("\n").map { |line| "#{ghost_color}#{line}#{RESET}" }
         end
       rescue StandardError
-        ghost.split("\n").map { |line| "#{GRAY}#{line}#{RESET}" }
+        ghost.split("\n").map { |line| "#{ghost_color}#{line}#{RESET}" }
+      end
+
+      # Returns the effective ANSI color code for ghost text.
+      # Checks GHOST_STYLE_CONFIG first, then GHOST_COLOR_CONFIG, then default.
+      #
+      # @private
+      # @return [String]
+      def ghost_color
+        style = IRB.conf[GHOST_STYLE_CONFIG]
+        return resolve_ghost_style(style) if style.is_a?(Hash)
+
+        IRB.conf.fetch(GHOST_COLOR_CONFIG, DEFAULT_GHOST_COLOR)
+      end
+
+      # Converts a style hash like +{ fg: :bright_black, italic: true }+
+      # to an ANSI escape sequence.
+      #
+      # @private
+      # @param [Hash] hash Style hash with +:fg+ color and optional attribute keys.
+      # @return [String]
+      def resolve_ghost_style(hash)
+        codes = []
+        codes << FG_MAP[hash[:fg]] if hash[:fg]
+        ATTR_MAP.each { |attr, code| codes << code if hash[attr] }
+        "\e[#{codes.join(';')}m"
       end
 
       # Checks whether syntax coloring is available and enabled.

data/lib/irb/autosuggestions/version.rb

@@ -2,6 +2,6 @@
 
 module Irb
   module Autosuggestions
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/sig/lib/irb/autosuggestions/line_editor_patch.rbs

@@ -10,24 +10,39 @@ module Irb
       CONFIG_KEY: Symbol
       ENV_KEY: String
       RESET_COLOR: String
+      ACCEPT_KEYS_CONFIG: Symbol
+      DEFAULT_ACCEPT_KEYS: Array[Symbol]
+      GHOST_COLOR_CONFIG: Symbol
+      GHOST_STYLE_CONFIG: Symbol
+      DEFAULT_GHOST_COLOR: String
+      FG_MAP: Hash[Symbol, Integer]
+      ATTR_MAP: Hash[Symbol, Integer]
 
       @buffer_of_lines: Array[String]
       @byte_pointer: Integer
       @line_index: Integer
 
       def input_key: (untyped key) -> untyped
+      def rerender: () -> untyped
       def render: (*untyped) -> untyped
       def enabled?: () -> bool
+      def navigation_enabled?: () -> bool
       def use_colorize?: () -> bool
-      def right_arrow?: (untyped key) -> bool
+      def accept_key?: (untyped key) -> bool
+      def key_match?: (untyped key, Symbol config_symbol) -> bool
+      def ghost_color: () -> String
+      def resolve_ghost_style: (Hash[Symbol, untyped] hash) -> String
+      def render_ghost_suggestion: () -> void
       def render_ghost: (String ghost, ?String suggestion) -> void
       def ghost_display_lines: (String ghost, ?String suggestion) -> Array[String]
       def colorize_ghost_lines: (String ghost, String suggestion) -> Array[String]
+      def dim_line: (String line) -> String
       def extract_ansi_colored_suffix: (String colored_text, Integer visible_byte_offset) -> String
       def write_extra_ghost_lines: (Array[String] lines) -> void
-      def restore_cursor_after: (Array[String] lines) -> void
       def find_suggestion: (String buffer) -> (String | nil)
       def accept_suggestion: (String suggestion) -> void
+      def find_prev_match: (String buffer, Integer? from_pointer) -> Integer?
+      def find_next_match: (String buffer, Integer? from_pointer) -> Integer?
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: irb-autosuggestions
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - unurgunite
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-30 00:00:00.000000000 Z
+date: 2026-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reline
@@ -145,6 +145,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock