-
-
Notifications
You must be signed in to change notification settings - Fork 142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add prompt for ESDoc/YUIDoc #248
Conversation
This adds a prompt so you can select ESDoc or YUIDoc when the blueprints run.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @rwwagner90!
@@ -63,9 +63,39 @@ module.exports = { | |||
} | |||
|
|||
if (!hasPlugins) { | |||
return this._chooseAddonsToInstall() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like there's a lint failure because the return
below this one is dead code now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, I meant to remove that.
return this.addAddonsToProject({ | ||
packages: [addon], | ||
blueprintOptions: { | ||
save: options.save |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this option doing? Was something behaving wrong when we didn't have it before?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This just allows a passthrough of if you do ember install ember-cli-addon-docs --save
it passes the --save
to the other deps it adds here.
return this.ui.prompt({ | ||
type: 'list', | ||
name: 'addonToInstall', | ||
message: 'Which documentation style would you like to use?', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we include a choice not to install anything at all? I could imagine wanting to use another addon-docs plugin that isn't necessarily part of the ember-learn org, or just not needing or wanting generated API docs for an addon at all.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we could certainly add options, as they become necessary. I think for now, this is an improvement on always using yuidoc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough. I'll probably turn around and add a "no plugin" option anyway because I think it's valuable, but I don't need to push that work on you here 🙂
This adds a prompt so you can select ESDoc or YUIDoc when the blueprints run.