anylogger-diary

anylogger-diary _^0.0.1

Anylogger adapter for Diary

^_.

DONT USE NOT READY YET

..

What is this?

This is an anylogger adapter for Diary.

This package is meant for application projects that are using libraries using anylogger. By including this adapter in your project, all libraries using anylogger will automatically start to use Diary as their logging framework.

Download

• anylogger-diary.js (fully commented source ~1kB)
• anylogger-diary.min.js (minified 472 bytes, gzipped ~272 bytes)

CDN

index.html

<script src="https://unpkg.com/anylogger@1.0.3/anylogger.min.js"></script>
<script src="https://unpkg.com/diary@1.6.8/dist/diary.min.js"></script>
<script src="https://unpkg.com/anylogger-diary@1.0.0/anylogger-diary.min.js"></script>
<script>(function(){ // IIFE
  var log = anylogger('index.html')
  log.info('Logging is simple!')
  // to see logging, enable it by typing this in the console:
  // localStorage.setItem('diary:index.html', 'DEBUG')
  // then refresh the page
})()</script>

Install

Install this adapter, as well as both anylogger and Diary:

npm install --save anylogger-diary anylogger diary

Include in your application project

This package is meant for application projects. If you are writing a library to be NPM installed into some other project, most likely you should not include any adapter, but instead just use anylogger directly.

The anylogger-diary adapter will modify the anylogger factory in such a way that the loggers it creates will be logging to diary.

When using diary, all logging except for warnings and errors is supressed by default. As such, you should make sure to set the log level to INFO or DEBUG as usual before expecting to see any output.

To activate the adapter, include it in your application entry point.

Require

main.js

require('anylogger-diary')

Import

main.js

import 'anylogger-diary'

Logging in the application project

In your application module code, only use anylogger to stay framework independent:

my-module.js

import anylogger from 'anylogger'
const log = anylogger('my-module')
log('Logging is simple!')

This is helpful if you ever decide to factor out the application module into a separate library.

log configuration in the application project

Because anylogger is simply using diary below the surface, you can use all the normal configuration mechanisms available for diary.

If you need to control log settings programmatically, just import diary and use it directly:

main.js

// ...
import diary from 'diary'
diary.getLogger('my-module').setLevel(diary.levels.INFO)
// ...

Issues

Add an issue in this project's issue tracker to let me know of any problems you find, or questions you may have.

License

Licensed under the MIT Open Source license.

gzip-size

The GZIP algorithm is available in different flavours and with different possible compression settings. The sizes quoted in this README have been measured using gzip-size by Sindre Sorhus, your mileage may vary.