dojo / cli

:rocket: Dojo - command line tooling.
http://dojo.io
Other
26 stars 34 forks source link

Improve command discoverability #184

Closed matt-gadd closed 6 years ago

matt-gadd commented 6 years ago

Enhancement

This kind of continues on from https://github.com/dojo/cli/issues/183, and I think it has been mentioned elsewhere (I think in regards to the create-theme functionality). We need to improve the discoverability of what commands are available for the end user to install. There are multiple ways we can attack this, a few ideas:

umaar commented 6 years ago

Related thoughts:

For a Dojo 2 app, notice commands are installed separately e.g.

"@dojo/cli-build-webpack": "~0.2.0"
"@dojo/cli-test-intern": "~0.2.0"

So three questions:

  1. When we release a new command, how should the user know to install it?
  2. When we update an existing command, how should the user know to update it?
  3. Could it come across as unintuitive that users must install + update each command separately?

To me this is not obvious and even if it was specified in the readme, I would forget this! I think it's better if the user only has to install a single cli dep and updating that automatically gives access to all new + updated CLI commands.

tomdye commented 6 years ago

Having discussed this with the Dojo 2 team we feel that the best approach is to: