class Console::Config

Represents a configuration for the traces library.

Constants

DEFAULT: Load the default configuration.
PATH

Public Class Methods

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/config.rb, line 32
def self.default
        @default ||= self.load(PATH)
end

Load the default configuration. @returns [Config] The default configuration.

load (path)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/config.rb, line 20
def self.load(path)
        config = self.new
        
        if File.exist?(path)
                config.instance_eval(File.read(path), path)
        end
        
        return config
end

Load the configuration from the given path. @parameter path [String] The path to the configuration file. @returns [Config] The loaded configuration.

Public Instance Methods

log_level (env = ENV)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/config.rb, line 39
def log_level(env = ENV)
        Logger.default_log_level(env)
end

Set the default log level based on ‘$DEBUG` and `$VERBOSE`. 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.

make_logger (io = $stderr, env = ENV, **options)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/config.rb, line 72
def make_logger(io = $stderr, env = ENV, **options)
        if options[:verbose].nil?
                options[:verbose] = self.verbose?(env)
        end
        
        if options[:level].nil?
                options[:level] = self.log_level(env)
        end
        
        output = self.make_output(io, env, **options)
        
        logger = Logger.new(output, **options)
        
        make_resolver(logger)
        
        return logger
end

Create a logger with the given output and options.

@parameter output [IO] The output to write log messages to. @parameter env [Hash] The environment to read configuration from. @parameter options [Hash] Additional options to pass to the logger. @returns [Logger] The created logger.

make_output (io = nil, env = ENV, **options)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/config.rb, line 54
def make_output(io = nil, env = ENV, **options)
        Output.new(io, env, **options)
end

Create an output with the given output and options.

make_resolver (logger)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/config.rb, line 62
def make_resolver(logger)
        Resolver.default_resolver(logger)
end

Create a resolver with the given logger.

@parameter logger [Logger] The logger to set the log levels on. @returns [Resolver | Nil] The created resolver.

verbose? (env = ENV)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/config.rb, line 44
def verbose?(env = ENV)
        !$VERBOSE.nil? || env["CONSOLE_VERBOSE"]
end

Controls verbose output using ‘$VERBOSE`.