search

enb / enb-bem-tmpl-specs

BEM template specs for ENB
Other
15 stars 11 forks source link

Describe available fields for engine #58

Closed qfox closed 9 years ago

qfox commented 9 years ago

Atm readme doesn't provide any information about engines options except some basics. There are caveats that should be described: https://github.com/enb-bem/enb-bem-tmpl-specs/blob/master/lib/plugin.js#L62-67

blond commented 9 years ago

fixed now?

qfox commented 9 years ago

Ops. Not fully. Probably it'd be good to note exportName of options since it's used in lib/plugin.js: https://github.com/enb-bem/enb-bem-tmpl-specs/blob/master/lib/plugin.js#L52

qfox commented 9 years ago

For sure the best way here to move these hacks out of code base. In this case we can just note that in code and close the issue.

Off-topic: Also I thought about moving async into tech itself (or to use apply.length to detect it automatically), but it could break something in future.

blond commented 9 years ago

exportName is option of bemhtml tech. Description this option is in the engine packages: enb-bemxjst and enb-xjst. Why to describe it in documentation of this package?

qfox commented 9 years ago

@andrewblond Because it's used in code. That's why I want to note these lines in code as hardcoded, make an issue to move these func-ty out, and close this issue. ;-)

blond commented 9 years ago

@zxqfox I don't want to describe exportName in the documentation. If you have an opinion how to get rid of hard code — do it! ;)

qfox commented 9 years ago

@andrewblond Okay. Issue for hardcoded exportName: #67

Let's close this!