A good looking winston format for log messages

INFO.md

Preview

Usage

const logger = createLogger({
 	level:      'info',
 	transports: new transports.Console(),
 	format:     customFormat(),
});

winston-custom-format.ts

import stringify from 'safe-stable-stringify';
import { inspect } from 'util';
import { format } from 'winston';

const customFormat = () => {
	const colorizer = format.colorize();

	colorizer.addColors({
		level_error:   'inverse red',
		level_warn:    'inverse yellow',
		level_info:    'inverse green',
		level_http:    'inverse green',
		level_verbose: 'inverse cyan',
		level_debug:   'inverse blue',
		level_silly:   'inverse magenta',

		msg_error:   'red',
		msg_warn:    'yellow',
		msg_info:    'green',
		msg_http:    'green',
		msg_verbose: 'cyan',
		msg_debug:   'blue',
		msg_silly:   'magenta',

		timestamp: 'inverse',
	});

	return format.combine(
		format.splat(),
		format.timestamp(),
		format.printf(({ timestamp, level, message, ...rest }) => {
			const formattedSpace = colorizer.colorize(`level_${level}`, ' ');
			const formattedTimestamp = colorizer.colorize('timestamp', ` ${timestamp} `);
			const formattedLevel = colorizer.colorize(`level_${level}`, ` ${level.toUpperCase().padEnd(7, ' ')} | `);

			let formattedMessage = '';
			if (typeof message === 'string') {
				formattedMessage = colorizer.colorize(`msg_${level}`, ' ' + message);
			} else {
				formattedMessage = ' ' + inspect(message, false, null, true);
			}

			const restStr = stringify(rest);
			if (restStr !== '{}') formattedMessage += '\t' + restStr;

			return formattedSpace + formattedTimestamp + formattedLevel + formattedMessage;
		}),
	);
};