TheThing/node-bunyan-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Wiki Activity

formatting

Browse source
This commit is contained in:
Trent Mick 2017-03-06 11:24:11 -08:00
parent a778ea5697
commit b66571f113
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
TODO.md
View file

@ -7,10 +7,12 @@
# changes to ctor and log.child to separate fields from config # changes to ctor and log.child to separate fields from config
Current: Current:
createLogger(<config-and-fields>) createLogger(<config-and-fields>)
log.child(<config-and-fields>, <just-fields-bool>) log.child(<config-and-fields>, <just-fields-bool>)
Could be: Could be:
createLogger(<config-and-fields>, <fields>) createLogger(<config-and-fields>, <fields>)
log.child(<config-and-fields>, <fields>) log.child(<config-and-fields>, <fields>)
# Still support: log.child(<config-and-fields>, <just-fields-bool>) # Still support: log.child(<config-and-fields>, <just-fields-bool>)
@ -19,11 +21,15 @@ Pros: Compat issues are minimal: a change is only required if there is a
collision with used field and a new config var name. collision with used field and a new config var name.
Cons: A *slight* con is that my guess is the common usage of child is Cons: A *slight* con is that my guess is the common usage of child is
`log.child(<fields>)`, so the more future-proof common usage becomes: `log.child(<fields>)`, so the more future-proof common usage becomes:
log.child(null, <fields>) log.child(null, <fields>)
That's not too bad. It is clearer at least than: That's not too bad. It is clearer at least than:
log.child(<fields>, true) log.child(<fields>, true)
TODO: TODO:
- is there a ticket for this work already? - is there a ticket for this work already?
- make the change - make the change
- do a migration guide? i.e. provide the grep commands to find all - do a migration guide? i.e. provide the grep commands to find all