grunt-legacy-event-logger

Event logger for Grunt legacy libs.

Heads up!

This is not ready for use yet! We'll update the readme when it's ready to go, feel free to star the project if you want updates in the meantime!

Install

Install with npm

$ npm i grunt-legacy-event-logger --save

Usage

var EventLogger = require('grunt-legacy-event-logger');

API

EventLogger

Create an instance of EventLogger

.base

Factory for creating logger emitters.

Params

• name {String}: the name of the log event to emit. Example: info
• message {String}: Message intended to be logged to the console.
• returns {Object} EventLogger: for chaining

Example

logger.base('info', 'This is an info message');

// the above is equivalent to:
logger.create('info');
logger.info('This is an info message')

.create

Create a logger method to emit an event with the given name.

Params

• name {String}: the name of the log event to emit
• returns {Object} EventLogger: for chaining

Example

logger.create('info');
logger.on('info', function(msg) {
  //=> 'this is an info event!'
});

// usage
logger.info('this is an info event!');

.modes

Add arbitrary modes to be used for creating namespaces for logger methods.

Params

• modes {Array|String}: Mode or array of modes to add to the logger.
• returns {Object} EventLogger: for chaining

Example

logger.modes(['verbose', 'notverbose']);
logger.create('info');

// usage
logger.verbose.info('emit an info logger event while in "verbose" mode');
logger.notverbose.info('emit an info logger event while in "notverbose" mode');

.operator

Add an operator that will invoke the provided getter method.

Params

• ops {String}: List of operations to add to the logger.
• getter {Function}: Getter method to invoke when the operator property is accessed.
• returns {Object} EventLogger: for chaining

Example

logger.operator('or', function () {
  if (this.mode === 'verbose') return this.notverbose;
  if (this.mode === 'notverbose') return this.verbose;
  return this.always;
});

// usage
logger.verbose.write('verbose').or.write('notverbose');

Related projects

• grunt: The JavaScript Task Runner
• grunt-cli: The grunt command line interface.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Release history

DATE VERSION CHANGES

• 2015-05-26 v0.1.0 First commit

License

Copyright © 2015 The Grunt Team Released under the MIT license.

This file was generated by verb-cli on June 04, 2015.