Merge pull request #237 from sandyplace/master

add forceColor option to pretty

bin.js

@@ -14,6 +14,7 @@ if (arg('-h') || arg('--help')) {
   process.stdin.pipe(pretty({
     timeTransOnly: arg('-t'),
     levelFirst: arg('-l'),
+    forceColor: arg('-c'),
     messageKey: messageKeyArg()
   })).pipe(process.stdout)
 }

docs/API.md

@@ -97,6 +97,8 @@ Returns a new [logger](#logger) instance.
   level as the first field in the log line. Default: `false`.
   * `messageKey` (string): the key in the JSON object to use as the highlighted
   message. Default: `msg`.
+  * `forceColor` (boolean): if set to `true`, will add color information to the formatted output
+  message. Default: `false`.
 
 ### Example:
 ```js

docs/cli.md

@@ -62,3 +62,15 @@ Into this:
 ```sh
 INFO [2016-03-09T15:27:09.339Z] (14139 on MacBook-Pro-3.home): hello world
 ```
+If you would like to enforce the output to be color encoded you can specify the `-c` flag
+`cat log | pino -c` will transform this:
+
+```js
+{"pid":14139,"hostname":"MacBook-Pro-3.home","level":30,"fooMessage":"hello world","time":1457537229339,"v":1}
+```
+
+Into this:
+
+```sh
+[2017-04-25T17:32:09.662Z] INFO (24280 on SP2): hello world
+```

pretty.js

@@ -57,6 +57,7 @@ function pretty (opts) {
   var formatter = opts && opts.formatter
   var levelFirst = opts && opts.levelFirst
   var messageKey = opts && opts.messageKey
+  var forceColor = opts && opts.forceColor
   messageKey = messageKey || 'msg'
 
   var stream = split(mapLine)
@@ -67,7 +68,7 @@ function pretty (opts) {
 
   stream.pipe = function (dest, opts) {
     ctx = new chalk.constructor({
-      enabled: !!(chalk.supportsColor && dest.isTTY)
+      enabled: !!((chalk.supportsColor && dest.isTTY) || forceColor)
     })
 
     levelColors = {

test/pretty.test.js

@@ -40,6 +40,17 @@ test('pino pretty moves level to start on flag', function (t) {
   instance.info('hello world')
 })
 
+test('pino pretty force color on flag', function (t) {
+  t.plan(1)
+  var prettier = pretty({ forceColor: true })
+  prettier.pipe(split(function (line) {
+    t.ok(line.match(/.*\u001b\[32mINFO\u001b\[39m.*\u001b\[36mhello world\u001b\[39m$/), 'color coding information is encoded in the line')
+    return line
+  }))
+  var instance = pino(prettier)
+
+  instance.info('hello world')
+})
 test('pino transform can just parse the dates', function (t) {
   t.plan(1)
   var prettier = pretty({ timeTransOnly: true })