From 1726618447f01ed90276d92d2ae196c252770e01 Mon Sep 17 00:00:00 2001 From: Matteo Collina Date: Mon, 1 Nov 2021 08:16:22 +0100 Subject: [PATCH] Improve docs and deprecation about prettyPrint (#1203) --- docs/api.md | 3 ++- examples/basic.js | 7 +++++++ lib/deprecations.js | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index 94831a1c0..34ae49fb5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -358,7 +358,8 @@ and searching for logged objects can start from a consistent path. Default: `false` -__DEPRECATED: use [`transport`](#transport) instead.__ +__DEPRECATED: look at [pino-pretty documentation](https://github.com/pinojs/pino-pretty) +for alternatives__. Using a [`transport`](#transport) is also an option.__ Enables pretty printing log logs. This is intended for non-production configurations. This may be set to a configuration object as outlined in the diff --git a/examples/basic.js b/examples/basic.js index 246ce7f86..bab079a93 100644 --- a/examples/basic.js +++ b/examples/basic.js @@ -1,7 +1,14 @@ 'use strict' +// Pino's primary usage writes ndjson to `stdout`: const pino = require('..')() +// However, if "human readable" output is desired, +// `pino-pretty` can be provided as the destination +// stream by uncommenting the following line in place +// of the previous declaration: +// const pino = require('..')(require('pino-pretty')()) + pino.info('hello world') pino.error('this is at error level') pino.info('the answer is %d', 42) diff --git a/lib/deprecations.js b/lib/deprecations.js index 13ffe6d0d..a6f4d7873 100644 --- a/lib/deprecations.js +++ b/lib/deprecations.js @@ -5,4 +5,4 @@ module.exports = warning const warnName = 'PinoWarning' -warning.create(warnName, 'PINODEP008', 'prettyPrint is deprecated, use the pino-pretty transport instead') +warning.create(warnName, 'PINODEP008', 'prettyPrint is deprecated, look at https://github.com/pinojs/pino-pretty for alternatives.')