pino-pretty - npm Package Compare versions

Comparing version 7.5.1 to 7.5.2

index.d.ts

@@ -11,2 +11,3 @@ // Type definitions for pino-pretty 7.0
 import { OnUnknown } from 'pino-abstract-transport';
+import { DestinationStream } from 'pino';
 
@@ -111,2 +112,17 @@ type LogDescriptor = Record<string, unknown>;
   /**
+   * The file, file descriptor, or stream to write to.  Defaults to 1 (stdout).
+   * @default 1
+   */
+  destination?: string | number | DestinationStream | NodeJS.WritableStream;
+  /**
+   * Opens the file with the 'a' flag.
+   * @default true
+   */
+  append?: boolean;
+  /**
+   * Ensure directory for destination file exists.
+   * @default false
+   */
+  mkdir?: boolean;
+  /**
    * Provides the ability to add a custom prettify function for specific log properties.
@@ -113,0 +129,0 @@ * `customPrettifiers` is an object, where keys are log properties that will be prettified

package.json

 {
   "name": "pino-pretty",
-  "version": "7.5.1",
+  "version": "7.5.2",
   "description": "Prettifier for Pino log lines",
@@ -5,0 +5,0 @@ "type": "commonjs",

Readme.md

@@ -255,3 +255,3 @@ <a id="intro"></a>
   append: true, // the file is opened with the 'a' flag
-  mdkdir: true, // create the target destination
+  mkdir: true, // create the target destination
 
@@ -266,2 +266,5 @@
 
+The defaults for `sync`, `append`, `mkdir` inherit from
+[`SonicBoom(opts)`](https://github.com/pinojs/sonic-boom#API).
+
 `customPrettifiers` option provides the ability to add a custom prettify function
@@ -341,5 +344,16 @@ for specific log properties. `customPrettifiers` is an object, where keys are
 
-<a id="license"><a>
+## Limitations
+
+Because `pino-pretty` uses stdout redirection, in some cases the command may
+terminate with an error due to shell limitations.
+
+For example, currently, mingw64 based shells (e.g. Bash as supplied by [git for
+Windows](https://gitforwindows.org)) are affected and terminate the process with
+a `stdout is not a tty` error message.
+
+Any PRs are welcomed!
+
+<a id="license"></a>
 ## License
 
 MIT License

test/types/pino-pretty.test-d.ts

@@ -32,2 +32,5 @@ import { expectType } from "tsd";
   sync: false,
+  destination: 2,
+  append: true,
+  mkdir: true,
 };
@@ -56,2 +59,5 @@
   sync: false,
+  destination: 2,
+  append: true,
+  mkdir: true,
 };
@@ -58,0 +64,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

326630

increased by0.31%

Lines of code

3570

increased by0.62%

Number of lines in readme file

357

increased by4.08%

No dependency changes