search

componentjs / component

frontend package manager and build tool for modular web applications
https://github.com/componentjs/guide
MIT License
4.55k stars 306 forks source link

ugly "outdated" logs #612

Open stephenmathieson opened 9 years ago

stephenmathieson commented 9 years ago

imo, this is horrible:

$ node_modules/.bin/component-build 

  outdated name of a dependency : please update: "component/search.js" -> "componentjs/search.js"
   installed : yields/k@0.6.1 in 465ms
   installed : component/top@0.0.2 in 570ms
   installed : component/spinner@1.0.0 in 132ms

  [ ... ]

why not:

  warning: outdated dependency name; please update "component/search.js" -> "componentjs/search.js"

... or something?

netpoetica commented 9 years ago

I agree with this, but I think we might want to consider this as part of a more major log output overhaul, because I've seen a lot of logs like this.

timaschew commented 9 years ago

have you some other examples? what exactly is ugly? that there is a missing warning prefix? or the wording?

netpoetica commented 9 years ago

@timaschew I think for me it's some of the sentence particles using arbitrary punctuation, in combination with all-lowercase words. I don't think the logs are awful, they're just not super-polished.

For example, outdated name of a dependency : please update: is just strange use of the colon twice.

A clear structure like

LOG_LEVEL + TITLE + ":" + MESSAGE
Warning - Outdated Dependencies: Please update "component/search.js" to "componentjs/search.js"

// or

Warning: Outdated Dependencies
Please update "component/search.js" to "componentjs/search.js"

// or
Warning -> Outdated Dependencies: Please update "component/search.js" to "componentjs/search.js"

Would be good to hear from @stephenmathieson for detail about possible improvements.

stephenmathieson commented 9 years ago

keep the left side of the : short and simple. for example: warning : ... (as suggested in the OP).