search

ember-learn / ember-jsonapi-docs

fixes up the ember docs generated by YUIDoc to be in JSONAPI format + some other niceties
9 stars 11 forks source link

exit / fail loudly on invalid versions to `yarn gen` #77

Closed ghost closed 3 years ago

ghost commented 4 years ago

As a contributor I would like to know if I am using the cli incorrectly. Without validation up front I think I am passing correct parameters when I am not. This has been part of my experience in #74 .

I have been trying to generate ember-data API documentation using:

 yarn gen --project ember-data --version 3.14

This is incorrect. I should spell out the version explicitly:

 yarn gen --project ember-data --version 3.14.0

Without the exact version specified the tmp/rev-index folder is not populated correctly and so ember-api-docs app fails to find the payloads.