deslack v0.0.3

deslack

Slack integration for the debug module.

why?

You are not looking at your terminal screen the whole day, in sharp contrast to your Slack client :) This module is a simple wrapper around debug, so that your debug log statements can be easily sent to a Slack channel of your choice.

install

npm isntall deslack

dependencies

• debug

• node-slack

prepare

• Create an Incoming WebHooks integration under Custom Integrations in your Slack account.

setup

var deslack = require('deslack')({
    example: {
        channel: '#example-channel',
        hookUrl: '<the hook url you have setup in Slack>',
    },
}, function isSlackEnabled() {
    return true;
});

require('deslack') returns an initialization function that takes two arguments. The first argument is hash map between debug namespaces and Slack channel data:

{
    <the debug namespace you want to send to Slack>: {
        channel: <name of the Slack channel, prepended with #>,
        hookUrl: <the hook url you have setup in Slack>
    },
    etc..
}

The second argument is a function of which its return value indicates whether Slack messages should be sent. This can be handy to evaluate a config environment value. You can of course also provide custom channels for local/staging development in the first argument if you want use Slack also for local development.

using it

var deslack = require('deslack')(...);
deslack('example')('hi', 'this', 'works', { yo: true });

After initializing deslack, it works exactly how debug works. To see debug output you need to start the node process with DEBUG enviroment, in this case DEBUG=example. If it is provided then deslack will pass your log statements onto both debug and slack.

Note: If there's no DEBUG environment provided, then no Slack message will be sent (nor, of course, will any debug statements be logged for that environment).

With regards to handling log arguments:

• in order to send a single message String to Slack, the arguments are concatenated using util.format
• debug has its own way of handling arguments