Documentation update to include indentation tip about uebersicht

[felixhageloh]

Glad you are enjoying the app! Yes CoffeeScript uses, so called, significant whitespace, meaning incorrect indentation is a syntax error. I don't intend giving a tutorial on CoffeeScript in the readme, but do you think adding a link to the CoffeeScript documentation would do the trick?

Regarding console errors: The compilation of CoffeeScript happens before the widget hits the fronted since you can't run CoffeeScript directly in a browser (which is what Übersicht is essentially). This is why it is impossible to see CoffeeScript errors in the console. However, CoffeeScript errors should be shown directly in the widget, so on your desktop. This is not ideal and could be improved in the future. For example if your widget is not displayable yet, because of styles or because it is completely broken, you will unfortunately never see the errors.

For now you could use a CoffeeScript linter (http://www.coffeelint.org) or an editor that supports CoffeeScript to make sure you catch all syntax errors. Alternatively you could also write widgets in plain Javascript. Hope this helps!

[gboudreau]

Felix: how about a "hard-coded invisible widget" that would use a command that grep errors from the node log, where compilation errors can be found, and simply echo those logs in the debug console?

[edasque]

I was thinking that's actually a good default widget to include.

[edasque]

So where would the coffeescript compilation log be found?

[felixhageloh]

@gboudreau I think you are onto something. Relaying these compilation errors to the console might be a good idea.

@edasque at the moment these errors are shown inside the widget if possible

[agileadam]

@felixhageloh thanks for such a detailed reply. I here what you're saying, and I do think a link would be awesome (not that people won't just Google it I guess). I used one of the existing widgets to derive a hello world example (of sorts) and it never occurred to me that I was using erroneous indentation. Whoops!

I too would love to see the errors in the debug console.

Thanks again!