jbarget / handlebars-morning-challenge Goto Github PK

readme lacks instructions on how to run the project

phone number is different between js file and test

currently test number 2: https://github.com/Jbarget/handlebars-morning-challenge/blob/master/test/test.js#L11

means that <li> tags need to be on the same line.

Need to adjust test to make it more flexible because most people write lists vertically, not horizontally

test

Handlebars files have the extension .hbs, in this challenge, perhaps suggest changing the file format of message.html to message.hbs, that way you can use syntax highlighters specific to hbs files to easier readability, and change the source variable as follows;

var source = fs.readFileSync(__dirname + "/message.hbs")

All 3 are misleading:
e.g. https://github.com/Jbarget/handlebars-morning-challenge/blob/master/test/test.js#L7
A much better message would be 'html should contain "Hello World: A bit of info about FAC!"'

Please change all of them, it was causing needless confusion.

Either some info in the readme or comments on these lines would be useful, otherwise people have no idea what the tests are testing, what the functions are doing etc.
https://github.com/Jbarget/handlebars-morning-challenge/blob/master/handlebars/handlebars.js#L4-L5

Maybe comments describing what the functions do would be useful as well, e.g:
'each function generates html from the template using the given context variables'

I know this may seem obvious but I think it is much better to explain stuff explicitly, when we saw this most people had no idea what was going on.

'obj' is a bad name imo, could be called context instead (this is more standard)- they call it context in the handlebars docs

https://github.com/Jbarget/handlebars-morning-challenge/blob/master/handlebars/handlebars.js#L8

You mention that this isn't the way you would expect students' code to look:

NB. I know the code isn't very dry but this is just for demonstration purposes!

But maybe the explanation could be a bit clearer, about why you have chosen not to make it dry? And/or maybe you could add a DRY branch, just to show what this would look like?

This is particularly timely, since there have been similar references in other workshops, and FAC10 have expressed frustration around being told "this is not the way you should do it", with no offering of how it should/could be done, or why mentors are doing it differently.

See number 5 under Go in their latest stop go continue, which was particularly in reference to these lines in a postgres workshop, but apparently there have been others.