engine icon indicating copy to clipboard operation
engine copied to clipboard

Engineer CLI: provide more useful descriptions of command line options

Open alisey opened this issue 4 years ago • 0 comments

When running engineer --help, descriptions of commands are missing. E.g. what the difference between engineer start and engineer run?

ꕤ ~/Projects/component-studio yarn engineer --help
yarn run v1.22.10
$ /Users/alexeyl/Projects/component-studio/node_modules/.bin/engineer --help
Usage: engineer [options] [command]

Options:
  -V, --version                   output the version number
  -h, --help                      display help for command

Commands:
  start [options] [path]
  build [options] [path]
  create [options] [featureName]
  run [options] [path]
  clean [path]
  help [command]                  display help for command

Looking at a single command, let's say engineer create, option descriptions are either unclear or missing:

ꕤ ~/Projects/component-studio yarn engineer create --help
yarn run v1.22.10
$ /Users/alexeyl/Projects/component-studio/node_modules/.bin/engineer create --help
Usage: engineer create [options] [featureName]

Options:
  --path <path>
  --featuresDir <featuresDir>    path to the features directory in the project (optional)
  --templatesDir <templatesDir>  path to a customized templates folder (optional)
  -h, --help                     display help for command
  • What's the difference between path and featuresDir?
  • What's used as the default featuresDir and templatesDir?
  • How the feature should be named: camel case, kebab case?
  • What does the command do if templatesDir is not provided?
  • What template should look like?

engineer start

  • What should be passed as the --feature flag? Is it a file path, feature ID?
  • What is --config, --inspect, --port, --publicPath, --open, --publicConfigsRoute?
  • In the description of --singleFeature what does it mean to "build only the feature set by --feature"?

Related: Topics for Engine Documentation

alisey avatar Feb 09 '21 08:02 alisey