log-factory

log-factory

A little log library that makes it simple to add winston loggers to your module.

import {buildLogger} from 'log-factory';
let logger = buildLogger();

The logger category is named after the module that called buildLogger. So if your file was called utils/index.js the logger category will be [utils].

Configuration

By default logging targets the console with a level of info. You can change this by calling init.

  import {init} from 'log-factory';

  /**
   * Will only affect loggers created after the call to init.
   * It is advisable to call this at the start of your app 
   * before any log instances have been created.
   */
   init({
     console: false,
     file: 'my-log.log',
     log: 'INFO'
   });

The options for init are:

• console - true/false, default: true
• file - direct logs to a file, default: undefined
• log - string|json-string|path-to-json-file, default: 'info'
  • string - error|warn|info|debug|verbose|silly
  • json-string - a string that can be parsed as json
  • path-to-json - a path to a json file

If you want to disable logging you can pass in: {console: false, file: undefined}

If using json you can define levels for different categories. For example:

{
  "app": "info",
  "item" : "debug"
}

default is a special category that will be applied if the category can't be found.

To see the available categories, first run the log with level silly, the name in the square brackets is the category.

test

npm test

build

npm run main

TODO

add release-helper to the build (will need to be updated to work with gulp 4.0).