diff --git a/TODO.md b/TODO.md index 0f2f2c5..eef780b 100644 --- a/TODO.md +++ b/TODO.md @@ -1,7 +1,37 @@ +# higher prio + - `bunyan` (without redir) ^C should stop, doesn't since recent change - man page for the bunyan CLI (refer to it in the readme) -- `tail -f`-like support -- 2.0 (?) with `v: 1` in log records. Fwd/bwd compat in `bunyan` CLI + + +# changes to ctor and log.child to separate fields from config + +Current: + createLogger() + log.child(, ) + +Could be: + createLogger(, ) + log.child(, ) + # Still support: log.child(, ) + +Pros: Compat issues are minimal: a change is only required if there is a +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 +`log.child()`, so the more future-proof common usage becomes: + log.child(null, ) +That's not too bad. It is clearer at least than: + log.child(, true) + +TODO: +- is there a ticket for this work already? +- make the change +- do a migration guide? i.e. provide the grep commands to find all + possible calls to inspect. E.g. if don't have `rg logUndefined` in your + code, then you are fine. And one time future-proofing via changing + to fields in the *second* arg. +- list of issues/pulls that wanted to add new config fields + # docs @@ -10,6 +40,8 @@ # someday/maybe +- 2.0 (?) with `v: 1` in log records. Fwd/bwd compat in `bunyan` CLI +- `tail -f`-like support - full-on docs - better examples/ - better coloring