Add emojis

Author: simc

CHANGELOG.md

@@ -1,2 +1,6 @@
+## 0.5.0
+- Add emojis
+- `LogFilter` is a class now
+
 ## 0.4.0
 - First version of the new logger

README.md

@@ -71,7 +71,8 @@ var logger = Logger(
   printer: PrettyPrinter(
     methodCount: 2, // number of method calls to be displayed
     errorMethodCount: 8, // number of method calls if stacktrace is provided
-    lineLength : 120 // width of the output
+    lineLength: 120, // width of the output
+    printEmojis: true, // Print an emoji for each log message
   ),
 )
 ```
@@ -93,13 +94,16 @@ If you created a cool `LogPrinter` which might be helpful to others, feel free t
 
 ## LogFilter
 
-The `LogFilter` filters which logs should be shown and which don't.
-The default implementation shows all logs with `level >= Logger.level` while in debug mode. In release mode all logs are omitted.
+The `LogFilter` decides which logs should be shown and which don't.
+The default implementation (`DebugFilter`) shows all logs with `level >= Logger.level` while in debug mode. In release mode all logs are omitted.
 
 You can create your own `LogFilter` like this:
 ```dart
-var filter = (Level level, dynamic message, dynamic error, StackTrace stackTrace) {
+class MyFilter extends LogFilter {
+  @override
+  bool shouldLog(Level level, dynamic message, [dynamic error, StackTrace stackTrace]) {
     return true;
+  }
 }
 ```
 This will show all logs even in release mode. (**NOT** a good idea)

art/screenshot.png

@@ -4,5 +4,6 @@ library logger;
 import 'dart:convert';
 import 'package:ansicolor/ansicolor.dart';
 
+part 'src/debug_filter.dart';
 part 'src/pretty_printer.dart';
 part 'src/logger.dart';

lib/logger.dart

@@ -0,0 +1,19 @@
+part of logger;
+
+/// Default implementation of [LogFilter].
+///
+/// Shows all logs with `level >= Logger.level` while in debug mode. In release
+/// mode all logs are omitted.
+class DebugFilter extends LogFilter {
+  @override
+  bool shouldLog(Level level, message, [error, StackTrace stackTrace]) {
+    var shouldLog = false;
+    assert(() {
+      if (level.index >= Logger.level.index) {
+        shouldLog = true;
+      }
+      return true;
+    }());
+    return shouldLog;
+  }
+}

lib/src/debug_filter.dart

@@ -12,18 +12,6 @@ enum Level {
   nothing,
 }
 
-/// `LogFilter` is called every time a new log message is sent and decides if
-/// it will be printed or canceled.
-///
-/// The default implementation is [Logger._defaultFilter].
-/// Every implementation should consider [Logger.level].
-typedef LogFilter = bool Function(
-  Level level,
-  dynamic message, [
-  dynamic error,
-  StackTrace stackTrace,
-]);
-
 /// An abstract handler of log messages.
 ///
 /// You can implement a `LogPrinter` from scratch or extend [PrettyPrinter].
@@ -32,6 +20,19 @@ abstract class LogPrinter {
   void log(Level level, dynamic message, dynamic error, StackTrace stackTrace);
 }
 
+/// An abstract handler of log messages.
+///
+/// You can implement your own `LogFilter` or use [DebugFilter].
+/// Every implementation should consider [Logger.level].
+abstract class LogFilter {
+  /// Is called every time a new log message is sent and decides if
+  /// it will be printed or canceled.
+  ///
+  /// Returns `true` if the message should be logged.
+  bool shouldLog(Level level, dynamic message,
+      [dynamic error, StackTrace stackTrace]);
+}
+
 /// Use instances of logger to send log messages to the [LogPrinter].
 class Logger {
   /// The current logging level of the app.
@@ -48,7 +49,7 @@ class Logger {
   /// [PrettyPrinter] and [_defaultFilter] will be used.
   Logger({LogPrinter printer, LogFilter filter})
       : _printer = printer ?? PrettyPrinter(),
-        _filter = filter ?? _defaultFilter;
+        _filter = filter ?? DebugFilter();
 
   /// Log message at level [Level.verbose].
   void v(dynamic message, [dynamic error, StackTrace stackTrace]) {
@@ -83,25 +84,8 @@ class Logger {
   /// Log message with [level].
   void log(Level level, dynamic message,
       [dynamic error, StackTrace stackTrace]) {
-    if (_filter(level, message, error, stackTrace)) {
+    if (_filter.shouldLog(level, message, error, stackTrace)) {
       _printer.log(level, message, error, stackTrace);
     }
   }
-
-  /// Default implementation of [LogFilter]. All log
-  static bool _defaultFilter(
-    Level level,
-    dynamic message, [
-    dynamic error,
-    StackTrace stackTrace,
-  ]) {
-    var shouldLog = false;
-    assert(() {
-      if (level.index >= Logger.level.index) {
-        shouldLog = true;
-      }
-      return true;
-    }());
-    return shouldLog;
-  }
 }

lib/src/logger.dart

@@ -29,12 +29,22 @@ class PrettyPrinter extends LogPrinter {
     Level.wtf: AnsiPen()..xterm(199),
   };
 
+  static final emojis = {
+    Level.verbose: '',
+    Level.debug: '🐛 ',
+    Level.info: '💡 ',
+    Level.warning: '⚠️ ',
+    Level.error: '⛔ ',
+    Level.wtf: '👾 ',
+  };
+
   static final stackTraceRegex = RegExp(r'#[0-9]+[\s]+(.+) \(([^\s]+)\)');
   static const String indent = '  ';
 
   final int methodCount;
   final int errorMethodCount;
   final int lineLength;
+  final bool printEmojis;
 
   String topBorder = '';
   String middleBorder = '';
@@ -44,6 +54,7 @@ class PrettyPrinter extends LogPrinter {
     this.methodCount = 2,
     this.errorMethodCount = 8,
     this.lineLength = 120,
+    this.printEmojis = true,
   }) {
     var doubleDividerLine = StringBuffer();
     var singleDividerLine = StringBuffer();
@@ -92,7 +103,7 @@ class PrettyPrinter extends LogPrinter {
         if (match.group(2).startsWith('package:logger')) {
           continue;
         }
-        var newLine = ("#${count + 1}   ${match.group(1)} (${match.group(2)})");
+        var newLine = ("#$count   ${match.group(1)} (${match.group(2)})");
         formatted.add(newLine.replaceAll('<anonymous closure>', '()'));
         if (++count == methodCount) {
           break;
@@ -148,8 +159,10 @@ class PrettyPrinter extends LogPrinter {
       output.add(pen(middleBorder));
     }
 
+    var emoji = printEmojis ? emojis[level] : '';
     for (var line in message.split('\n')) {
-      output.add(pen('$verticalLine $line'));
+      output.add(pen('$verticalLine $emoji$line'));
+      emoji = '';
     }
     output.add(pen(bottomBorder));
 

lib/src/pretty_printer.dart

@@ -1,6 +1,6 @@
 name: logger
 description: Small, easy to use and extensible logger which prints beautiful logs.
-version: 0.4.0
+version: 0.5.0
 author: Simon Leier <[email protected]>
 homepage: https://github.com/leisim/logger