rtfm-filemanager 5 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6057bc9ae7f88f3b05029fe3de2529d72279620808f04e040de4ae38844d31e4
-  data.tar.gz: ade554a33f58d9ac4543a9582f8f5aa707a2a18ebd76822c19b6ec4e15d175a2
+  metadata.gz: 65f531af0c85c52e34c30c9c519d1e6a18805b4a14dc164db763b2222ccdb47b
+  data.tar.gz: e33f6bca4bf995ec4409788943ebeb201835d6688d491df5373cbec567947131
 SHA512:
-  metadata.gz: da784ee1fedec71ef87abcec3760a5cec1ec803938123556982c860894ace9ed7076fefefe153ca60c37c06c7291c89a5c1111f06fde429bbedf1d5f5c14b1f0
-  data.tar.gz: f599aa1dd8d1b70977655bd9a2c655f19517c3ef9897eda78e2aa8197674a4343f4bbd22b6829641e18fe09f019b00787a2fd85d1103541a31b45612d91c1ee5
+  metadata.gz: 26bfb3dec1c73fb827cab5546463dffc2b08e248e5c626ba94d5fe41ad5ad7caaf5adb9f2ec81d76599d4de98132fd66e5fda4427f86723eda26361e6736e343
+  data.tar.gz: 20521351d0b775b30a7cad7d97d40973df535fb5299fa35b0744ed45b5d7f4c1a4fc42c418657d504cd7642885fad0c09e9a0a035c5280efc4687144797add39

data/README.md

@@ -473,7 +473,7 @@ RTFM by following the instructions in `keys.rb`:
 #   KEYMAP['X'] = :my_handler
 #
 #   def my_handler(chr)
-#     # anything you likeb
use @pB, @pR, Dir.pwd, etc.
+#     # anything you like - use @pB, @pR, Dir.pwd, etc.
 #     @pB.say("You pressed X!")
 #   end
 #
@@ -488,8 +488,64 @@ RTFM by following the instructions in `keys.rb`:
 #     @pB.say("ZAPPED!")
 #   end
 ```
+Here is another example of what you could add as a plugin:
+```
+KEYMAP['C-G'] = :git_update
+
+def git_update
+  @pR.say("Updating...")
+  message = @pCmd.ask('Commit message: ', '')
+  shellexec("git add . && git commit -m '#{message}' && git push")
+  @pB.full_refresh
+end
+```
 ***With this, you can mold RTFM to fit your needs better.***
 
+When writing plugins, there are a few variables you should know:
+
+Variable  | Description
+----------|------------------------------------------------------------------
+@pT       | Top pane (info bar)
+@pL       | Left pane
+@pR       | Right pane
+@pB       | Bottom pane (status bar)
+@pCmd     | Command pane (asking for commands to execute)
+@pSearch  | Search pane (prompting for what to search for)
+@pAI      | Pane for interacting with (Open)AI
+@pRuby    | Ruby debug/command pane
+@selected | The selected item in the Left pane
+
+Here are three importan hook-ins to use with your plugins:
+
+### Summary of overlap & choice
+- **Use `command`** when you need to _capture_ output as a value (and optionally handle stderr yourself).
+- **Use `shell`** for fire-and-forget side-effects where you don't care about stdout but still want error reporting.
+- **Use `shellexec`** when you want both stdout and stderr printed into RTFM's Right pane automatically.
+
+#### `command(cmd, timeout: 5, return_both: false) → String or [stdout, stderr]`
+- **What it does:** Runs `bash -c cmd`, captures both stdout and stderr, enforces a timeout.
+- **When to use:** Programmatically grab output (and optionally errors) of a shell command (e.g. building directory listings or previews).
+- **Key points:**
+  - By default prints stderr into the Right pane and returns stdout.
+  - `return_both: true` returns `[stdout, stderr]` instead of auto-printing errors.
+  - Times out after `timeout` seconds, killing the process if necessary.
+
+#### `shell(cmd, background: false, err: nil) → nil`
+- **What it does:** Fires off `cmd` via `system`, redirecting stderr into a log file (default: `$TMP/rtfm_err.log`), optionally in the background.
+- **When to use:** Run side-effecting commands (e.g. `xdg-open`, `mv`) where you don't need stdout but still want error reporting.
+- **Key points:**
+  - If `background: true`, runs `cmd &`.
+  - Any stderr output is read from the log and shown via `@pR.say`.
+  - Doesn't return command output, errors only.
+
+#### `shellexec(cmd, timeout: 10) → nil`
+- **What it does:** A thin wrapper over `command(cmd, timeout:, return_both: true)` that _always_ prints both stdout and stderr into the Right pane.
+- **When to use:** Run a command and echo both its stdout and any errors back to the user—e.g. interactive grep, locate, or other one-off shell tools.
+- **Key points:**
+  - Internally calls `command(..., return_both: true)`.
+  - Prints stderr first, then stdout.
+  - Doesn't return anything to the caller.
+
 ## Screencast
 Here's a screencast for an early version of RTFM, but it shows the basic stuff:
 [![RTFM screencast](/img/screenshot.png)](https://youtu.be/ANUOlDryUng)

data/bin/rtfm

@@ -18,7 +18,7 @@
 #             get a great understanding of the code itself by simply sending
 #             or pasting this whole file into you favorite AI for coding with
 #             a prompt like this: "Help me understand every part of this code".
-@version    = '5.0' # A full rewrite using https://github.com/isene/rcurses
+@version    = '5.1' # Fixed a rare bug on opening $EDITOR
 
 # BOOTSNAP {{{1
 cache_dir = ENV.fetch('BOOTSNAP_CACHE_DIR', File.join(Dir.home, '.rtfm', 'bootsnap-cache'))
@@ -1574,7 +1574,7 @@ def dirlist(left: true) # LIST DIRECTORIES {{{2
   end
   # Map & decorate each colored line
   ls.map!.with_index do |el, i|
-    n = el.clean_ansi
+    n = el.to_s.clean_ansi
     n = n.shorten(width - 5).inject('…', -1) if n.pure.length > width - 6
     raw_name = (purels[i] || '').strip
     base     = left ? Dir.pwd : dir
@@ -2073,8 +2073,20 @@ def open_selected(html = nil) # OPEN SELECTED ITEM (when pressing RIGHT or via o
     return
   end
   if File.read(@selected).force_encoding('UTF-8').valid_encoding? # Pure text
-    system("exec $EDITOR #{Shellwords.escape(@selected)}")
-    Rcurses.clear_screen
+    system("stty #{ORIG_STTY} < /dev/tty")  # Restore terminal so $EDITOR can take over
+    system('clear < /dev/tty > /dev/tty')   # Clear RTFM off the screen
+    Cursor.show
+    editor = ENV.fetch('EDITOR', 'vi')      # Launch $EDITOR on the real TTY
+    pid = Process.spawn(editor, Shellwords.escape(@selected),
+                        in:  '/dev/tty',
+                        out: '/dev/tty',
+                        err: '/dev/tty')
+    Process.wait(pid)
+    system('stty raw -echo isig < /dev/tty') # Re-enter raw/no-echo mode and hide cursor
+    $stdin.raw!
+    $stdin.echo = false
+    Cursor.hide
+    Rcurses.clear_screen # Redraw RTFM
     refresh
     render
     return

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtfm-filemanager
 version: !ruby/object:Gem::Version
-  version: '5'
+  version: 5.1.1
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rcurses
@@ -54,7 +54,7 @@ dependencies:
         version: '7.4'
 description: |-
   Major release - RTFM v5: Complete rewrite using rcurses (https://github.com/isene/rcurses). Massive improvements. AI integration.
-   A full featured terminal browser with syntax highlighted files, images shown in the terminal, videos thumbnailed, etc. You can bookmark and jump around easily, delete, rename, copy, symlink and move files. RTFM is one of the most feature-packed terminal file managers.
+   A full featured terminal browser with syntax highlighted files, images shown in the terminal, videos thumbnailed, etc. You can bookmark and jump around easily, delete, rename, copy, symlink and move files. RTFM is one of the most feature-packed terminal file managers. 5.1.1: Minor bugfix (fixed calling clean_ansi with nil).
 email: g@isene.com
 executables:
 - rtfm