irb-autosuggestions 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e1ec7a3ce26018f3370e751867a4c0b949978ed1642609f737686c56a7c52ec
-  data.tar.gz: c0cdc0ec34d660207c7541f0f2b36eea14bbc316f1e8d5eb6f6127c029a862f2
+  metadata.gz: 02ad5c3a9b0166ac04a5ace310b88b4608ada72fa88d3d0a4f563817042db007
+  data.tar.gz: b68cd6b388fcdfb423ee895ed1758fdd4f8f878cc8c65faf4e45bfc8ffb7ccab
 SHA512:
-  metadata.gz: e41c47949a5d0016e8417aa49e29f86fb8406ba634e59b7972dd287396d523fb9d8094b318ba0d6a0941b45c11618aefdc81234298edbb8a8e5180002f5d3e82
-  data.tar.gz: 587fab5c5988e9ba7387f691d8c8a48adabb081d5be751f09b13f847a581bafed98d8f988d0e7827ce2f297c6d1c6247f7ade5b3b6470b780c2b6d7a6a9a2083
+  metadata.gz: a16cf68316c28e28aa74993736e78eca09ad0f96fda3e0afb5acfc7c9d1a77ab7804abcc820e7e83055982677f3f2631a276ca3f1a536522b25db912a43a7b55
+  data.tar.gz: bbbc34eaf686fa8c425f83da67c337c06cae44584e2675419b2d8faee4f94859cc8edc3c4ca51f6535bc0496a8e353f744c0ef0c469941978072e04046feacd8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    irb-autosuggestions (0.1.0)
+    irb-autosuggestions (0.1.1)
       reline
 
 GEM

data/README.md

@@ -13,6 +13,7 @@ No need to explain. Fish-like autosuggestions for IRB — ghost text from histor
     * [Contents](#contents)
     * [Installation](#installation)
     * [Usage](#usage)
+    * [Configuration](#configuration)
         * [How it works](#how-it-works)
     * [Development](#development)
     * [License](#license)
@@ -43,6 +44,22 @@ irb(main):003> end            <- "d" in gray
 
 Press **right arrow** (`->`) to accept the full multiline suggestion.
 
+## Configuration
+
+Autosuggestions are enabled by default. To disable:
+
+`~/.irbrc`:
+
+```ruby
+IRB.conf[:USE_AUTOSUGGESTIONS] = false
+```
+
+Or via environment variable:
+
+```sh
+export IRB_AUTOSUGGESTIONS=0
+```
+
 ### How it works
 
 - Each keystroke queries `Reline::HISTORY` for the most recent entry whose prefix matches the current buffer.

data/lib/irb/autosuggestions/line_editor_patch.rb

@@ -6,13 +6,15 @@ module Irb
     module LineEditorPatch
       GRAY = "\e[90m"
       RESET = "\e[0m"
+      CONFIG_KEY = :USE_AUTOSUGGESTIONS
+      ENV_KEY = 'IRB_AUTOSUGGESTIONS'
 
       # Intercepts key input to accept autosuggestions on right arrow.
       #
       # @param [Object] key A Reline key event.
       # @return [Object] Returns +super+ for non-right-arrow keys, +nil+ after accept.
       def input_key(key)
-        if right_arrow?(key)
+        if enabled? && right_arrow?(key)
           buffer = whole_buffer
           suggestion = find_suggestion(buffer)
 
@@ -34,6 +36,7 @@ module Irb
       def render(...)
         result = super
         Reline.core.instance_variable_get(:@output).write("\e[J")
+        return result unless enabled?
 
         buffer = whole_buffer
         return result if buffer.empty?
@@ -45,6 +48,18 @@ module Irb
         result
       end
 
+      # Checks whether autosuggestions are enabled via IRB.conf or env var.
+      #
+      # @private
+      # @return [Boolean]
+      def enabled?
+        case ENV.fetch(ENV_KEY, nil)
+        when '0' then false
+        when '1' then true
+        else IRB.conf.fetch(CONFIG_KEY, true)
+        end
+      end
+
       # Checks if a key event is a right arrow press.
       #
       # @private

data/lib/irb/autosuggestions/version.rb

@@ -2,6 +2,6 @@
 
 module Irb
   module Autosuggestions
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

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

@@ -3,6 +3,8 @@ module Irb
     module LineEditorPatch
       GRAY: String
       RESET: String
+      CONFIG_KEY: Symbol
+      ENV_KEY: String
 
       @buffer_of_lines: Array[String]
       @byte_pointer: Integer
@@ -10,6 +12,7 @@ module Irb
 
       def input_key: (untyped key) -> untyped
       def render: (*untyped) -> untyped
+      def enabled?: () -> bool
       def right_arrow?: (untyped key) -> bool
       def ghost_for: (String buffer) -> (String | nil)
       def render_ghost: (String ghost) -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irb-autosuggestions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - unurgunite