Add --verbose flag

[ndmitchell]

Seems like it would help diagnose issues such as #216 if you gave a complete listing of everything you were doing, particularly what command lines you run.

[snoyberg]

Try --verbosity debug. @chrisdone what do you think about making --verbose a synonym for it?

[ndmitchell]

Also make sure you list it on the --help output:

C:\Neil\hlint>stack build --verbose
Usage: stack build [TARGET] ([--library-profiling] | [--no-library-profiling])
                   ([--executable-profiling] | [--no-executable-profiling])
                   ([--optimizations] | [--no-optimizations]) [--dry-run]
                   [--ghc-options OPTION] [--flag PACKAGE:[-]FLAG]
  Build the project(s) in this directory/configuration

[snoyberg]

If you run stack --help, it tells you about global options, but it seems very peculiar that we don't show all options for stack build --help. @chrisdone does that need to be fixed in optparse-simple?

[chrisdone]

There is already -v?

[chrisdone]

If you run stack --help, it tells you about global options, but it seems very peculiar that we don't show all options for stack build --help. @chrisdone does that need to be fixed in optparse-simple?

Yeah, that's because those options aren't command specific. We can possibly do something in optparse-simple to re-inject these somehow.

[chrisdone]

@ndmitchell Confirm? We already have -v, but I added --verbose as the long form.

[chrisdone]

Oh, let me also do something about showing global options on subcommands.

[chrisdone]

@snoyberg @ndmitchell I don't yet see a way to make optparse-applicative print out global options for a subcommand's --help output.

The below is the best I can achieve, by moving all global options into each command parser, if there are any.

In the case of no commands:

λ> let noCommandsCase args = do (opts,()) <- withArgs args (simpleOptions "" "" "" (optional (strOption (long "verbose"))) empty); print opts
λ> noCommandsCase []
Nothing
λ> noCommandsCase ["--help"]
Usage: <interactive> [--version] [--help] [--verbose ARG]

Available options:
  --version                Show version
  --help                   Show this help text
*** Exception: ExitSuccess
λ> noCommandsCase ["--verbose=true"]
Just "true"

In the case of commands specified:

λ> let commandsCase args = do (opts,run) <- withArgs args (simpleOptions "" "" "" (optional (strOption (long "verbose"))) (addCommand "build" "do the thing" pure (pure ()))); print opts; run
λ> commandsCase []
Usage: <interactive> [--version] [--help] COMMAND

Available options:
  --version                Show version
  --help                   Show this help text

Available commands:
  build                    do the thing
*** Exception: ExitSuccess
λ> commandsCase ["build","--help"]
Usage: <interactive> build [--verbose ARG]
  do the thing
*** Exception: ExitSuccess
λ> commandsCase ["build","--verbose=true"]
Just "true"
λ> 

[snoyberg]

Perhaps it's worth opening up an issue against optparse-applicative on this?

[chrisdone]

I'm not sure that what we're trying to do makes sense in the optparse-applicative world, but I'll open an issue to ask.

[chrisdone]

The --verbose long-form flag is added, so marking this issue as done, and splitting off the general question of showing global options in subcommand's --help output in pcapriotti/optparse-applicative#138.