@finnpauls/npm-test v1.3.0

hoodie-log

Custom log API for the browser

hi

hoodie-log is a standalone JavaScript library for logging to the browser console. If available, it takes advantage of CSS-based styling of console log outputs.

Example

var log = new Log('hoodie')

log('ohaj!')
// (hoodie) ohaj!
log.debug('This will help with debugging.')
// (hoodie:debug) This will help with debugging.
log.info('This might be of interest. Or not.')
// (hoodie:info) This might be of interest. Or not.
log.warn('Something is fishy here!')
// (hoodie:warn) Something is fishy here!
log.error('oooops')
// (hoodie:error) oooops

var fooLog = log.scoped('foo')
fooLog('baz!')
// (hoodie:foo) baz!

API

• Constructor
• log.prefix
• log.level
• log()
• log.debug()
• log.info()
• log.warn()
• log.error()
• log.scoped()

Constructor

new Log(prefix)
// or
new Log(options)

Example

var log = new Log({
  prefix: 'hoodie',
  level: 'warn',
  styles: {
    default: 'color: white; padding: .2em .4em; border-radius: 1em',
    debug: 'background: green',
    log: 'background: gray',
    info: 'background: blue',
    warn: 'background: orange',
    error: 'background: red',
    reset: 'background: inherit; color: inherit'
  }
}

log.prefix

Read-only

log.prefix

Prefix used in log messages

Example

log = new Log('hoodie')
log.prefix // hoodie
log.warn("Something is fishy here!")
// (hoodie:warn) Something is fishy here!

log.level

One of debug, info, warn or error. debug is the lowest level, and everything will be logged to the console. error is the highest level and nothing but errors will be logged.

log.level

Example

log.level = 'debug'
log.debug('This will help with debugging.')
// (hoodie:debug) This will help with debugging.
log.level = 'info'
log.debug('This will help with debugging.')
// <no log>
log.level = 'foo'
// throws InvalidValue error

log()

Logs message to browser console. Accepts same arguments as console.log

log("ohaj!")

log.debug()

Logs debug message to browser console if level is set to debug. Accepts same arguments as console.log

log.debug('This will help with debugging.')

log.info()

Logs info message to browser console if level is set to debug or info Accepts same arguments as console.log

log.info('This might be of interest. Or not.')

log.warn()

Logs warning to browser console unless level is set to error Accepts same arguments as console.log

log.warn('Something is fishy here!')

log.error()

Logs error message to browser console. Accepts same arguments as console.log

log.error('oooops')

log.scoped()

log.scoped(prefix)

Returns log API with extended prefix

Example

var log = new Log('hoodie')
log('ohaj!')
// (hoodie) ohaj!
var fooLog = log.scoped('foo')
fooLog('baz!')
// (hoodie:foo) baz!

Testing

Local setup

git clone git@github.com:hoodiehq/hoodie-log.git
cd hoodie-log
npm install

Run all tests and code style checks

npm test

Run all tests on file change

npm run test:watch

Run specific tests only

node tests/specs/debug.js # run .debug() unit tests

PROTIP™: pipe output through a pretty reporter

License

Apache-2.0