logger 0.5.0

Small, easy to use and extensible logger which prints beautiful logs.

Logger

Small, easy to use and extensible logger which prints beautiful logs.
Inspired by logger for Android.

Show some ❤️ and star the repo to support the project

Resources:

• Documentation
• Pub Package
• GitHub Repository

Getting Started

Just create an instance of Logger and start logging:

var logger = Logger();

logger.d("Logger is working!");

Instead of a string message, you can also pass other objects like List, Map or Set.

Output

Log level

You can log with different levels:

logger.v("Verbose log");

logger.d("Debug log");

logger.i("Info log");

logger.w("Warning log");

logger.e("Error log");

logger.wtf("What a terrible failure log");

To show only specific log levels, you can set:

Logger.level = Level.warning;

This hides all verbose, debug and info log events.

Options

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)
);

If you use the PrettyPrinter, there are more options:

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
    printEmojis: true, // Print an emoji for each log message
  ),
)

LogPrinter

You can implement your own LogPrinter. This gives you maximum flexibility. A very basic printer could look like this:

class MyPrinter extends LogPrinter {
  @override
  void log(Level level, dynamic message, dynamic error, StackTrace stackTrace) {
    print(message);
  }
}

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.

You can create your own LogFilter like this:

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)

MIT License

Copyright (c) 2019 Simon Leier

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.