Define a custom winston logger

Author: ekmartin

lib/bot.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import irc from 'irc-upd';
-import logger from 'winston';
 import discord from 'discord.js';
+import logger from './logger';
 import { ConfigurationError } from './errors';
 import { validateChannelMapping } from './validators';
 import { formatFromDiscordToIRC, formatFromIRCToDiscord } from './formatting';

lib/index.js

@@ -1,13 +1,7 @@
 #!/usr/bin/env node
 
-import logger from 'winston';
 import { createBots } from './helpers';
 
-/* istanbul ignore next */
-if (process.env.NODE_ENV === 'development') {
-  logger.level = 'debug';
-}
-
 /* istanbul ignore next */
 if (!module.parent) {
   require('./cli').default();

lib/logger.js

@@ -0,0 +1,28 @@
+import winston, { format } from 'winston';
+
+function formatter(info) {
+  const stringifiedRest = JSON.stringify(Object.assign({}, info, {
+    level: undefined,
+    message: undefined,
+    splat: undefined
+  }));
+
+  const padding = (info.padding && info.padding[info.level]) || '';
+  if (stringifiedRest !== '{}') {
+    return `${info.timestamp} ${info.level}:${padding} ${info.message} ${stringifiedRest}`;
+  }
+
+  return `${info.timestamp} ${info.level}:${padding} ${info.message}`;
+}
+
+const logger = winston.createLogger({
+  transports: [new winston.transports.Console()],
+  level: process.env.NODE_ENV === 'development' ? 'debug' : 'info',
+  format: format.combine(
+    format.colorize(),
+    format.timestamp(),
+    format.printf(formatter)
+  )
+});
+
+export default logger;

test/bot-events.test.js

@@ -4,8 +4,8 @@ import sinonChai from 'sinon-chai';
 import sinon from 'sinon';
 import irc from 'irc-upd';
 import discord from 'discord.js';
-import logger from 'winston';
 import Bot from '../lib/bot';
+import logger from '../lib/logger';
 import createDiscordStub from './stubs/discord-stub';
 import ClientStub from './stubs/irc-client-stub';
 import config from './fixtures/single-test-config.json';

test/bot.test.js

@@ -3,8 +3,8 @@ import chai from 'chai';
 import sinon from 'sinon';
 import sinonChai from 'sinon-chai';
 import irc from 'irc-upd';
-import logger from 'winston';
 import discord from 'discord.js';
+import logger from '../lib/logger';
 import Bot from '../lib/bot';
 import createDiscordStub from './stubs/discord-stub';
 import ClientStub from './stubs/irc-client-stub';