search

YahooArchive / arrow

FE Test framework designed to promote TDD
http://yahoo.github.io/arrow/arrow_intro.html
BSD 3-Clause "New" or "Revised" License
55 stars 59 forks source link

Allow comments in descriptor files #224

Open andresn opened 10 years ago

andresn commented 10 years ago

For a new module owner, it is often hard to decipher the purpose of each scenario when reading through a long scenario chain within a descriptor file. This could probably be baked into the insertion point of a JsonLint solution proposed here: https://github.com/yahoo/arrow/issues/222

pranavparikh commented 10 years ago

@andresn Does this help ? https://github.com/yahoo/arrow/pull/232

proverma commented 10 years ago

https://www.npmjs.org/package/json5

How about json5 ?

andresn commented 10 years ago

@pranavparikh Temp solution for sure, would this work for scenarios? Sorry, forgot to add scenario was the original usecase. Scenario chains can get really long, and having new devs key off of what the url and its params communicate in terms of context is tricky.

YES. Json5!!!

samlecuyer commented 10 years ago

Why not turn descriptor files into node modules and just have an export object? That way you could just have javascript comments and it wouldn't increase the number of dependencies?

andresn commented 10 years ago

+1, and others here at Yahoo have been thinking the same way.

nottoseethesun commented 10 years ago

+1