Skip to content
This repository has been archived by the owner on Jul 11, 2024. It is now read-only.

clux/smell

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Smell

npm status build status dependency status coverage status

The smelly place where logs are emitted. Subscribe and get strings from info, warn and err events. (Not using error since this bubbles up to an uncaughtError)

Basic Idea

Libraries should never rely on full logging libraries - how to log is an app decision. Thus, libraries can add this ..emission, expose it, and hope someone else deals with it.

Usage

Create an instance, emit logs to it then expose it from your library somehow:

// in some-module
var log = require('smell')();
log.info('some module is doing work');
log.warn('this ok?')
log.error('this is not ok:', failObject);

exports.log = log;

// in app.js
var em = require('some-module');
em.on('info', console.log);
em.on('warn', console.warn);
em.on('err', console.error);

License

MIT-Licensed. See LICENSE file for details.