pino-pretty icon indicating copy to clipboard operation
pino-pretty copied to clipboard

[README] Programmatic Integrations options are missing some CLI options

Open rob-ryszewski opened this issue 2 years ago • 1 comments

Getting all the CLI options and API options from the README:

# omitting options that are truly API specific 
# ie: sync, mkdir, append, destination
$ cat README.md | 
    grep -A1 -B27 -e 'customPrettifiers: {}' | 
    cut -d: -f1 | 
    grep -v -e // -e '[{}]' -e '^ *$' | 
    cut -d' ' -f3 | 
    grep -v -e '^sync$' -e '^mkdir$' -e '^append$' -e '^destination$' | 
    sort > api.args

$ cat README.md | 
    grep -e '`-\-' |
    cut -d'`' -f2 | 
    cut -d'-' -f3 | 
    sort > cli.args 

$ git diff --no-index cli.args api.args                                                                                                                                                                          
diff --git a/cli.args b/api.args
index eb025bc..53c3bbe 100644
--- a/cli.args
+++ b/api.args
@@ -1,19 +1,14 @@
 colorize
-config
 crlf
-customColors
-customLevels
+customPrettifiers
 errorLikeObjectKeys
 errorProps
 hideObject
 ignore
 levelFirst
 levelKey
-levelLabel
 messageFormat
 messageKey
-minimumLevel
 singleLine
 timestampKey
 translateTime
-useOnlyCustomProps

In short, the following options are missing from the Programatic Integration section of the README:

  • config
  • customColors
  • customLevels
  • levelLabel
  • minimumLevel
  • useOnlyCustomProps

Just a heads up, fairly minor issue.

rob-ryszewski avatar Jun 11 '22 06:06 rob-ryszewski

Would you like to send a Pull Request to address this issue?

mcollina avatar Jun 11 '22 09:06 mcollina

Isn't that closed by the PR #381 ? It's already merged on Oct 9, 2022.

ademarsj avatar Feb 17 '23 13:02 ademarsj