0.0
The project is in a healthy, maintained state
Reports Rake task activity and outcomes through OSC 7501.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

>= 12.3.3
 Project Readme

rake-osc7501

Add OSC 7501 terminal status to ordinary Rake tasks.

# Gemfile
gem 'rake-osc7501'
# Rakefile
require 'rake/osc7501'

task(:example) { sleep 5 }
task default: :example

Run bundle exec rake. A supporting terminal receives the run as its root record with task activity and the outcome. Each new run replaces it, and ordinary command output continues.

Reporting also sets the terminal title. While one task executes, the title is rake › <task>. While several tasks run in parallel, it is rake › <n> active tasks. The title returns to rake after the last task, on completion, and on error or stop.

RSpec tasks

For managed child reporting, add rspec-osc7501 0.1.4 or newer and use the standard RSpec task class:

require 'rspec/core/rake_task'
require 'rake/osc7501'

RSpec::Core::RakeTask.new(:spec)
task default: [:example, :spec]

Each task invocation gets a unique child record, and a new run replaces only the root record. Automatic selection preserves RSpec's configured formatters. Missing or older rspec-osc7501 installations leave the original RSpec command intact, and direct rspec commands still need explicit OSC formatter selection.

Output controls

Setting Behavior
RAKE_OSC7501=auto Default. Report to stdout only when it is a TTY and TERM is not dumb.
RAKE_OSC7501=force Report to stdout even when redirected.
RAKE_OSC7501=off Disable Rake reporting and automatic RSpec activation.
any other value Raise ArgumentError.

Outcomes and limits

Normal completion reports done. Exceptions and nonzero SystemExit report error, and Interrupt or early successful SystemExit report idle. The gem leaves Rake's scheduling, exceptions and exit behavior intact. Frames stay below 4096 bytes. The gem sanitizes messages and titles, resolves invalid UTF-8 by replacement, caps messages at 2048 decoded bytes and titles at 512 bytes including the rake › prefix. It installs no process-wide exit or signal hooks and reads no terminal input. Terminals control display, dismissal and notifications. We have not verified live Rex presentation.

Compatibility and development

Runtime targets MRI Ruby >= 2.1 and Rake >= 12.3.3. The optional RSpec task integration targets RSpec >= 3.6. See CONTRIBUTING.md for the full checks, release setup and compatibility instructions.