Merge pull request #63 from magillus/develop

DART::IO dependency deprecation on `fimber` package

Author: magillus

fimber/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.3.3] - Deprecating dart:io dependency
+
+- Removing FileLogging and moving it to separate package: `fimber_io`
+- 0.4.0 version will remove dependency on dart::io - so that Fimber can be used in Web projects.
+
 ## [0.3.2] - Bug fix for Time rolling tree.
 
 - [\#52 issue](https://github.com/magillus/flutter-fimber/issues/52)  Fix for check of new file format based on timeSpan intervals.

fimber/README.md

@@ -125,6 +125,8 @@ Due to nature of auto-tag generation from stacktrace this block only does it onc
     });
 ```
 
+## **Deprecated** moved to `fimber_io` package
+
 ### Custom line formatters 
 
 Use custom line formatters to define your logging format.

fimber/lib/file_log.dart

@@ -1,6 +1,6 @@
 import 'dart:async';
 import 'dart:core';
-import 'dart:io';
+import 'dart:io'; // todo deprecate
 
 import 'package:fimber/colorize.dart';
 import 'package:fimber/filename_format.dart';
@@ -10,6 +10,7 @@ import 'package:fimber/fimber.dart';
 /// This tree if planted will post short formatted (elapsed time and message)
 /// output into file specified in constructor.
 /// Note: Mostly for testing right now
+@Deprecated("Use `fimber_io` package to get benefits of dart:io with Fimber.")
 class FimberFileTree extends CustomFormatTree with CloseableTree {
   /// Output current log file name.
   String outputFileName;
@@ -39,14 +40,14 @@ class FimberFileTree extends CustomFormatTree with CloseableTree {
     _maxBufferSize = maxBufferSize;
     _bufferWriteInterval =
         Stream.periodic(Duration(milliseconds: bufferWriteInterval), (i) {
-      // group calls
-      var dumpBuffer = _logBuffer;
-      _logBuffer = [];
-      _bufferSize = 0;
-      return dumpBuffer;
-    }).listen((newLines) async {
-      _flushBuffer(newLines);
-    });
+          // group calls
+          var dumpBuffer = _logBuffer;
+          _logBuffer = [];
+          _bufferSize = 0;
+          return dumpBuffer;
+        }).listen((newLines) async {
+          _flushBuffer(newLines);
+        });
   }
 
   void _checkSizeForFlush() {
@@ -113,6 +114,7 @@ class FimberFileTree extends CustomFormatTree with CloseableTree {
 /// SizeRolling file tree.
 /// It will create new log file with an index every time current
 /// one reach [maxDataSize]
+@Deprecated("Use `fimber_io` package to get benefits of dart:io with Fimber.")
 class SizeRollingFileTree extends RollingFileTree {
   /// Maximum size allowed for the log file before rolls to new.
   DataSize maxDataSize;
@@ -131,9 +133,9 @@ class SizeRollingFileTree extends RollingFileTree {
   /// will create new log file.
   SizeRollingFileTree(this.maxDataSize,
       {logFormat = CustomFormatTree.defaultFormat,
-      this.filenamePrefix = "log_",
-      this.filenamePostfix = ".txt",
-      logLevels = CustomFormatTree.defaultLevels})
+        this.filenamePrefix = "log_",
+        this.filenamePostfix = ".txt",
+        logLevels = CustomFormatTree.defaultLevels})
       : super(logFormat: logFormat, logLevels: logLevels) {
     detectFileIndex();
   }
@@ -236,6 +238,7 @@ class SizeRollingFileTree extends RollingFileTree {
 
 /// Time base rolling file tree.
 /// It will use time span to roll logging to next file.
+@Deprecated("Use `fimber_io` package to get benefits of dart:io with Fimber.")
 class TimedRollingFileTree extends RollingFileTree {
   /// Number of seconds in an hour
   static const int hourlyTime = 60 * 60;