rtfm-filemanager 8.6.0 → 8.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d97437ca84138aaa2ad3fc03b54c2d607f39cda4e1d6fead69bef9d83278a9d
-  data.tar.gz: feb00468052819fdbb1c7c109406db875eba2be13c98273f0d16cbd90fb968ce
+  metadata.gz: 1a3688f47ab7f42eaf8488abfd1035d3ffa36fba99368ab2dc1846dda3119415
+  data.tar.gz: 2bf042038eee3c18c764c136d87848f15ff623389ff08625c1f5a6dd2564abba
 SHA512:
-  metadata.gz: 59981f04215c73a44f4821d1dbf3dddb74db5590521e746567c0970c157c96aca84b48c9c2ee3afa20037537734937e7b59c56b9a23c2cee8d947e67c0cefa2f
-  data.tar.gz: ac25468b6d11effefb11b5debd5e006c9d11aa689e623f638d5ee35a06e798b93343481b8b8b4f7f3950ae7acf046f117cdaecc37de43e050abc2b2a39100de2
+  metadata.gz: 89fec0164f4abec21cdcca454f77db2293dd4bed441f9edb26cb80148a7ffa0278b1af35c2e2d08eee19786ce1ff4fcc42afa128b6cd4349d71cf99695cca2d8
+  data.tar.gz: 827d9f52fb1cd639740b7f0d515ac076153f9bdde3ba4742f8d5bf71b1d9cc56df25029c25bd4e342a011707ee31ceb2c38edcfadebd75552bfbcede929edbd8

data/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to RTFM will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [8.7.2] - 2026-05-19
+
+### Fixed
+- **`$` script-evaluator clears right pane first** - Short output (or `(no output)`) used to leave residual lines from the prior directory preview underneath. Now calls `@pR.clear` before painting the new content
+
+## [8.7.1] - 2026-05-19
+
+### Fixed
+- **`$` script-evaluator output now sticks** - The right pane was getting overwritten by the directory preview after the script returned. Mirrors `command_mode`'s pattern: explicit `@pR.full_refresh` + `@pR.update = false` so the script's output remains visible until the user navigates
+- **Directive trace footer** - Stderr directives (`cd:`, `select:`, `status:`) now produce a small `── directives applied ──` footer at the bottom of the output so it's clear *something* happened even when stdout is empty. Previously a pure-directive script just showed `(no output)`
+
+## [8.7.0] - 2026-05-19
+
+### Added
+- **Script evaluator (`$` key)** - Run any shell command (any language) with RTFM context exposed as environment variables. Output shows in the right pane. Variables: `RTFM_SELECTED` (full path), `RTFM_DIR` (cwd), `RTFM_TAGGED` (newline-separated tagged paths), `RTFM_INDEX` (0-based selection), `RTFM_COUNT` (file count), `RTFM_CONTEXT` (JSON object with all of the above). Scripts can control RTFM by emitting stderr directives one per line: `cd:/path` changes directory, `select:NAME` moves cursor onto NAME, `status:MSG` shows MSG in the bottom pane. The Ruby debug mode (`@`) is unchanged. Makes RTFM scriptable from Python, Bash, Perl, jq, anything — without writing Ruby plugins
+
 ## [8.6.0] - 2026-05-19
 
 ### Added

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    = '8.6.0' # LS_COLORS fallback (dircolors -b) + Terminal=true in .desktop honored
+@version    = '8.7.2' # $ script-eval clears right pane before writing output
 
 # SAVE & STORE TERMINAL {{{1
 ORIG_STTY = `stty -g`.chomp
@@ -353,6 +353,20 @@ CONFIG_FILE   = File.join(RTFM_HOME, 'conf')
   RUBY DEBUG MODE
     @       = Enter Ruby mode to execute any Ruby command (ENTER to execute, ESC to escape)
 
+  SCRIPT EVALUATOR
+    $       = Run any shell command (any language) with RTFM context as env vars.
+              Output is shown in the right pane.
+                RTFM_SELECTED  Full path of selected item
+                RTFM_DIR       Current working directory
+                RTFM_TAGGED    Newline-separated tagged paths
+                RTFM_INDEX     Selected index (0-based)
+                RTFM_COUNT     Number of files in listing
+                RTFM_CONTEXT   JSON object with all of the above
+              Scripts can control RTFM via stderr directives, one per line:
+                cd:/path       Change to /path
+                select:NAME    Place cursor on NAME in current directory
+                status:MSG     Show MSG in the bottom pane
+
   COPYRIGHT: Geir Isene, 2025+. No rights reserved. See http://isene.com for more.
 HELPTEXT
 
@@ -1178,7 +1192,10 @@ KEYMAP = { # {{{2
   'e'       => :show_file_properties,
 
   # RUBY MODE {{{3
-  '@'       => :ruby_debug
+  '@'       => :ruby_debug,
+
+  # SCRIPT EVALUATOR {{{3
+  '$'       => :script_eval
 }
 
 # USER KEYS (override or extend KEYMAP) {{{2
@@ -5574,6 +5591,98 @@ def ruby_debug # {{{3
   @pB.full_refresh
 end
 
+# SCRIPT EVALUATOR {{{2
+# Run a shell command (any language) with RTFM context exposed as env vars.
+# stdout shows in the right pane. stderr is scanned for control directives:
+#   cd:/path        change current directory
+#   select:NAME     move cursor onto NAME in the (new) cwd
+#   status:MSG      show MSG in the bottom pane
+# Any other stderr line is appended to the right-pane output in red.
+def script_eval # {{{3
+  cmd = @pCmd.ask('$ ', '').to_s.strip
+  if cmd.empty?
+    @pB.clear; @pB.update = true
+    return
+  end
+
+  require 'json'
+  selected = @selected.to_s
+  tagged_paths = @tagged.dup
+  context = {
+    selected:  selected,
+    directory: Dir.pwd,
+    tagged:    tagged_paths,
+    index:     @index,
+    count:     (@files || []).size
+  }
+
+  env = {
+    'RTFM_SELECTED' => selected,
+    'RTFM_DIR'      => Dir.pwd,
+    'RTFM_TAGGED'   => tagged_paths.join("\n"),
+    'RTFM_INDEX'    => @index.to_s,
+    'RTFM_COUNT'    => (@files || []).size.to_s,
+    'RTFM_CONTEXT'  => context.to_json
+  }
+
+  begin
+    out, err, _status = Open3.capture3(env, 'sh', '-c', cmd)
+  rescue StandardError => e
+    @pB.say("script: #{e.class}: #{e.message}".fg(196))
+    return
+  end
+
+  # Process stderr line-by-line: directives consumed, other lines kept.
+  leftover_err = []
+  directive_msgs = []
+  err.each_line do |line|
+    l = line.chomp
+    case l
+    when /\Acd:(.+)\z/
+      target = File.expand_path($1.strip)
+      if File.directory?(target)
+        @directory[Dir.pwd] = @index
+        mark_latest
+        Dir.chdir(target)
+        directive_msgs << "cd: #{target}"
+      else
+        leftover_err << "cd: no such directory: #{target}"
+      end
+    when /\Aselect:(.+)\z/
+      name = $1.strip
+      # Applied after the upcoming render populates @files (handles both
+      # same-dir selection and post-cd selection in the new dir).
+      @startup_select = name
+      directive_msgs << "select: #{name}"
+    when /\Astatus:(.+)\z/
+      msg = $1.strip
+      @pB.say(msg.fg(156))
+      directive_msgs << "status: #{msg}"
+    else
+      leftover_err << l unless l.empty?
+    end
+  end
+
+  body = out.dup
+  body << "\n" << leftover_err.join("\n").fg(196) unless leftover_err.empty?
+
+  # Show directive trace as a subtle footer so the user can see what fired
+  unless directive_msgs.empty?
+    body << "\n\n" unless body.empty?
+    body << '── directives applied ──'.fg(238) << "\n"
+    body << directive_msgs.map { |m| "  #{m}" }.join("\n").fg(244)
+  end
+
+  clear_image
+  @pR.clear  # wipe leftover preview lines so short output doesn't sit atop them
+  text = body.empty? ? ' (no output)'.fg(244) : body
+  @pR.text = text
+  @pR.ix = 0
+  @pR.full_refresh
+  @pR.update = false
+  @pB.update = true
+end
+
 # GENERIC FUNCTIONS {{{1
 def get_cached_dirlist(dir, ls_options, ls_options_with_long = nil) # {{{2
   # Use ls_options_with_long for display, or fall back to ls_options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtfm-filemanager
 version: !ruby/object:Gem::Version
-  version: 8.6.0
+  version: 8.7.2
 platform: ruby
 authors:
 - Geir Isene