.github/dependabot.yml

@@ -2,6 +2,10 @@ version: 2
 updates:
 - package-ecosystem: github-actions
   directory: '/'
+  ignore:
+      - dependency-name: 'actions/*'
+        update-types:
+            ['version-update:semver-minor', 'version-update:semver-patch']
   schedule:
     interval: daily
   open-pull-requests-limit: 10

.github/workflows/ci.yml

@@ -12,16 +12,19 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    outputs:
+      COVERALLS: ${{ steps.coveralls-trigger.outputs.COVERALLS_TRIGGER }}
     strategy:
       matrix:
-        node-version: [10, 12, 13, 14, 16]
+        node-version: [12, 14, 16]
+        os: [ubuntu-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2
 
       - name: Use Node.js
-        uses: actions/setup-node@v2.4.0
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -38,15 +41,26 @@ jobs:
         run: npm run ci
 
       - name: Coveralls Parallel
+        id: coveralls-parallel
         uses: coverallsapp/github-action@1.1.3
+        continue-on-error: true
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel: true
           flag-name: run-${{ matrix.node-version }}-${{ matrix.os }}
 
+      - name: Should Trigger coverallsapp/github-action@master
+        id: coveralls-trigger
+        # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context
+        # when continue-on-error failed, outcome is failure and conclusion is success
+        if: steps.coveralls-parallel.conclusion == 'success' && steps.coveralls-parallel.outcome != 'success'
+        run: |
+          echo "::set-output name=COVERALLS_TRIGGER::failure"
+
   coverage:
     needs: build
     runs-on: ubuntu-latest
+    if: needs.test.outputs.COVERALLS != 'failure'
     steps:
       - name: Coveralls Finished
         uses: coverallsapp/github-action@1.1.3
@@ -58,6 +72,6 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: fastify/github-action-merge-dependabot@v2.4.0
+      - uses: fastify/github-action-merge-dependabot@v2.7.1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -2,6 +2,7 @@
 shrinkwrap.yaml
 package-lock.json
 yarn.lock
+pnpm-lock.yaml
 
 # Logs
 logs

.taprc

@@ -2,3 +2,5 @@ ts: false
 jsx: false
 flow: false
 jobs: 1
+files:
+  - 'test/**/*.test.js'

Readme.md

@@ -24,6 +24,9 @@ Will format to:
 [1522431328992] INFO (42 on foo): hello world
 ```
 
+If you landed on this page due to the deprecation of the `prettyPrint` option
+of `pino`, read the [Programmatic Integration](#integration) section.
+
 <a id="example"></a>
 ## Example
 
@@ -60,6 +63,7 @@ node app.js | pino-pretty
   feed, to the formatted log line.
 - `--errorProps` (`-e`): When formatting an error object, display this list
   of properties. The list should be a comma-separated list of properties Default: `''`.
+  Do not use this option if logging from pino@7. Support will be removed from future verions.
 - `--levelFirst` (`-l`): Display the log level name before the logged date and time.
 - `--errorLikeObjectKeys` (`-k`): Define the log keys that are associated with
   error like objects. Default: `err,error`.
@@ -69,6 +73,7 @@ node app.js | pino-pretty
   Default: `level`.
 - `--levelLabel` (`-b`): Output the log level using the specified label.
   Default: `levelLabel`.
+- `--minimumLevel` (`-L`): Hide messages below the specified log level. Accepts a number, `trace`, `debug`, `info`, `warn`, `error`, or `fatal`. If any more filtering is required, consider using [`jq`](https://stedolan.github.io/jq/).
 - `--messageFormat` (`-o`): Format output of message, e.g. `{levelLabel} - {pid} - url:{request.url}` will output message: `INFO - 1123 - url:localhost:3000/test`
   Default: `false`
 - `--timestampKey` (`-a`): Define the key that contains the log timestamp.
@@ -81,10 +86,8 @@ node app.js | pino-pretty
   - Require a `SYS:` prefix to translate time to the local system's time zone. A
     shortcut `SYS:standard` to translate time to `yyyy-mm-dd HH:MM:ss.l o` in
     system time zone.
-- `--search` (`-s`): Specify a search pattern according to
-  [jmespath](http://jmespath.org/).
-- `--ignore` (`-i`): Ignore one or several keys, nested keys are supported with each property delimited by a dot character (`.`), 
-  keys may be escaped to target property names that contains the delimiter itself: 
+- `--ignore` (`-i`): Ignore one or several keys, nested keys are supported with each property delimited by a dot character (`.`),
+  keys may be escaped to target property names that contains the delimiter itself:
   (`-i time,hostname,req.headers,log\\.domain\\.corp/foo`)
 - `--hideObject` (`-H`): Hide objects from output (but not error object)
 - `--singleLine` (`-S`): Print each log message on a single line (errors will still be multi-line)
@@ -96,45 +99,118 @@ node app.js | pino-pretty
 We recommend against using `pino-pretty` in production and highly
 recommend installing `pino-pretty` as a development dependency.
 
-When installed, `pino-pretty` will be used by `pino` as the default
-prettifier.
-
-Install `pino-pretty` alongside `pino` and set the
-`prettyPrint` option to `true`:
+Install `pino-pretty` alongside `pino` and set the transport target to `'pino-pretty'`:
 
 ```js
 const pino = require('pino')
 const logger = pino({
-  prettyPrint: true
+  transport: {
+    target: 'pino-pretty'
+  },
 })
 
 logger.info('hi')
 ```
 
-The `prettyPrint` option can also be an object containing `pretty-print`
-options:
+The transport option can also have an options object containing `pino-pretty` options:
 
 ```js
 const pino = require('pino')
 const logger = pino({
+  transport: {
+    target: 'pino-pretty',
+    options: {
+      colorize: true
+    }
+  }
+})
+
+logger.info('hi')
+```
+
+Use it as a stream:
+
+```js
+const pino = require('pino')
+const pretty = require('pino-pretty')
+const logger = pino(pretty())
+
+logger.info('hi')
+```
+
+Options are also supported:
+
+```js
+const pino = require('pino')
+const pretty = require('pino-pretty')
+const stream = pretty({
   prettyPrint: { colorize: true }
 })
+const logger = pino(stream)
 
 logger.info('hi')
 ```
 
 See the [Options](#options) section for all possible options.
 
+If you are using `pino-pretty` as a stream and you need to provide options to `pino`,
+pass the options as the first argument and `pino-pretty` as second argument:
+
+```js
+const pino = require('pino')
+const pretty = require('pino-pretty')
+const stream = pretty({
+  prettyPrint: { colorize: true }
+})
+const logger = pino({ level: 'info' }, stream)
+
+// Nothing is printed
+logger.debug('hi')
+```
+
+
+### Handling non-serializable options
+
+Using the new [pino v7+
+transports](https://getpino.io/#/docs/transports?id=v7-transports) not all
+options are serializable, for example if you want to use `messageFormat` as a
+function you will need to wrap `pino-pretty` in a custom module.
+
+Executing `main.js` below will log a colorized `hello world` message using a
+custom function `messageFormat`:
+
+```js
+// main.js
+const pino = require('pino')
+
+const logger = pino({
+  transport: {
+    target: './pino-pretty-transport',
+    options: {
+      colorize: true
+    }
+  },
+})
+
+logger.info('world')
+```
+
+```js
+// pino-pretty-transport.js
+module.exports = opts => require('pino-pretty')({
+  ...opts,
+  messageFormat: (log, messageKey) => `hello ${log[messageKey]}`
+})
+```
+
 <a id="options"></a>
 ### Options
 
-`pino-pretty` exports a factory function that can be used to format log strings.
-This factory function is used internally by Pino, and accepts an options argument
-with keys corresponding to the options described in [CLI Arguments](#cliargs):
+The options accepted have keys corresponding to the options described in [CLI Arguments](#cliargs):
 
 ```js
 {
-  colorize: chalk.supportsColor, // --colorize
+  colorize: colorette.isColorSupported, // --colorize
   crlf: false, // --crlf
   errorLikeObjectKeys: ['err', 'error'], // --errorLikeObjectKeys
   errorProps: '', // --errorProps
@@ -144,22 +220,29 @@ with keys corresponding to the options described in [CLI Arguments](#cliargs):
   messageFormat: false, // --messageFormat
   timestampKey: 'time', // --timestampKey
   translateTime: false, // --translateTime
-  search: 'foo == `bar`', // --search
   ignore: 'pid,hostname', // --ignore
   hideObject: false, // --hideObject
   singleLine: false, // --singleLine
+
+  // The file or file descriptor (1 is stdout) to write to
+  destination: 1,
+
+  // Alternatively, pass a `sonic-boom` instance (allowing more flexibility):
+  // destination: new SonicBoom({ dest: 'a/file', mkdir: true })
+
   customPrettifiers: {}
 }
 ```
 
 The `colorize` default follows
-[`chalk.supportsColor`](https://www.npmjs.com/package/chalk#chalksupportscolor).
+[`colorette.isColorSupported`](https://github.com/jorgebucaran/colorette#iscolorsupported).
 
 `customPrettifiers` option provides the ability to add a custom prettify function
 for specific log properties. `customPrettifiers` is an object, where keys are
 log properties that will be prettified and value is the prettify function itself.
 For example, if a log line contains a `query` property,
 you can specify a prettifier for it:
+
 ```js
 {
   customPrettifiers: {
@@ -172,13 +255,47 @@ const prettifyQuery = value => {
 }
 ```
 
+Additionally, `customPrettifiers` can be used to format the time and level
+outputs:
+
+```js
+{
+  customPrettifiers: {
+    // The argument for this function will be the same
+    // string that's at the start of the log-line by default:
+    time: timestamp => `🕰 ${timestamp}`,
+
+    // The argument for the level-prettifier may vary depending
+    // on if the levelKey option is used or not.
+    // By default this will be the same numerics as the Pino default:
+    level: logLevel => `LEVEL: ${logLevel}`
+  }
+}
+```
+
+Note that prettifiers do not include any coloring, if the stock coloring on
+`level` is desired, it can be accomplished using the following:
+
+```js
+const { colorizerFactory } = require('pino-pretty')
+const levelColorize = colorizerFactory(true)
+const levelPrettifier = logLevel => `LEVEL: ${levelColorize(logLevel)}`
+//...
+{
+  customPrettifiers: { level: levelPrettifier }
+}
+```
+
 `messageFormat` option allows you to customize the message output. A template `string` like this can define the format:
+
 ```js
 {
   messageFormat: '{levelLabel} - {pid} - url:{request.url}'
 }
 ```
+
 This option can also be defined as a `function` with this prototype:
+
 ```js
 {
   messageFormat: (log, messageKey, levelLabel) => {