module Console::Output::Default - RDoc Documentation

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.34.0/lib/console/output/default.rb, line 46
def self.github_actions?(env = ENV)
        env["GITHUB_ACTIONS"] == "true"
end

Detect if we’re running in GitHub Actions, where human-readable output is preferred. GitHub Actions sets the GITHUB_ACTIONS environment variable to “true”.

mail? (env = ENV)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.34.0/lib/console/output/default.rb, line 40
def self.mail?(env = ENV)
        env.key?("MAILTO") && !env["MAILTO"].empty?
end

Detect if we’re running in a cron job or mail context where human-readable output is preferred. Cron jobs often have MAILTO set and lack TERM, or have minimal TERM values.

new (stream, env: ENV, **options)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.34.0/lib/console/output/default.rb, line 20
def self.new(stream, env: ENV, **options)
        stream ||= $stderr
        
        if stream.tty?
                output = Terminal.new(stream, **options)
        elsif self.mail?(env)
                output = Text.new(stream, **options)
        elsif self.github_actions?(env)
                output = XTerm.new(stream, **options)
        else
                output = Serialized.new(stream, **options)
        end
        
        return output
end

Create a new output format based on the given stream.

@parameter io [IO] The output stream. @parameter env [Hash] Environment variables (defaults to ENV for testing). @parameter options [Hash] Additional options to customize the output. @returns [Console::Output::Terminal | Console::Output::Serialized] The output instance, depending on whether the ‘io` is a terminal or not.