err_router 0.1.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 54

Err router #

A logs router that can pop messages to the device screen. Based on the err package for errors management. The messages can be routed to:

  • Terminal and on device console
  • Flash messages
  • Snackbar messages

Usage #

Initialize the logger

   import 'package:err_router/err_router.dart';

   final ErrRouter log = ErrRouter();

Create an error with the Err class and log it to console:

   final err = Err.error("Network error");
   log.console(err);

Console messages #

Screenshot

The console method prints an error and save it to history

Arguments

Accepted arguments: any object, string or an Err instance. Pass it an Exception or Error to get the stacktrace printed in the message

The Err class constructors all accept a userMessage parameter. Use it to separate the technical message for the developer from the user friendly message for the user:

   /// let's say we have an exception [e]
   final err = Err.error(e, userMessage: "Can not connect to x");
   log.scren(err, context);

The message displayed to user will be the one from userMessage

Snackbar messages #

   log.screen(err, context);

Screenshot

Flash messages #

Screenshot

   log.flash(err);

The flash messages are toast messages. They stay one second on the screen

History #

To access the history:

   final List<Err> history = log.history;

On device console #

Navigate to DeviceConsolePage(log) to see the console on the device

Libraries used #

Changelog #

0.1.0 #

Initial

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:err/err.dart';
import 'package:err_router/err_router.dart';

final ErrRouter log = ErrRouter();

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        // This is the theme of your application.
        //
        // Try running your application with "flutter run". You'll see the
        // application has a blue toolbar. Then, without quitting the app, try
        // changing the primarySwatch below to Colors.green and then invoke
        // "hot reload" (press "r" in the console where you ran "flutter run",
        // or simply save your changes to "hot reload" in a Flutter IDE).
        // Notice that the counter didn't reset back to zero; the application
        // is not restarted.
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key key, this.title}) : super(key: key);

  // This widget is the home page of your application. It is stateful, meaning
  // that it has a State object (defined below) that contains fields that affect
  // how it looks.

  // This class is the configuration for the state. It holds the values (in this
  // case the title) provided by the parent (in this case the App widget) and
  // used by the build method of the State. Fields in a Widget subclass are
  // always marked "final".

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    log.flash("Incrementing counter");
    setState(() {
      // This call to setState tells the Flutter framework that something has
      // changed in this State, which causes it to rerun the build method below
      // so that the display can reflect the updated values. If we changed
      // _counter without calling setState(), then the build method would not be
      // called again, and so nothing would appear to happen.
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    log.console(Err.debug("Build"));
    // This method is rerun every time setState is called, for instance as done
    // by the _incrementCounter method above.
    //
    // The Flutter framework has been optimized to make rerunning build methods
    // fast, so that you can just rebuild anything that needs updating rather
    // than having to individually change instances of widgets.
    return Scaffold(
      appBar: AppBar(
        // Here we take the value from the MyHomePage object that was created by
        // the App.build method, and use it to set our appbar title.
        title: Text(widget.title),
      ),
      body: Center(
        // Center is a layout widget. It takes a single child and positions it
        // in the middle of the parent.
        child: Column(
          // Column is also a layout widget. It takes a list of children and
          // arranges them vertically. By default, it sizes itself to fit its
          // children horizontally, and tries to be as tall as its parent.
          //
          // Invoke "debug painting" (press "p" in the console, choose the
          // "Toggle Debug Paint" action from the Flutter Inspector in Android
          // Studio, or the "Toggle Debug Paint" command in Visual Studio Code)
          // to see the wireframe for each widget.
          //
          // Column has various properties to control how it sizes itself and
          // how it positions its children. Here we use mainAxisAlignment to
          // center the children vertically; the main axis here is the vertical
          // axis because Columns are vertical (the cross axis would be
          // horizontal).
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
            Padding(
                padding: const EdgeInsets.all(15.0),
                child: FlatButton(
                    onPressed: () => log.screen("A message", context),
                    child: const Text("Message"))),
            Padding(
                padding: const EdgeInsets.all(15.0),
                child: FlatButton(
                    onPressed: () =>
                        log.screen(Err.error("Some problem occured"), context),
                    child: const Text("Error"))),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ), // This trailing comma makes auto-formatting nicer for build methods.
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  err_router: ^0.1.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support 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:err_router/err_router.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
13
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
54
Learn more about scoring.

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

  • Dart: 2.8.4
  • pana: 0.13.14
  • Flutter: 1.17.5

Analysis suggestions

Package does not support Flutter platform linux

Because:

  • package:err_router/err_router.dart that imports:
  • package:err_router/src/router.dart that imports:
  • package:fluttertoast/fluttertoast.dart that declares support for platforms: android, ios

Package does not support Flutter platform macos

Because:

  • package:err_router/err_router.dart that imports:
  • package:err_router/src/router.dart that imports:
  • package:fluttertoast/fluttertoast.dart that declares support for platforms: android, ios

Package does not support Flutter platform web

Because:

  • package:err_router/err_router.dart that imports:
  • package:err_router/src/router.dart that imports:
  • package:fluttertoast/fluttertoast.dart that declares support for platforms: android, ios

Package does not support Flutter platform windows

Because:

  • package:err_router/err_router.dart that imports:
  • package:err_router/src/router.dart that imports:
  • package:fluttertoast/fluttertoast.dart that declares support for platforms: android, ios

Package not compatible with SDK dart

Because:

  • err_router that is a package requiring null.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (fluttertoast).

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
cupertino_icons ^0.1.2 0.1.3
err ^0.9.0 0.9.0
extra_pedantic ^1.1.1+3 1.2.0
flushbar ^1.9.1 1.10.4
flutter 0.0.0
fluttertoast ^3.1.3 3.1.3 6.0.1
pedantic ^1.8.0 1.9.0 1.9.1
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.1
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8 2.1.0-nullsafety
Dev dependencies
flutter_test