[NPMCLI-77] Interactive setup assistant Created: 19/Jan/17 Updated: 30/Jan/17 Resolved: 26/Jan/17 |
|
| Status: | Closed |
| Project: | Magnolia CLI |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | New Feature | Priority: | Neutral |
| Reporter: | Robert Kowalski | Assignee: | Robert Kowalski |
| Resolution: | Won't Fix | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Template: |
|
| Acceptance criteria: |
Empty
|
| Date of First Response: | |
| Epic Link: | CLI: Help users get started |
| Sprint: | Basel 80 |
| Story Points: | 1 |
| Description |
|
To help the user setting up new project, mgnl could ask the users questions, e.g. how they want to name it and if they want to setup the module for a certain Open Source License. The assistant can be disabled by a commandline flag (falling back to defaults) or does not start if the user provided all needed data via commandline. License type is proprietary by default. |
| Comments |
| Comment by Christopher Zimmermann [ 23/Jan/17 ] |
|
Please provide a specification of the interactivity to be added per command. |
| Comment by Tomáš Gregovský [ 25/Jan/17 ] |
|
when we originally thought about Magnolia CLI tool logics, we decide to stay with approach that ppl can copy paste single line command from documentation / tutorial / blog post and everything will happends. Instead of writing tutorials the way 'enter command: mgnl create-component, then when script ask you for name of component, enter your component name, then when strip ask you if you want to add availability, enter target page, etc...'. Maybe it make sense during cli installation or maybe jumpstart, but for create-page/component I am fan of one full command. thank you! |
| Comment by Robert Kowalski [ 26/Jan/17 ] |
|
tgregovsky from my understanding we are not adding a prompt to every command, so they stay unixy and composable, more an assistant to setup a new project like `npm init` |
| Comment by Robert Kowalski [ 26/Jan/17 ] |
|
Just chatted with czimmermann: The assumption was that we developers usually need a page together with a new light-module. Turns out, this is not often the case. After some discussion we came to the conclusion that an assistant like `npm init` doesn't make sense right now. We definitely want to keep following the unix way with the main commands, so for now also no assistant asking questions if arguments are missing. |