Skip to content
This repository has been archived by the owner on Jul 15, 2019. It is now read-only.

Allow comments in descriptor files #224

Open
andresn opened this issue Apr 10, 2014 · 6 comments
Open

Allow comments in descriptor files #224

andresn opened this issue Apr 10, 2014 · 6 comments

Comments

@andresn
Copy link

andresn commented Apr 10, 2014

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:
#222

@pranavparikh
Copy link

@andresn
Does this help ?
#232

@proverma
Copy link

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

How about json5 ?

@andresn
Copy link
Author

andresn commented Apr 24, 2014

@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
Copy link

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
Copy link
Author

andresn commented Apr 25, 2014

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

@nottoseethesun
Copy link

+1

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants