lumberdash 1.0.3

lumberdash #

CircleCI codecov Pub

lumberdash icon

Do you need logs? Lumberdash is the answer! With a simple but powerful API, Lumberdash is the easiest way to record logs. And if that is not enough, you can extend its API and create your own custom plugins for your own logging needs.

How it works #

Simply putLumberdashToWork with your preferred LumberdashClient, and start logging!

import 'package:lumberdash/lumberdash.dart';

void main() {
  putLumberdashToWork(withClient: SimpleClient());
  logWarning('Hello Warning');
  logFatal('Hello Fatal!');
  logMessage('Hello Message!');
  logError(Exception('Hello Error'));
}

However, you can get the best of Lumberdash by using plugins! For example, by using the colorize_lumberdash, you could print logs in stdout with colors:

import 'package:lumberdash/lumberdash.dart';
import 'package:colorize_lumberdash/colorize_lumberdash_client.dart';

void main() {
  putLumberdashToWork(withClient: ColorizeLumberdash());
  logWarning('Hello Warning');
  logFatal('Hello Fatal!');
  logMessage('Hello Message!');
  logError(Exception('Hello Error'));
}

You can get this output:

colorized

Existing plugins #

How to create a Lumberdash plugin #

Add lumberdash to your dependencies, and extend the LumberdashClient. That easy!

You can see the SimpleClient in this package as inspiration.

Maintainers #

Project Lead(s):

  • Felix Angelov (@felangel)

Main Maintainer(s):

  • Jorge Coca (@jorgecoca)

License #

MIT License

Copyright (c) 2019 BMW Technology Corporation

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.

v1.0.3 #

  • Transfer ownership to bmw-tech
  • Added website with documentation
  • Move builds to circle-ci

v1.0.2 #

  • Fix typos in documentation

v1.0.1 #

  • Adjusted package for better pub rating

v1.0.0 #

  • Core API

example/lib/example.dart

import 'package:lumberdash/lumberdash.dart';

void main() {
  putLumberdashToWork(withClient: SimpleClient());
  logWarning('Hello Warning');
  logFatal('Hello Fatal!');
  logMessage('Hello Message!');
  logError(Exception('Hello Error'));
}

Use this package as a library

1. Depend on it

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


dependencies:
  lumberdash: ^1.0.3

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:lumberdash/lumberdash.dart';
  
Version Uploaded Documentation Archive
1.0.3 May 9, 2019 Go to the documentation of lumberdash 1.0.3 Download lumberdash 1.0.3 archive
1.0.2 Mar 12, 2019 Go to the documentation of lumberdash 1.0.2 Download lumberdash 1.0.2 archive
1.0.1 Mar 7, 2019 Go to the documentation of lumberdash 1.0.1 Download lumberdash 1.0.1 archive
1.0.0 Mar 7, 2019 Go to the documentation of lumberdash 1.0.0 Download lumberdash 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
77
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
89
Learn more about scoring.

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

  • Dart: 2.3.2
  • pana: 0.12.19

Platforms

Detected platforms: Flutter, web, other

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

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
meta ^1.0.0 1.1.7
Dev dependencies
mockito ^4.0.0
test ^1.4.0
test_coverage ^0.2.0