leancode_logging 1.2.0

  • Readme
  • Changelog
  • Installing
  • new55

leancode_logging #

Abstract logging utilities for Dart (do not depend on Flutter).

This library is used as a wrapper around desired logging LeanCode library e.g. leancode_logging_flutter.

Using the package in app #

Define a global variable in you app to access the logger:

final bugfender = Bugfender(config.bugfenderKey, config.debugMode); // from leancode_logging_flutter
logger = bugfender;

This will allow you to use logger throughout your application easily, for example:

try {
//do something
} catch (e, s) {
logger.logException(e, s);
}

To see all available methods take a look at API reference.

Using the package in tests #

This package can be used in tests without dependency on Flutter itself. This way you can have your tests running with just Dart without Flutter.

In order to do that you need to override logger variable in test setup. When using mockito you can provide a simple mock, for example:

// define simple mock
class FakeLogger extends Mock implements Logger {}

// and then use in setup:
logger = FakeLogger();

Changelog #

[1.2.0]

  • From now, this package has no dependency on Flutter. Flutter-based utils are extracted to leancode_logging_flutter package.

[1.1.0]

  • Add ability to print logs to console

[1.0.0]

  • Use official Bugfender Swift logger from git repo

[0.0.1]

  • Initial release
  • Abstract Logger class and its implementation - Bugfender

Use this package as a library

1. Depend on it

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


dependencies:
  leancode_logging: ^1.2.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:leancode_logging/leancode_logging.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
22
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
55
Learn more about scoring.

We analyzed this package on Nov 4, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.0
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:leancode_logging/leancode_logging.dart.

Health issues and suggestions

Document public APIs. (-1 points)

19 out of 19 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

The package description is too short. (-20 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.

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 leancode_logging.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0