.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/bench.yml

@@ -1,6 +1,8 @@
 name: Benchmarks
 on:
   push:
+    branches:
+      - main
     paths-ignore:
         - 'docs/**'
         - '*.md'
@@ -15,19 +17,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v2.3.5
+        uses: actions/checkout@v2
         with:
           ref: ${{ github.base_ref }}
       - name: Setup Node
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v2
         with:
           node-version: 12
       - name: Install Modules
         run: npm i
       - name: Run Benchmark
         run: npm run bench | tee current.txt
       - name: Upload Current Results
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v2
         with:
           name: current
           path: current.txt
@@ -37,17 +39,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v2.3.5
+        uses: actions/checkout@v2
       - name: Setup Node
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v2
         with:
           node-version: 12
       - name: Install Modules
         run: npm i
       - name: Run Benchmark
         run: npm run bench | tee branch.txt
       - name: Upload Branch Results
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v2
         with:
           name: branch
           path: branch.txt

.github/workflows/ci.yml

@@ -1,6 +1,8 @@
 name: CI
 on:
   push:
+    branches:
+      - main
     paths-ignore:
         - 'docs/**'
         - '*.md'
@@ -16,11 +18,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [macOS-latest, windows-latest, ubuntu-latest]
-        node-version: [12, 14, 16]
+        node-version: [12, 14, 16, 17]
     steps:
-      - uses: actions/checkout@v2.3.5
+      - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install

.github/workflows/package-manager-ci.yml

@@ -14,9 +14,9 @@ jobs:
         os: [windows-latest, ubuntu-latest]
         node-version: [14]
     steps:
-      - uses: actions/checkout@v2.3.5
+      - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - name: Use pnpm
@@ -37,9 +37,9 @@ jobs:
         os: [windows-latest, ubuntu-latest]
         node-version: [14]
     steps:
-      - uses: actions/checkout@v2.3.5
+      - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - name: Use yarn
@@ -64,9 +64,9 @@ jobs:
         os: [windows-latest, ubuntu-latest]
         node-version: [14]
     steps:
-      - uses: actions/checkout@v2.3.5
+      - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - name: Use yarn

docs/transports.md

@@ -240,6 +240,28 @@ const transport = pino.transport({
 pino(transport)
 ```
 
+By default, the `pino/file` transport assumes the directory of the destination file exists. If it does not exist, the transport will throw an error when it attempts to open the file for writing. The `mkdir` option may be set to `true` to configure the transport to create the directory, if it does not exist, before opening the file for writing.
+
+```js
+const pino = require('pino')
+const transport = pino.transport({
+  target: 'pino/file',
+  options: { destination: '/path/to/file', mkdir: true }
+})
+pino(transport)
+```
+
+By default, the `pino/file` transport appends to the destination file if it exists. The `append` option may be set to `false` to configure the transport to truncate the file upon opening it for writing.
+
+```js
+const pino = require('pino')
+const transport = pino.transport({
+  target: 'pino/file',
+  options: { destination: '/path/to/file', append: false }
+})
+pino(transport)
+```
+
 The `options.destination` property may also be a number to represent a file descriptor. Typically this would be `1` to write to STDOUT or `2` to write to STDERR. If `options.destination` is not set, it defaults to `1` which means logs will be written to STDOUT.
 
 The difference between using the `pino/file` transport builtin and using `pino.destination` is that `pino.destination` runs in the main thread, whereas `pino/file` sets up `pino.destination` in a worker thread.

file.js

@@ -4,7 +4,10 @@ const pino = require('./pino')
 const { once } = require('events')
 
 module.exports = async function (opts = {}) {
-  const destination = pino.destination({ dest: opts.destination || 1, sync: false })
+  const destOpts = { dest: opts.destination || 1, sync: false }
+  if (opts.append === false) destOpts.append = false
+  if (opts.mkdir) destOpts.mkdir = true
+  const destination = pino.destination(destOpts)
   await once(destination, 'ready')
   return destination
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pino",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "description": "super fast, all natural json logger",
   "main": "pino.js",
   "type": "commonjs",

test/helper.js

@@ -3,7 +3,7 @@
 const os = require('os')
 const writer = require('flush-write-stream')
 const split = require('split2')
-const { existsSync, statSync } = require('fs')
+const { existsSync, readFileSync, statSync } = require('fs')
 const pid = process.pid
 const hostname = os.hostname()
 
@@ -59,18 +59,42 @@ function watchFileCreated (filename) {
     const threshold = TIMEOUT / INTERVAL
     let counter = 0
     const interval = setInterval(() => {
+      const exists = existsSync(filename)
       // On some CI runs file is created but not filled
-      if (existsSync(filename) && statSync(filename).size !== 0) {
+      if (exists && statSync(filename).size !== 0) {
         clearInterval(interval)
         resolve()
       } else if (counter <= threshold) {
         counter++
       } else {
         clearInterval(interval)
-        reject(new Error(`${filename} was not created.`))
+        reject(new Error(
+          `${filename} hasn't been created within ${TIMEOUT} ms. ` +
+          (exists ? 'File exist, but still empty.' : 'File not yet created.')
+        ))
       }
     }, INTERVAL)
   })
 }
 
-module.exports = { getPathToNull, sink, check, once, sleep, watchFileCreated, isWin, isYarnPnp }
+function watchForWrite (filename, testString) {
+  return new Promise((resolve, reject) => {
+    const TIMEOUT = 2000
+    const INTERVAL = 100
+    const threshold = TIMEOUT / INTERVAL
+    let counter = 0
+    const interval = setInterval(() => {
+      if (readFileSync(filename).includes(testString)) {
+        clearInterval(interval)
+        resolve()
+      } else if (counter <= threshold) {
+        counter++
+      } else {
+        clearInterval(interval)
+        reject(new Error(`'${testString}' hasn't been written to ${filename} within ${TIMEOUT} ms.`))
+      }
+    }, INTERVAL)
+  })
+}
+
+module.exports = { getPathToNull, sink, check, once, sleep, watchFileCreated, watchForWrite, isWin, isYarnPnp }

test/transport/core.test.js

@@ -3,8 +3,8 @@
 const os = require('os')
 const { join } = require('path')
 const { once } = require('events')
-const { readFile } = require('fs').promises
-const { watchFileCreated } = require('../helper')
+const { readFile, writeFile } = require('fs').promises
+const { watchFileCreated, watchForWrite } = require('../helper')
 const { test } = require('tap')
 const pino = require('../../')
 const url = require('url')
@@ -279,6 +279,51 @@ test('pino.transport with target pino/file', async ({ same, teardown }) => {
   })
 })
 
+test('pino.transport with target pino/file and mkdir option', async ({ same, teardown }) => {
+  const folder = '_' + Math.random().toString(36).substr(2, 9)
+  const destination = join(os.tmpdir(), folder, folder)
+  const transport = pino.transport({
+    target: 'pino/file',
+    options: { destination, mkdir: true }
+  })
+  teardown(transport.end.bind(transport))
+  const instance = pino(transport)
+  instance.info('hello')
+  await watchFileCreated(destination)
+  const result = JSON.parse(await readFile(destination))
+  delete result.time
+  same(result, {
+    pid,
+    hostname,
+    level: 30,
+    msg: 'hello'
+  })
+})
+
+test('pino.transport with target pino/file and append option', async ({ same, teardown }) => {
+  const destination = join(
+    os.tmpdir(),
+    '_' + Math.random().toString(36).substr(2, 9)
+  )
+  await writeFile(destination, JSON.stringify({ pid, hostname, time: Date.now(), level: 30, msg: 'hello' }))
+  const transport = pino.transport({
+    target: 'pino/file',
+    options: { destination, append: false }
+  })
+  teardown(transport.end.bind(transport))
+  const instance = pino(transport)
+  instance.info('goodbye')
+  await watchForWrite(destination, '"goodbye"')
+  const result = JSON.parse(await readFile(destination))
+  delete result.time
+  same(result, {
+    pid,
+    hostname,
+    level: 30,
+    msg: 'goodbye'
+  })
+})
+
 test('pino.transport with target pino-pretty', async ({ match, teardown }) => {
   const destination = join(
     os.tmpdir(),