diff --git a/packages/pretty_logging/.gitignore b/packages/pretty_logging/.gitignore new file mode 100644 index 00000000..7bf00e82 --- /dev/null +++ b/packages/pretty_logging/.gitignore @@ -0,0 +1,13 @@ +# See https://www.dartlang.org/guides/libraries/private-files + +# Files and directories created by pub +.dart_tool/ +.packages +.pub/ +build/ +# If you're building an application, you may want to check-in your pubspec.lock +pubspec.lock + +# Directory created by dartdoc +# If you don't generate documentation locally you can remove this line. +doc/api/ diff --git a/packages/pretty_logging/CHANGELOG.md b/packages/pretty_logging/CHANGELOG.md new file mode 100644 index 00000000..7906ae6c --- /dev/null +++ b/packages/pretty_logging/CHANGELOG.md @@ -0,0 +1,2 @@ +# 1.0.0 +* Initial release. diff --git a/packages/pretty_logging/LICENSE b/packages/pretty_logging/LICENSE new file mode 100644 index 00000000..0a041280 --- /dev/null +++ b/packages/pretty_logging/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/packages/pretty_logging/README.md b/packages/pretty_logging/README.md new file mode 100644 index 00000000..2bbd9fac --- /dev/null +++ b/packages/pretty_logging/README.md @@ -0,0 +1,34 @@ +# pretty\_logging +[![Pub](https://img.shields.io/pub/v/pretty_logging.svg)](https://pub.dartlang.org/packages/pretty_logging) + +Standalone helper for colorful logging output, using pkg:io AnsiCode. + +# Installation +In your `pubspec.yaml`: + +```yaml +dependencies: + pretty_logging: 1.0.0 +``` + +# Usage +Basic usage is very simple: + +```dart +myLogger.onRecord.listen(prettyLog); +``` + +However, you can conditionally pass logic to omit printing an +error, provide colors, or to provide a custom print function: + +```dart +var pretty = prettyLog( + logColorChooser: (_) => red, + printFunction: stderr.writeln, + omitError: (r) { + var err = r.error; + return err is AngelHttpException && err.statusCode != 500; + }, +); +myLogger.onRecord.listen(pretty); +``` diff --git a/packages/pretty_logging/analysis_options.yaml b/packages/pretty_logging/analysis_options.yaml new file mode 100644 index 00000000..a4f33350 --- /dev/null +++ b/packages/pretty_logging/analysis_options.yaml @@ -0,0 +1,4 @@ +include: package:pedantic/analysis_options.yaml +analyzer: + strong-mode: + implicit-casts: false diff --git a/packages/pretty_logging/example/main.dart b/packages/pretty_logging/example/main.dart new file mode 100644 index 00000000..a7521393 --- /dev/null +++ b/packages/pretty_logging/example/main.dart @@ -0,0 +1,11 @@ +import 'package:logging/logging.dart'; +import 'package:pretty_logging/pretty_logging.dart'; + +void main() { + Logger.root + ..level = Level.ALL + ..onRecord.listen(prettyLog) + ..info('Hey!') + ..finest('Bye!') + ..severe('Oops!', StateError('Wrong!'), StackTrace.current); +} diff --git a/packages/pretty_logging/lib/pretty_logging.dart b/packages/pretty_logging/lib/pretty_logging.dart new file mode 100644 index 00000000..30917c6b --- /dev/null +++ b/packages/pretty_logging/lib/pretty_logging.dart @@ -0,0 +1,50 @@ +import 'package:logging/logging.dart'; +import 'package:io/ansi.dart'; + +/// Prints the contents of a [LogRecord] with pretty colors. +/// +/// By passing [omitError], you can omit printing the error of a given +/// [LogRecord]. +/// +/// You can also pass a custom [printFunction] or [logColorChooser]. +void prettyLog(LogRecord record, + {bool Function(LogRecord) omitError, + void Function(String) printFunction, + AnsiCode Function(Level) logColorChooser}) { + logColorChooser ??= chooseLogColor; + omitError ??= (_) => false; + printFunction ??= print; + + var code = logColorChooser(record.level); + if (record.error == null) printFunction(code.wrap(record.toString())); + + if (record.error != null) { + var err = record.error; + if (omitError(record)) return; + printFunction(code.wrap(record.toString() + '\n')); + printFunction(code.wrap(err.toString())); + + if (record.stackTrace != null) { + printFunction(code.wrap(record.stackTrace.toString())); + } + } +} + +/// Chooses a color based on the logger [level]. +AnsiCode chooseLogColor(Level level) { + if (level == Level.SHOUT) { + return backgroundRed; + } else if (level == Level.SEVERE) { + return red; + } else if (level == Level.WARNING) { + return yellow; + } else if (level == Level.INFO) { + return cyan; + } else if (level == Level.CONFIG || + level == Level.FINE || + level == Level.FINER || + level == Level.FINEST) { + return lightGray; + } + return resetAll; +} diff --git a/packages/pretty_logging/pubspec.yaml b/packages/pretty_logging/pubspec.yaml new file mode 100644 index 00000000..f1e360ac --- /dev/null +++ b/packages/pretty_logging/pubspec.yaml @@ -0,0 +1,12 @@ +name: pretty_logging +version: 1.0.0 +description: Standalone helper for colorful logging output, using pkg:io AnsiCode. +author: Tobe Osakwe +homepage: https://github.com/angel-dart/pretty_logging +environment: + sdk: ">=2.0.0 <3.0.0" +dependencies: + io: ^0.3.2 + logging: ^0.11.0 +dev_dependencies: + pedantic: ^1.0.0