class Console::Logger

The standard logger interface with support for log levels and verbosity.

The log levels are: debug, info, warn, error, and fatal.

Public Class Methods

default_log_level (env = ENV, verbose: $VERBOSE, debug: $DEBUG)

Source

# File vendor/bundle/ruby/4.0.0/gems/console-1.34.2/lib/console/logger.rb, line 29
def self.default_log_level(env = ENV, verbose: $VERBOSE, debug: $DEBUG)
        if level = env["CONSOLE_LEVEL"]
                LEVELS[level.to_sym] || level.to_i
        elsif debug
                DEBUG
        elsif verbose.nil?
                WARN
        else
                INFO
        end
end

You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment. mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.

@parameter env [Hash] The environment to read the log level from. @parameter verbose [Boolean] The verbose flag. @parameter debug [Boolean] The debug flag. @returns [Integer] The default log level.

new (output, **options)

Source

# File vendor/bundle/ruby/4.0.0/gems/console-1.34.2/lib/console/logger.rb, line 47
def initialize(output, **options)
        # This is the expected default behaviour, but it may be nice to have a way to override it.
        output = Output::Failure.new(output, **options)
        
        super(output, **options)
end

Create a new logger.

@parameter output [Console::Output] The output destination. @parameter options [Hash] Additional options.

Calls superclass method

Public Instance Methods

progress (subject, total, **options)

Source

# File vendor/bundle/ruby/4.0.0/gems/console-1.34.2/lib/console/logger.rb, line 60
def progress(subject, total, **options)
        options[:severity] ||= :info
        
        Progress.new(subject, total, **options)
end

Create a progress indicator for the given subject.

@parameter subject [String] The subject of the progress indicator. @parameter total [Integer] The total number of items to process. @parameter options [Hash] Additional options passed to {Progress}. @returns [Progress] The progress indicator.