Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[README] Programmatic Integrations options are missing some CLI options #348

Closed
rob-ryszewski opened this issue Jun 11, 2022 · 2 comments
Closed
Labels

Comments

@rob-ryszewski
Copy link

rob-ryszewski commented Jun 11, 2022

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 rob-ryszewski changed the title Programmatic Integrations options do not have parity with CLI options [README] Programmatic Integrations options are missing some CLI options Jun 11, 2022
@mcollina
Copy link
Member

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

@ademarsj
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants