search

hence-io / slush-hence

A slush generate to support creating Hence.io web components.
0 stars 0 forks source link

Generator: Name step needs clarification #1

Open riouxtherefore opened 9 years ago

riouxtherefore commented 9 years ago

When running generator it asks for Name as a multistep process, but the text isn't completely clear at each step. Also the term Name is used twice, which may cause confusion.

screen shot 2015-08-07 at 12 11 47 pm

Recommended fixes for setup process

Step 1: Identify your component

The following questions will help you to identify, define and describe your component. Your component will be named using the convention [prefix]-[name]-[type] ? [prefix] How would you like to prefix your component? (recommended: the name of your project) ? [name] What would you like to name your component? (recommended: the name of the component element) ? [type] Choose from the following component types (see project documentation to for more information on Hence component types) ? Describe your new component: ? Starting version of your project?

Step 2: Identify yourself

? What is your name? ? What is your email? ? What is your github username?

Step 3: Project configuration

? Initialize an empty git repo with your details? ? Which css preprocessor do you wish to use? ? Select your development options you wish to enabled: (Press to select)

......

homertherefore commented 9 years ago

Thanks Rioux, I've worked to migrate the component scaffolding over to a new process which allows step by step inquirer processes to pool the users answers and act upon the results.

The new process will be extract into a new Hence.io repository shortly to make it more reusable for other generators we use, and help the slush community.

Due to the limits of console output, varied sized headings aren't possible, but with some more consideration the gulp-util's colours library (chalk) can provide varied heading colour and text.

homertherefore commented 9 years ago

Updates have been made to the component scaffolding, now fully integrated into the new process. The core objects to help build this streamlined process have been pulled out into a new repo, https://github.com/hence-io/glush-util, which will be a toolbelt to assist in building future generators.

The console output for each step is very refined now, and it will help ensure to describe and direct users to filling in their settings without any confusion, looking slick to boot.

By migrating into a broken down step by step installer, each step isolates it's own options/defaults, as well as it's own heading/footer to display, questions it will prompt the user with, and processing the questions answered in those prompts before moving on to the next step, building a consolidated list of answers to easily act upon at the end of the steps.

riouxtherefore commented 9 years ago

Better for sure, Still had a few issues... 1) the checkbox options - might be good to provide a note as to what each development option means? It's a long list of options and I wasn't familiar with all of them. 2) I might get rid of the magenta, and just stick to default, with underline/bold for headings. It actually makes it hard to read on my terminal theme. A lot of people tend to customize their terminal colors in which case it might not make sense for it to be colored (and instead just default). Sorry I hadn't thought of this until I tested it. 3) Under each step you have the ---- line break, which doesn't seem necessary, and make things a bit untidy visually. Probably just a standard line break will do.

homertherefore commented 9 years ago

I've applied the requested improvements to v0.2.7 The use scaffolding, between this repo and the core objects, Scaffold & ScaffoldStep from glush-util, has been vastly improved, keeping things as minimal and DRY as possible.

As long as everything is clear and concise with the current generator, I believe in it's present state it should satisfy closing this issue.