diff --git a/README.md b/README.md index 85a66f5..1b84d36 100644 --- a/README.md +++ b/README.md @@ -3,80 +3,88 @@ Mojo::Log::Colored - Colored Mojo logging
- # SYNOPSIS - - use Mojo::Log::Colored; - - # Log to STDERR - $app->log( - Mojo::Log::Colored->new( - - # optionally set the colors - colors => { - debug => "bold bright_white", - info => "bold bright_blue", - warn => "bold green", - error => "bold yellow", - fatal => "bold yellow on_red", - } - ) - ); - - - # DESCRIPTION - - Mojo::Log::Colored is a logger for Mojolicious with colored output for the terminal. It lets you define colors - for each log level based on L and comes with sensible default colors. The full lines in the log - will be colored. - - Since this inherits from L you can still give it a C, but the output would also be colored. - That does not make a lot of sense, so you don't want to do that. Use this for development, not production. - - # ATTRIBUTES +

+ + Coverage Status +

+
- L implements the following attributes. +# SYNOPSIS - ## colors + use Mojo::Log::Colored; - my $colors = $log->colors; - $log->colors( - { + # Log to STDERR + $app->log( + Mojo::Log::Colored->new( + + # optionally set the colors + colors => { debug => "bold bright_white", info => "bold bright_blue", warn => "bold green", error => "bold yellow", fatal => "bold yellow on_red", } - ); + ) + ); + +# DESCRIPTION - Takes a hash reference with the five log levels as keys and strings of colors as values. Refer to - L for more information about what kind of color you can use. +Mojo::Log::Colored is a logger for Mojolicious with colored output for the terminal. It lets you define colors +for each log level based on [Term::ANSIColor](https://metacpan.org/pod/Term::ANSIColor) and comes with sensible default colors. The full lines in the log +will be colored. - ## format +Since this inherits from [Mojo::Log](https://metacpan.org/pod/Mojo::Log) you can still give it a `file`, but the output would also be colored. +That does not make a lot of sense, so you don't want to do that. Use this for development, not production. - my $cb = $log->format; - $log = $log->format( sub { ... } ); +# ATTRIBUTES +[Mojo::Log::Colored](https://metacpan.org/pod/Mojo::Log::Colored) implements the following attributes. - A callback for formatting log messages. Cannot be passed to C at construction! See L for more information. +## colors - # METHODS + my $colors = $log->colors; + $log->colors( + { + debug => "bold bright_white", + info => "bold bright_blue", + warn => "bold green", + error => "bold yellow", + fatal => "bold yellow on_red", + } + ); - L inherits all methods from L and does not implement new ones. +Takes a hash reference with the five log levels as keys and strings of colors as values. Refer to +[Term::ANSIColor](https://metacpan.org/pod/Term::ANSIColor) for more information about what kind of color you can use. - # SEE ALSO +## format - L, L + my $cb = $log->format; + $log = $log->format( sub { ... } ); - # LICENSE +A callback for formatting log messages. Cannot be passed to `new` at construction! See [Mojo::Log](https://metacpan.org/pod/Mojo::Log) for more information. - Copyright (C) simbabque. +# METHODS - This library is free software; you can redistribute it and/or modify - it under the same terms as Perl itself. +[Mojo::Log::Colored](https://metacpan.org/pod/Mojo::Log::Colored) inherits all methods from [Mojo::Log](https://metacpan.org/pod/Mojo::Log) and does not implement new ones. - # AUTHOR +# SEE ALSO - simbabque Esimbabque@cpan.orgE - +[Mojo::Log](https://metacpan.org/pod/Mojo::Log), [Term::ANSIColor](https://metacpan.org/pod/Term::ANSIColor) + +# ACKNOWLEDGEMENTS + +This plugin was inspired by lanti asking about a way to easier find specific errors +in the Mojo log during unit test runs on [Stack Overflow](https://stackoverflow.com/q/44965998/1331451). + +# LICENSE + +Copyright (C) simbabque. + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +# AUTHOR + +simbabque diff --git a/lib/Mojo/Log/Colored.pm b/lib/Mojo/Log/Colored.pm index d379220..872ee67 100644 --- a/lib/Mojo/Log/Colored.pm +++ b/lib/Mojo/Log/Colored.pm @@ -40,10 +40,12 @@ __END__ Mojo::Log::Colored - Colored Mojo logging =begin html +

Coverage Status

+ =end html =head1 SYNOPSIS @@ -109,6 +111,11 @@ L inherits all methods from L and does not implem L, L +=head1 ACKNOWLEDGEMENTS + +This plugin was inspired by lanti asking about a way to easier find specific errors +in the Mojo log during unit test runs on L. + =head1 LICENSE Copyright (C) simbabque.