redux_logging 0.4.0

  • Readme
  • Changelog
  • Installing
  • 94

redux_logging #

Build Status codecov

Connects a Logger to a Redux Store. Can also simply print the latest state / action changes.

Logs every Action that is dispatched to the Store, along with the current State.

By default, this class does not print anything to your console or send data to a web service, such as Fabric or Sentry. It simply logs entries to a Logger instance.

If you simply want to print the latest action and state to your console / terminal, create a new LoggingMiddleware.printer() and pass it to your Store upon creation.

If you want more control over where the logged data is sent, you can listen to your Logger's onRecord Stream.

Dart Versions #

  • Dart 1 support: 0.1.x
  • Dart 2 Support: 0.2.x+

Simple Printing example #

If you just want an easy way to print actions to your console / terminal as they are dispatched, use the new LoggingMiddleware.printer() factory.

Note: The LoggingMiddleware needs be the LAST middleware in the list.

import "package:redux/redux.dart";
import 'package:redux_logging/redux_logging.dart';

final store = new Store<int>(
  (int state, dynamic action) => state + 1,
  initialValue: 0,
  // Note the LoggingMiddleware should come last in the list of Middleware!
  middleware: [myOtherMiddleware, new LoggingMiddleware.printer()]

store.dispatch("Hi"); // prints {Action: "Hi", Store: 1, Timestamp: ...}

Example #

If you only want to log actions to a Logger, and choose how to handle the output, use the default constructor.

import 'package:logging/logging.dart';
import "package:redux/redux.dart";
import 'package:redux_logging/redux_logging.dart';

// Create your own Logger
final logger = new Logger("Redux Logger");

// Pass it to your Middleware
final middleware = new LoggingMiddleware(logger: logger);
final store = new Store<int>(
  (int state, dynamic action) => state + 1,
  initialState: 0,
  middleware: [middleware],

// Note: One quirk about listening to a logger instance is that you're
// actually listening to the Singleton instance of *all* loggers.
  // Filter down to [LogRecord]s sent to your logger instance
  .where((record) => record.loggerName ==
  // Print them out (or do something more interesting!)
  .listen((loggingMiddlewareRecord) => print(loggingMiddlewareRecord));

Formatting the log message #

This library includes two formatters out of the box:

  • LoggingMiddleware.singleLineFormatter
  • LoggingMiddleware.multiLineFormatter

You can optionally control the format of the message that will be logged by implementing your own MessageFormatter and passing it to the LoggingMiddleware constructor. It is a simple function that takes three parameters: the State, Action, and Timestamp.

Formatting Example #

import "package:redux/redux.dart";
import 'package:redux_logging/redux_logging.dart';

// Create a formatter that only prints out the dispatched action
String onlyLogActionFormatter<State>(
  State state,
  dynamic action,
  DateTime timestamp,
) {
  return "{Action: $action}";

// Create your middleware using the formatter.
final middleware = new LoggingMiddleware(formatter: onlyLogActionFormatter);

// Add the middleware with your formatter to your Store
final store = new Store<int>(
  (int state, dynamic action) => state + 1,
  initialState: 0,
  middleware: [middleware],

Changelog #

0.4.0 #

  • Breaking Change: Support Redux 4.x - 5.0
  • Lazy evaluation for message in logger

0.3.1 #

  • BugFix: Add docs explaining logging middleware needs to be last in chain

0.3.0 #

  • Bump to Redux 3.0.0
  • Fix Dart 2 bug

0.2.0 #

  • Dart 2 support

0.1.4 #

  • Fix formatter for printer

0.1.3 #

  • Move to Github

0.1.2 #

  • Fix examples

0.1.1 #

  • Include description in pubspec.yaml

0.1.0 #

  • Initial version, a LoggingMiddleware for Redux, which connects the dispatched actions to to a Logger.
  • Includes a printer factory, which prints all logged messages to the your console / terminal.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  redux_logging: ^0.4.0

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:redux_logging/redux_logging.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Jul 2, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.13

Health suggestions

Fix lib/redux_logging.dart. (-2.48 points)

Analysis of lib/redux_logging.dart reported 5 hints:

line 74 col 32: Unnecessary new keyword.

line 83 col 24: Unnecessary new keyword.

line 102 col 52: Unnecessary new keyword.

line 114 col 25: Unnecessary new keyword.

line 121 col 60: Unnecessary new keyword.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and redux_logging.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.

The package description is too short. (-1 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
logging >=0.11.3 <0.12.0 0.11.4
redux >=4.0.0 <5.0.0 4.0.0
Dev dependencies
test >=1.0.0 <2.0.0