feat : add custom highlight to add color to logs (#486)

Author: IronMine

build.gradle

@@ -87,6 +87,7 @@ dependencies {
     implementation 'ch.qos.logback:logback-core'
     implementation 'ch.qos.logback:logback-classic'
     implementation "info.picocli:picocli:${picocliVersion}"
+    implementation 'org.fusesource.jansi:jansi:2.4.0'
     implementation 'com.fasterxml.jackson.core:jackson-databind'
     implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml'
     implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml'

src/main/java/me/itzg/helpers/logger/CustomHighlight.java

@@ -0,0 +1,24 @@
+package me.itzg.helpers.logger;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.pattern.color.ANSIConstants;
+import ch.qos.logback.core.pattern.color.ForegroundCompositeConverterBase;
+
+public class CustomHighlight extends ForegroundCompositeConverterBase<ILoggingEvent> {
+
+    @Override
+    protected String getForegroundColorCode(ILoggingEvent event) {
+        Level level = event.getLevel();
+        switch (level.toInt()) {
+        case Level.ERROR_INT:
+            return ANSIConstants.BOLD + ANSIConstants.RED_FG; // same as default color scheme
+        case Level.WARN_INT:
+            return ANSIConstants.YELLOW_FG;// same as default color scheme
+        case Level.INFO_INT:
+        default:
+            return ANSIConstants.DEFAULT_FG;
+        }
+    }
+
+}

src/main/resources/logback.xml

@@ -1,5 +1,7 @@
 <configuration>
+    <conversionRule conversionWord="customHighlight" converterClass="me.itzg.helpers.logger.CustomHighlight" />
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <withJansi>true</withJansi>
         <filter class="ch.qos.logback.classic.filter.LevelFilter">
             <level>INFO</level>
             <onMatch>ACCEPT</onMatch>
@@ -8,10 +10,11 @@
         <!-- encoders are assigned the type
                  ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
         <encoder>
-            <pattern>[mc-image-helper] %d{HH:mm:ss.SSS} %-5level : %msg%n</pattern>
+            <pattern>%customHighlight([mc-image-helper] %d{HH:mm:ss.SSS} %-5level : %msg%n)</pattern>
         </encoder>
     </appender>
     <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
+        <withJansi>true</withJansi>
         <filter class="ch.qos.logback.classic.filter.LevelFilter">
             <level>INFO</level>
             <onMatch>DENY</onMatch>
@@ -21,7 +24,7 @@
         <!-- encoders are assigned the type
              ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
         <encoder>
-            <pattern>[mc-image-helper] %d{HH:mm:ss.SSS} %-5level : %msg%n</pattern>
+            <pattern>%customHighlight([mc-image-helper] %d{HH:mm:ss.SSS} %-5level : %msg%n)</pattern>
         </encoder>
     </appender>