Explicitly state build_options in help output, fixes #363 #364
Conversation
src/cli.cr
Outdated
| version [<path>] - Print the current version of the shard. | ||
|
|
||
| Build options: | ||
| Use "crystal build --help" to see available build options. |
There was a problem hiding this comment.
I don't think this should be mentioned here. There are no explanations for other command's arguments either.
That would better fit for a more detailled shards build --help if that was a thing.
There was a problem hiding this comment.
Since shards build --help is not a thing, I'm assuming we have to somehow clarify that build_options have nothing to do with GENERAL OPTIONS, same way it's stated in the manpage.
I also don't see a way how we could implement shards build --help without copying the info from crystal build --help directly and then somehow keeping these two in sync.
Any ideas?
There was a problem hiding this comment.
Well shards build --help wouldn't list the options explicitly but show more details information about the command itself, just like the build entry on the manpage.
There was a problem hiding this comment.
Okay, we can specify it in the build arg itself, does this seem suitable?
build [<targets>] [<build_options>] - Build the specified <targets> in `bin` path, all build_options are delegated to `crystal build`.
There was a problem hiding this comment.
Thanks @RX14! I've updated the code accordingly.
Oh I missed that, thanks! Updated. |
Darwinnn
force-pushed
the
fix/363/help_output_on_build_options
branch
from
928a174
to
5a039fa
Compare
The
[<options>]in thebuildargument was a bit misleading, it's more clear now on what options to use withbuild