thor-osc7501 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1774a0a472abc4cc8b707ce62db5fbd78d5e31fb59e1e5816e567df2396c3c4d
+  data.tar.gz: 0a8045f44d2890953f16bfd6964b71d5c337f40849e46a6c3c86f97f844ad7af
+SHA512:
+  metadata.gz: c008b9a3fee66fc44c1504b3a59658eba18f75ee636caa16852d0338f8b6d7a9f8b97c2923334ebbb724f6d370212d17c10549c36a4c1dfdbbbfeb8b6e609580
+  data.tar.gz: a2f005c1e85162b0fefceae918fe4276d73062bf6a41986ace8c1a02e077d7ce9eb58543afe5b957383bc4eed31ec84446c355b03983151bec36e95e66553a97

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 - 2026-11-13
+
+- init ([8d8fc45](https://github.com/cosgroveb/thor-osc7501/commit/8d8fc45f2577583c4e60d32ed7dcc3a047ddd7e1))
+- Add Thor OSC 7501 command and prompt reporting ([a2a2ebe](https://github.com/cosgroveb/thor-osc7501/commit/a2a2ebeed2235b53133a455b91b781b25c27453e))
+- Add release machinery matching the sibling gems ([8f6d8ae](https://github.com/cosgroveb/thor-osc7501/commit/8f6d8ae880b65cb77992ef6d07e90f02dadaa67b))
+- Retain credentials for release preparation ([4f4a4a7](https://github.com/cosgroveb/thor-osc7501/commit/4f4a4a740457be34ad7a64ef58784a2b8348758e))
+- Fix release matrix defaults and smoke checks ([bd3c2f0](https://github.com/cosgroveb/thor-osc7501/commit/bd3c2f06e2b250739e0d7e3937feb758cd36ce8b))
+- Normalize temporary paths across platforms ([fe24a90](https://github.com/cosgroveb/thor-osc7501/commit/fe24a90c45f9931ab7c7f8b7ce62ef9a8c7e4e4e))

data/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+AI-assisted contributions are welcome. Before requesting review, understand
+the changes, run relevant checks, and verify claims in code, documentation,
+and reports. State what you tested and what remains uncertain. Be prepared
+to explain your choices and address feedback. When using an agent to help
+answer a reviewer, check the answer and send only what is relevant.
+
+Use MRI Ruby 3.4 or newer for development tooling, then run all checks:
+
+```sh
+bundle install
+bundle exec rake
+```
+
+The default task runs inline RBS checks with Steep, the specs and
+installed-gem smoke tests. Run `bundle exec rake types`, `spec`, `package`
+or `smoke` for individual checks.
+
+`rake types` validates that every authored file opts into inline RBS, every
+method carries a `#:` annotation, and Steep accepts the runtime and tooling
+implementations in `lib/` and `script/` against the generated signatures.
+Keep project types inline. `untyped` is accepted at the Thor framework
+boundary but not as a substitute for known types. `sig/dependencies.rbs`
+fills gaps in dependency signatures, including the `CommandHook` module
+self type that rbs-inline cannot emit. Generated signatures live only in
+ignored `tmp/` during development and inside the built gem under `sig/`,
+never in the source tree.
+
+Keep the runtime dependency limited to `thor`. Cover command, nesting and
+prompt behavior with real Thor subprocesses: fixtures in `spec/support` run
+isolated processes with bounded timeouts and reap every child. PTY fixtures
+synchronize on observed state, not sleeps. Compatibility runs use
+`Gemfile.compat` with pinned `THOR_VERSION` and `RSPEC_MINOR` on the oldest
+supported Rubies. Do not load modern development tooling into Ruby 2.1
+runtime checks.
+
+Specs run in random order and report their seed. Reproduce an ordering
+failure with `bundle exec rspec --seed <seed>` and narrow it with
+`bundle exec rspec --seed <seed> --bisect`.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,88 @@
+# thor-osc7501
+
+Add OSC 7501 terminal status to ordinary Thor commands.
+
+```ruby
+# Gemfile
+gem 'thor-osc7501', require: false
+```
+
+```ruby
+# Thorfile
+require 'thor/osc7501'
+```
+
+Run `bundle exec thor deploy`. A supporting terminal receives the run as its
+root record with the current command and outcome. Each new run replaces it,
+and ordinary command output, input, return values and exits continue
+unchanged. A Ruby executable can require the same entrypoint before its CLI
+class starts. `Klass.start` works the same way. Installing the gem alone
+does not activate it.
+
+## What is reported
+
+One root record per outer run, `app=thor`, no identity and no percentage.
+Reporting starts when the first command executes. Sequential nesting shows
+the executing leaf command and restores its caller on return. Overlapping
+commands show `N active commands`. Framework `help`, `list` and `version`
+operations never count as work, while user commands with those names report
+normally. Skipped invocations produce no records.
+
+During `ask`, `yes?` or `no?`, the run reports `blocked` attention with the
+prompt text (`kind=question`). Pending prompts take priority over working
+commands. With several prompts pending, the most recently entered one shows
+and the previous one resumes when it resolves. Entered answers are never
+reported. After input returns, the current working status resumes.
+
+Normal outer completion reports `done`. An escaping exception or
+unsuccessful `SystemExit` reports `error`, and `Interrupt` or successful
+`SystemExit` reports `idle`, preserving Thor's behavior. Errors handled
+inside an enclosing command body do not finalize the run. Command return
+values never imply success or failure.
+
+## Output controls
+
+| Setting | Behavior |
+| --- | --- |
+| `THOR_OSC7501=auto` | Default. Report to stdout only when it is a TTY and `TERM` is not `dumb`. |
+| `THOR_OSC7501=force` | Report to stdout even when redirected. |
+| `THOR_OSC7501=off` | Disable Thor reporting. |
+| any other value | Raise `ArgumentError`. |
+
+Reporting IO failures disable reporting without replacing the command's own
+exception or result. Messages are sanitized to a single plain-text line and
+capped at 2048 decoded UTF-8 bytes. The ordinary terminal prompt is
+unchanged.
+
+## Boundaries
+
+Observation covers Thor dispatch: normal CLI loading, direct `Klass.start`
+and nested `invoke`, plus `Thor::Group` sequences through the same path.
+Direct Ruby method calls that bypass Thor dispatch are outside scope.
+Prompt coverage extends to `Thor::Shell::Basic`, `Color` and subclasses that
+retain normal prompt behavior, including shells created before activation. A
+custom shell overriding `ask` directly, or direct stdin reads, are outside
+guaranteed coverage.
+
+The concurrency guarantee covers overlapping invocations belonging to one
+outer run. Unrelated simultaneous top-level starts, detached work outliving
+the command, fork coordination and asynchronous frameworks are outside
+first-release guarantees. Synchronous subprocesses keep the run working. We
+do not inspect their output or auto-enable companion reporters, and an
+independently enabled root reporter in a child can overwrite the shared root
+record.
+
+## Compatibility and development
+
+MRI >= 2.1 and Thor >= 0.19.4, with no speculative upper bound. Development
+requires a modern Ruby only for tooling:
+
+```sh
+bundle install
+bundle exec rake
+```
+
+The default task checks inline RBS with Steep, runs the specs and exercises
+the packaged gem in an isolated environment. `bundle exec rspec` runs the
+specs alone. See [CONTRIBUTING.md](CONTRIBUTING.md) for the development
+workflow and [CHANGELOG.md](CHANGELOG.md) for changes.

data/examples/Thorfile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+# A tiny generic Thor CLI that exercises OSC 7501 reporting: work, nested
+# work, a confirmation prompt, then completion. Run with:
+#   bundle exec thor deploy
+# and compare against THOR_OSC7501=off. A failing command and Ctrl-C show
+# the error and idle outcomes.
+require 'thor/osc7501'
+
+class Deploy < Thor
+  default_task :deploy
+
+  desc 'deploy', 'Work, confirm, then finish'
+  def deploy
+    say 'preparing'
+    sleep 1
+    invoke :health
+    proceed = yes? 'Proceed with release?'
+    raise 'declined' unless proceed
+    say 'releasing'
+    sleep 1
+    say 'done'
+  end
+
+  desc 'health', 'Nested work example'
+  def health
+    say 'checking'
+    sleep 1
+    say 'healthy'
+  end
+
+  desc 'fail', 'Failure variant'
+  def fail
+    say 'preparing'
+    raise 'boom'
+  end
+end

data/lib/thor/osc7501/hooks.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require 'thor'
+require_relative 'run'
+
+class Thor
+  module OSC7501
+    # Prepended to Thor::Command: wraps executed commands in Run
+    # contexts. Hooking Command#run sits after Thor's invocation
+    # deduplication, so skipped commands produce no records. Late
+    # prepending the Base module alone would not reach existing
+    # includers (verified on Ruby 2.1 during research). The module's
+    # self type is declared in sig/dependencies.rbs: rbs-inline cannot
+    # emit it.
+    module CommandHook
+      #: [T] (untyped instance, *untyped args) { (*untyped) -> T } -> T
+      def run(instance, *args, &block)
+        return super if OSC7501.framework_command?(self)
+        run = OSC7501.current_run
+        if run
+          run.during_command(name) { super }
+        else
+          OSC7501.start_run { |outer| outer.during_command(name) { super } }
+        end
+      end
+    end
+
+    # Prepended to Thor::Base-derived classes' singleton classes: owns the
+    # single root record for the outer run. Nested .start calls and nested
+    # dispatches reuse the active run.
+    module StartHook
+      #: [T] (*untyped args) { (*untyped) -> T } -> T
+      def start(*args, &block)
+        return super if OSC7501.current_run
+        OSC7501.start_run { super(*args, &block) }
+      end
+    end
+
+    # Prepended to Thor::Shell::Basic: reports pending prompts on the
+    # configured shell without replacing it. Covers Basic and subclasses
+    # such as Color, including shells created before activation. Shells
+    # overriding ask directly are outside guaranteed coverage.
+    module ShellHook
+      #: [T] (untyped statement, *untyped args) { (*untyped) -> T } -> T
+      def ask(statement, *args, &block)
+        run = OSC7501.current_run
+        if run
+          run.during_prompt(statement.to_s) { super(statement, *args, &block) }
+        else
+          super
+        end
+      end
+    end
+
+    # Prepended to Thor::Base's singleton class: hooks classes that
+    # include Thor::Base after activation.
+    module IncludeHook
+      #: (Class base) -> void
+      def included(base)
+        super
+        return unless base.is_a?(Class)
+        return if base.singleton_class.ancestors.include?(StartHook)
+        base.singleton_class.prepend(StartHook)
+      end
+    end
+
+    # Framework-owned commands never count as application work.
+    FRAMEWORK_COMMANDS = %w[help list version install installed update uninstall tree].freeze
+
+    class << self
+      # @rbs @installed: bool
+      # @rbs @run: Run?
+
+      #: () -> void
+      def install!
+        return if @installed
+        @installed = true
+        Thor::Command.prepend(CommandHook)
+        Thor::Base.subclasses.each do |klass|
+          next if klass.singleton_class.ancestors.include?(StartHook)
+          klass.singleton_class.prepend(StartHook)
+        end
+        Thor::Base.singleton_class.prepend(IncludeHook)
+        Thor::Shell::Basic.prepend(ShellHook)
+      end
+
+      #: () -> Run?
+      def current_run
+        @run
+      end
+
+      #: [T] () { (Run) -> T } -> T
+      def start_run
+        run = Run.new($stdout, mode: ENV.fetch('THOR_OSC7501', 'auto'))
+        previous = @run
+        @run = run
+        begin
+          run.during_run { yield run }
+        ensure
+          @run = previous
+        end
+      end
+
+      # Framework identity is the command object registered by the Thor
+      # framework classes themselves, not the command name: user commands
+      # called list or version keep reporting.
+      #: (untyped command) -> bool
+      def framework_command?(command)
+        return false unless FRAMEWORK_COMMANDS.include?(command.name)
+        return true if command.equal?(Thor.all_commands[command.name])
+        return false unless defined?(Thor::Runner)
+        command.equal?(Thor::Runner.all_commands[command.name])
+      end
+    end
+  end
+end

data/lib/thor/osc7501/run.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require_relative 'writer'
+
+class Thor
+  module OSC7501
+    # Owns the single root record for one outer Thor run: active command
+    # contexts, pending prompts and the final outcome. Private to the
+    # adapter. Hooks call during_run/during_command/during_prompt.
+    class Run # :nodoc: all
+      # @rbs @writer: Writer
+      # @rbs @mutex: Mutex
+      # @rbs @finished: bool
+      # @rbs @reported_work: bool
+      # @rbs @erred: bool
+      # @rbs @stacks: Hash[Thread, Array[String]]
+      # @rbs @prompts: Array[[Thread, String]]
+
+      #: (IO | StringIO output, mode: String) -> void
+      def initialize(output, mode:)
+        @writer = Writer.new(output, mode: mode)
+        @mutex = Mutex.new
+        @finished = false
+        @reported_work = false
+        @erred = false
+        @stacks = {}
+        @prompts = []
+      end
+
+      # A run finalizes only if real work or a prompt was reported:
+      # framework-only invocations (help, list, version) produce no
+      # records at all. An exception escaping the outermost command
+      # marks the run failed even when Thor consumes it at the outer
+      # boundary (exit_on_failure? false). Errors handled inside an
+      # enclosing command body do not.
+      #: [T] () { () -> T } -> T
+      def during_run
+        result = yield
+        finish(@erred ? 'error' : 'done', @erred ? 'Failed' : 'Completed')
+        result
+      rescue Exception => e # Preserve Thor's handling of Interrupt and SystemExit.
+        stopped = e.is_a?(Interrupt) || (e.is_a?(SystemExit) && e.success?)
+        finish(stopped ? 'idle' : 'error', stopped ? 'Stopped' : 'Failed')
+        raise
+      end
+
+      #: [T] (String) { () -> T } -> T
+      def during_command(name)
+        stack = (@stacks[Thread.current] ||= [])
+        @mutex.synchronize do
+          @reported_work = true
+          stack << name
+          report
+        end
+        begin
+          yield
+        rescue Exception
+          # Sole-command escape reaches Thor's outer boundary: mark the
+          # run failed even if Thor consumes the error there.
+          @mutex.synchronize { @erred = true if sole_context?(stack) }
+          raise
+        ensure
+          @mutex.synchronize do
+            stack.pop
+            @stacks.delete(Thread.current) if stack.empty?
+            report
+          end
+        end
+      end
+
+      #: [T] (String) { () -> T } -> T
+      def during_prompt(text)
+        # @type var prompt: [Thread, String]
+        prompt = [Thread.current, text]
+        @mutex.synchronize do
+          @reported_work = true
+          @prompts << prompt
+          report
+        end
+        begin
+          yield
+        ensure
+          @mutex.synchronize do
+            @prompts.delete(prompt)
+            report
+          end
+        end
+      end
+
+      private
+
+      #: (String, String) -> void
+      def finish(state, message)
+        @mutex.synchronize do
+          return unless @reported_work
+          @finished = true
+          @writer.emit(state: state, msg: message)
+        end
+      end
+
+      # Pending prompts take priority over working commands. No default
+      # working record is emitted when no command remains active: the
+      # run's finalization provides the next record.
+      #: () -> void
+      def report
+        return if @finished
+
+        prompt = @prompts.last
+        if prompt
+          @writer.emit(state: 'blocked', msg: prompt[1], kind: 'question')
+          return
+        end
+        active = active_commands
+        return if active.empty?
+        if active.size == 1
+          @writer.emit(state: 'working', msg: active.first.last)
+        else
+          @writer.emit(state: 'working', msg: "#{active.size} active commands")
+        end
+      end
+
+      #: () -> Array[Array[String]]
+      def active_commands
+        @stacks.values.reject(&:empty?)
+      end
+
+      #: (Array[String]) -> bool
+      def sole_context?(stack)
+        @stacks.values.all? { |other| other.equal?(stack) || other.empty? } && stack.length == 1
+      end
+    end
+  end
+end

data/lib/thor/osc7501/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+class Thor
+  module OSC7501
+    #: String
+    VERSION = '0.1.0'
+  end
+end

data/lib/thor/osc7501/writer.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+class Thor
+  module OSC7501
+    # Encodes status records onto an output stream following the family
+    # writer contract. Private to the adapter.
+    class Writer # :nodoc: all
+      # @rbs @output: IO | StringIO
+      # @rbs @enabled: bool
+
+      #: (IO | StringIO output, mode: String) -> void
+      def initialize(output, mode:)
+        raise ArgumentError, 'THOR_OSC7501 must be auto, off, or force' unless %w[auto off force].include?(mode)
+
+        @output = output
+        @enabled = mode == 'force' || (mode == 'auto' && automatic_output?)
+      rescue IOError, SystemCallError
+        @enabled = false
+      end
+
+      #: (state: String, msg: String, ?kind: String?) -> nil
+      def emit(state:, msg:, kind: nil)
+        return nil unless @enabled
+
+        fields = ['app=thor', 'title=VGhvcg==', "state=#{state}"]
+        fields << "kind=#{kind}" if kind
+        fields << "msg=#{encode(msg, 2048)}"
+        @output.write("\e]7501;#{fields.join(':')}\e\\")
+        @output.flush if @output.respond_to?(:flush)
+        nil
+      rescue IOError, SystemCallError
+        # Reporting failures disable reporting without disturbing the command.
+        @enabled = false
+        nil
+      end
+
+      private
+
+      #: () -> bool
+      def automatic_output?
+        ENV['TERM'] != 'dumb' && @output.respond_to?(:tty?) && @output.tty?
+      end
+
+      #: (String, Integer) -> String
+      def encode(text, byte_limit)
+        input = text.to_s.byteslice(0, sanitization_byte_limit(byte_limit)) #: String
+        plain = input.encode('UTF-8', invalid: :replace, undef: :replace)
+        plain = plain.gsub(/\e\[[0-9;?]*[ -\/]*[@-~]/, '')
+        plain = plain.gsub(/[\u0000-\u001F\u007F-\u009F]/, ' ')
+        clean = plain.gsub(/\s+/, ' ').strip
+        bytes = 0
+        bounded = clean.each_char.take_while do |char|
+          bytes += char.bytesize
+          bytes <= byte_limit
+        end.join
+        [bounded].pack('m0')
+      end
+
+      # Bound sanitization work with 50% headroom for removed formatting.
+      #: (Integer) -> Integer
+      def sanitization_byte_limit(output_byte_limit)
+        output_byte_limit + output_byte_limit / 2
+      end
+    end
+  end
+end

data/lib/thor/osc7501.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require_relative 'osc7501/version'
+require_relative 'osc7501/hooks'
+
+# Requiring this entrypoint activates Thor OSC 7501 reporting once:
+# ordinary Thor commands and prompts emit terminal status while output,
+# input, return values and exit behavior stay unchanged.
+class Thor
+  module OSC7501
+    install!
+  end
+end

data/sig/thor/osc7501/hooks.rbs

@@ -0,0 +1,63 @@
+# Generated from lib/thor/osc7501/hooks.rb with RBS::Inline
+
+class Thor
+  module OSC7501
+    # Prepended to Thor::Command: wraps executed commands in Run
+    # contexts. Hooking Command#run sits after Thor's invocation
+    # deduplication, so skipped commands produce no records. Late
+    # prepending the Base module alone would not reach existing
+    # includers (verified on Ruby 2.1 during research). The module's
+    # self type is declared in sig/dependencies.rbs: rbs-inline cannot
+    # emit it.
+    module CommandHook
+      # : [T] (untyped instance, *untyped args) { (*untyped) -> T } -> T
+      def run: [T] (untyped instance, *untyped args) { (*untyped) -> T } -> T
+    end
+
+    # Prepended to Thor::Base-derived classes' singleton classes: owns the
+    # single root record for the outer run. Nested .start calls and nested
+    # dispatches reuse the active run.
+    module StartHook
+      # : [T] (*untyped args) { (*untyped) -> T } -> T
+      def start: [T] (*untyped args) { (*untyped) -> T } -> T
+    end
+
+    # Prepended to Thor::Shell::Basic: reports pending prompts on the
+    # configured shell without replacing it. Covers Basic and subclasses
+    # such as Color, including shells created before activation. Shells
+    # overriding ask directly are outside guaranteed coverage.
+    module ShellHook
+      # : [T] (untyped statement, *untyped args) { (*untyped) -> T } -> T
+      def ask: [T] (untyped statement, *untyped args) { (*untyped) -> T } -> T
+    end
+
+    # Prepended to Thor::Base's singleton class: hooks classes that
+    # include Thor::Base after activation.
+    module IncludeHook
+      # : (Class base) -> void
+      def included: (Class base) -> void
+    end
+
+    # Framework-owned commands never count as application work.
+    FRAMEWORK_COMMANDS: untyped
+
+    @installed: bool
+
+    @run: Run?
+
+    # : () -> void
+    def self.install!: () -> void
+
+    # : () -> Run?
+    def self.current_run: () -> Run?
+
+    # : [T] () { (Run) -> T } -> T
+    def self.start_run: [T] () { (Run) -> T } -> T
+
+    # Framework identity is the command object registered by the Thor
+    # framework classes themselves, not the command name: user commands
+    # called list or version keep reporting.
+    # : (untyped command) -> bool
+    def self.framework_command?: (untyped command) -> bool
+  end
+end

data/sig/thor/osc7501/run.rbs

@@ -0,0 +1,59 @@
+# Generated from lib/thor/osc7501/run.rb with RBS::Inline
+
+class Thor
+  module OSC7501
+    # Owns the single root record for one outer Thor run: active command
+    # contexts, pending prompts and the final outcome. Private to the
+    # adapter. Hooks call during_run/during_command/during_prompt.
+    class Run
+      @writer: Writer
+
+      @mutex: Mutex
+
+      @finished: bool
+
+      @reported_work: bool
+
+      @erred: bool
+
+      @stacks: Hash[Thread, Array[String]]
+
+      @prompts: Array[[ Thread, String ]]
+
+      # : (IO | StringIO output, mode: String) -> void
+      def initialize: (IO | StringIO output, mode: String) -> void
+
+      # A run finalizes only if real work or a prompt was reported:
+      # framework-only invocations (help, list, version) produce no
+      # records at all. An exception escaping the outermost command
+      # marks the run failed even when Thor consumes it at the outer
+      # boundary (exit_on_failure? false). Errors handled inside an
+      # enclosing command body do not.
+      # : [T] () { () -> T } -> T
+      def during_run: [T] () { () -> T } -> T
+
+      # : [T] (String) { () -> T } -> T
+      def during_command: [T] (String) { () -> T } -> T
+
+      # : [T] (String) { () -> T } -> T
+      def during_prompt: [T] (String) { () -> T } -> T
+
+      private
+
+      # : (String, String) -> void
+      def finish: (String, String) -> void
+
+      # Pending prompts take priority over working commands. No default
+      # working record is emitted when no command remains active: the
+      # run's finalization provides the next record.
+      # : () -> void
+      def report: () -> void
+
+      # : () -> Array[Array[String]]
+      def active_commands: () -> Array[Array[String]]
+
+      # : (Array[String]) -> bool
+      def sole_context?: (Array[String]) -> bool
+    end
+  end
+end

data/sig/thor/osc7501/version.rbs

@@ -0,0 +1,8 @@
+# Generated from lib/thor/osc7501/version.rb with RBS::Inline
+
+class Thor
+  module OSC7501
+    # : String
+    VERSION: ::String
+  end
+end

data/sig/thor/osc7501/writer.rbs

@@ -0,0 +1,31 @@
+# Generated from lib/thor/osc7501/writer.rb with RBS::Inline
+
+class Thor
+  module OSC7501
+    # Encodes status records onto an output stream following the family
+    # writer contract. Private to the adapter.
+    class Writer
+      @output: IO | StringIO
+
+      @enabled: bool
+
+      # : (IO | StringIO output, mode: String) -> void
+      def initialize: (IO | StringIO output, mode: String) -> void
+
+      # : (state: String, msg: String, ?kind: String?) -> nil
+      def emit: (state: String, msg: String, ?kind: String?) -> nil
+
+      private
+
+      # : () -> bool
+      def automatic_output?: () -> bool
+
+      # : (String, Integer) -> String
+      def encode: (String, Integer) -> String
+
+      # Bound sanitization work with 50% headroom for removed formatting.
+      # : (Integer) -> Integer
+      def sanitization_byte_limit: (Integer) -> Integer
+    end
+  end
+end

data/sig/thor/osc7501.rbs

@@ -0,0 +1,9 @@
+# Generated from lib/thor/osc7501.rb with RBS::Inline
+
+# Requiring this entrypoint activates Thor OSC 7501 reporting once:
+# ordinary Thor commands and prompts emit terminal status while output,
+# input, return values and exit behavior stay unchanged.
+class Thor
+  module OSC7501
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: thor-osc7501
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Cosgrove
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+description: Reports Thor command and prompt activity through OSC 7501.
+email:
+- cosgroveb@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- examples/Thorfile
+- lib/thor/osc7501.rb
+- lib/thor/osc7501/hooks.rb
+- lib/thor/osc7501/run.rb
+- lib/thor/osc7501/version.rb
+- lib/thor/osc7501/writer.rb
+- sig/thor/osc7501.rbs
+- sig/thor/osc7501/hooks.rbs
+- sig/thor/osc7501/run.rbs
+- sig/thor/osc7501/version.rbs
+- sig/thor/osc7501/writer.rbs
+homepage: https://github.com/cosgroveb/thor-osc7501
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/cosgroveb/thor-osc7501
+  bug_tracker_uri: https://github.com/cosgroveb/thor-osc7501/issues
+  changelog_uri: https://github.com/cosgroveb/thor-osc7501/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Opt-in OSC 7501 terminal status for Thor commands
+test_files: []