search

pushkin-consortium / pushkin-cli

A CLI designed to facilitate the setup process of a Pushkin stack
MIT License
0 stars 4 forks source link

[Feature suggestion] `--verbose` flag #109

Closed jodeleeuw closed 1 year ago

jodeleeuw commented 1 year ago

I think the default user experience of running the CLI should be a relatively quiet install. A progress bar (e.g. cli-progress) would be user friendly. The wall of text that currently gets generated is probably a bit overwhelming for a new user. For debugging, a --verbose flag could turn back on the outputs currently generated.

jkhartshorne commented 1 year ago

@jessestorbeck -- this might actually be a pretty good CLI task for you. The cli package we use makes it pretty easy to parse flags. So you just have to add code to check for that flag and use it to set a variable (a good name for it would be "verbose"). Then every place we currently use console.log, you would first check to see if verbose==true and only print if it is. Unless it's something very important (like an error or a warning or ... something else very important).

I'm sure the package has a way of instituting a status bar, but I haven't checked.

If it'd be helpful, schedule a meeting with me to discuss. In particular, you might have some questions about the CLI package we use.

jessestorbeck commented 1 year ago

@jkhartshorne -- I agree this seems pretty doable for me.