Improvements

Author: simc

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.6.0
+- Add option to output timestamp
+- Add option to disable color
+- Add `LogOutput`
+- Behaviour change of `LogPrinter`
+- Remove dependency
+
 ## 0.5.0
 - Add emojis
 - `LogFilter` is a class now

README.md

@@ -63,6 +63,7 @@ When creating a logger, you can pass some options:
 var logger = Logger(
   printer: PrettyPrinter(), // Use the PrettyPrinter to format and print log
   filter: null, // Use the default LogFilter (-> only log in debug mode)
+  output: null, // Use the default LogOutput (-> send everything to console)
 );
 ```
 
@@ -74,41 +75,66 @@ var logger = Logger(
     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
+    colors: true, // Colorful log messages
     printEmojis: true, // Print an emoji for each log message
+    printTime: false // Should each log print contain a timestamp
   ),
 )
 ```
 
+
+## LogFilter
+
+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
+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)
+
+
 ## LogPrinter
 
 You can implement your own `LogPrinter`. This gives you maximum flexibility. A very basic printer could look like this:
 
-```
+```dart
 class MyPrinter extends LogPrinter {
   @override
   void log(Level level, dynamic message, dynamic error, StackTrace stackTrace) {
-    print(message);
+    println(message);
   }
 }
 ```
 
+**Important:** Every implementation has to send its output using the `println()` method.
+
 If you created a cool `LogPrinter` which might be helpful to others, feel free to open a pull request. :)
 
-## LogFilter
 
-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.
+## LogOutput
+
+`LogOutput` sends the log lines to the desired destination. The default implementation (`ConsoleOutput`) send every line to the system console.
 
-You can create your own `LogFilter` like this:
 ```dart
-class MyFilter extends LogFilter {
+class ConsoleOutput extends LogOutput {
   @override
-  bool shouldLog(Level level, dynamic message, [dynamic error, StackTrace stackTrace]) {
-    return true;
+  void output(Level level, List<String> lines) {
+    for (var line in lines) {
+      print(line);
+    }
   }
 }
 ```
-This will show all logs even in release mode. (**NOT** a good idea)
+
+Possible future `LogOutput`s could send to a file, firebase or to Logcat. Feel free to open pull requests.
+
 
 ## MIT License
 ```

art/screenshot.png

@@ -1,10 +1,14 @@
 import 'package:logger/logger.dart';
 
-var logger = Logger();
+var logger = Logger(
+  printer: PrettyPrinter(),
+);
 
-var loggerNoStack = Logger(printer: PrettyPrinter(methodCount: 0));
+var loggerNoStack = Logger(
+  printer: PrettyPrinter(methodCount: 0),
+);
 
-void main() {
+void main() async {
   demo();
 }
 

example/lib/main.dart

@@ -2,8 +2,9 @@
 library logger;
 
 import 'dart:convert';
-import 'package:ansicolor/ansicolor.dart';
+import 'src/ansi_color.dart';
 
-part 'src/debug_filter.dart';
-part 'src/pretty_printer.dart';
+part 'src/default/console_output.dart';
+part 'src/default/debug_filter.dart';
+part 'src/default/pretty_printer.dart';
 part 'src/logger.dart';

lib/logger.dart

@@ -0,0 +1,54 @@
+class AnsiColor {
+  /// ANSI Control Sequence Introducer, signals the terminal for new settings.
+  static const ansiEsc = '\x1B[';
+
+  /// Reset all colors and options for current SGRs to terminal defaults.
+  static const ansiDefault = "${ansiEsc}0m";
+
+  final int fg;
+  final int bg;
+  final bool color;
+
+  AnsiColor.none()
+      : fg = null,
+        bg = null,
+        color = false;
+
+  AnsiColor.fg(this.fg)
+      : bg = null,
+        color = true;
+
+  AnsiColor.bg(this.bg)
+      : fg = null,
+        color = true;
+
+  String toString() {
+    if (fg != null) {
+      return "${ansiEsc}38;5;${fg}m";
+    } else if (bg != null) {
+      return "${ansiEsc}48;5;${bg}m";
+    } else {
+      return "";
+    }
+  }
+
+  String call(String msg) {
+    if (color) {
+      return "${this}$msg$ansiDefault";
+    } else {
+      return msg;
+    }
+  }
+
+  AnsiColor toFg() => AnsiColor.fg(bg);
+
+  AnsiColor toBg() => AnsiColor.bg(fg);
+
+  /// Defaults the terminal's foreground color without altering the background.
+  String get resetForeground => color ? "${ansiEsc}39m" : "";
+
+  /// Defaults the terminal's background color without altering the foreground.
+  String get resetBackground => color ? "${ansiEsc}49m" : "";
+
+  static int grey(double level) => 232 + (level.clamp(0.0, 1.0) * 23).round();
+}

lib/src/ansi_color.dart

@@ -0,0 +1,13 @@
+part of logger;
+
+/// Default implementation of [LogOutput].
+///
+/// It sends everything to the system console.
+class ConsoleOutput extends LogOutput {
+  @override
+  void output(Level level, List<String> lines) {
+    for (var line in lines) {
+      print(line);
+    }
+  }
+}