Adding blueprints for documented ember objects

[jsfuchs]

Creates blueprints of components, controllers, mixins, and routes with the added documentation specified in ember-style-guide. Copies all the same logic in each index.js, but changes the templates

[GCheung55]

I'd be worried about maintaining this long term.

What if, instead, the generator inserted the comments into files?

[notmessenger]

re: @GCheung55

I'd be worried about maintaining this long term. What if, instead, the generator inserted the comments into files?

That is not how blueprints work nor the recommended way of achieving this (desired) outcome. As far as maintaining long term each release of Ember CLI will require the review of these blueprints for compatibility. Which brings me to how I would actually like to see these improvements approached. Rather than

Just copy the blueprints folder to the top level of your Ember app, and it will override the default generators with their documented versions.

I would like to see this style guide converted into an Ember CLI addon that provides these blueprints. That way when the blueprints are updated a consumer does not have to remember to copy and paste the files again to their application, but instead merely update the version of this addon and automatically receive the new versions. The onus will still be on this repo's maintainers (such as myself) to keep the blueprints in sync with Ember CLI versions but it would just be part of the process to do so when performing an upgrade of the ember-cli dependency.

[GCheung55]

@notmessenger for whatever reason I didn't realize this style guide was not an addon. Turning it into one would be nice.

I should have been clearer about my comment on a generator inserting comments into files, my apologies - though I understand my clarification may not change your opinion.

What I meant is that the blueprints of "this" addon could trigger the corresponding blueprints, and then insert the comments into the files. It would make maintenance a little easier. E.g. ember generate jsdoc-component foo-bar would trigger the component blueprint to create foo-bar component, and then the jsdoc-component would insert the comments, maybe as part of the "content".