Merge pull request #24 from Arkoniak/markdown

added markdown support

Author: Arkoniak

Project.toml

@@ -1,7 +1,7 @@
 name = "MiniLoggers"
 uuid = "93f3dd0f-005d-4452-894a-a31841fa4078"
 authors = ["Andrey Oskin"]
-version = "0.3.0"
+version = "0.3.1"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

README.md

@@ -20,7 +20,7 @@ In it's most simple form, `MiniLoggers.jl` is used as
 ```julia
 using MiniLoggers
 
-MiniLogger(minlevel = MiniLogger.Debug) |> global_logger
+MiniLogger(minlevel = MiniLoggers.Debug) |> global_logger
 
 x = 1
 y = "asd"
@@ -33,7 +33,7 @@ y = "asd"
 
 and produces 
 
-![default_fmt](images/default_fmt.png)
+![default_fmt](images/default_fmt2.png)
 
 But one can make it more colourful and add more details with initilization like the following
 

images/default_fmt2.png

@@ -1,6 +1,7 @@
 module MiniLoggers
 
 using Dates
+using Markdown
 import Logging: AbstractLogger, shouldlog, min_enabled_level, catch_exceptions, handle_message, LogLevel
 using Logging: Warn, Info, Debug, Error, BelowMinLevel, AboveMaxLevel, global_logger, with_logger, default_logcolor
 

src/MiniLoggers.jl

@@ -1,6 +1,7 @@
 abstract type AbstractMode end
 struct NoTransformations <: AbstractMode end
 struct Squash <: AbstractMode end
+struct MDown <: AbstractMode end
 
 struct MiniLogger{AM <: AbstractMode, IOT1 <: IO, IOT2 <: IO, DFT <: DateFormat} <: AbstractLogger
     io::IOT1
@@ -29,6 +30,8 @@ function getmode(mode::Symbol)
         return NoTransformations()
     elseif mode == :squash
         return Squash()
+    elseif mode == :markdown
+        return MDown()
     end
 end
 
@@ -57,6 +60,7 @@ Supported keyword arguments include:
 * `message_mode` (default: `:squash`): choose how message is transformed before being printed out. Following modes are supported:
     * `:notransformations`: message printed out as is, without any extra transformations
     * `:squash`: message is squashed to a single line, i.e. all `\\n` are changed to ` ` and `\\r` are removed.
+    * `:markdown`: message is treated as if it is written in markdown
 * `flush` (default: `true`): whether to `flush` IO stream for each log message. Flush behaviour also affected by `flush_threshold` argument.
 * `flush_threshold::Union{Integer, TimePeriod}` (default: 0): if this argument is nonzero and `flush` is `true`, then `io` is flushed only once per `flush_threshold` milliseconds. I.e. if time between two consecutive log messages is less then `flush_threshold`, then second message is not flushed and will have to wait for the next log event.
 * `dtformat` (default: "yyyy-mm-dd HH:MM:SS"): if `datetime` parameter is used in `format` argument, this dateformat is applied for output timestamps.
@@ -122,6 +126,7 @@ function _showmessage(io, msg, ::Squash)
         print(io, " ", replace(msglines[i], "\r" => ""))
     end
 end
+_showmessage(io, msg, ::MDown) = show(io, MIME"text/plain"(), Markdown.parse(msg))
 _showmessage(io, msg, ::NoTransformations) = print(io, msg)
 
 showmessage(io, msg, mode) = _showmessage(io, msg, mode)

src/minilogger.jl

@@ -45,6 +45,18 @@ end
     end
 end
 
+@testset "markdown support" begin
+    io = IOBuffer()
+    ioc = IOContext(io, :color => true)
+    logger = MiniLogger(io = ioc, format = "{message}", message_mode = :markdown)
+    with_logger(logger) do
+        @info "**foo**"
+
+        s = String(take!(io))
+        @test s == "  \e[1mfoo\e[22m\n"
+    end
+end
+
 @testset "badcaret" begin
     io = IOBuffer()
     logger = MiniLogger(io = io, format = "{message}")