2

我正在使用 stackage lts 5.1 附带的 optparse-applicative 我有一个带有子命令的解析器，我已经为他们的选项描述了一个帮助文本，但他们没有显示。

这是我运行可执行文件时的输出--help：

[david@devcentos65 manipro]$ /home/david/.local/bin/manipro --help
manipro - text1

Usage: manipro COMMAND [-v|--verbose]   text2

Available options:  
  -h,--help                Show this help text  
  -v,--verbose             text3

Available commands:   
  export                   text4
  dico                     text9

编码 ：

parserArgs :: ParserInfo ArgApp
parserArgs = info (helper <*> args) desc
    where
    desc =  
        fullDesc <> 
        progDesc "text1"  <> 
        header "text2"


args = ArgApp <$> argCmd <*> optverbose
    where
    optverbose = switch ( 
        short 'v' <> long "verbose" <> 
        help "text3" )

argCmd = subparser (argCmdExport <> argCmdDico)

argCmdExport = command "export" infos
    where
    infos = info options desc
    desc  = progDesc "text4" 
    options = ArgCmdExport <$> 
        argModeExport <*> 
        argTableExport <*> 
        argOptExport

argModeExport  = argument auto (metavar "FORMAT")
argTableExport = argument text (metavar "TABLE")

argOptExport = ArgOptExport <$> optional noesc <*> optional cols <*>
    ens <*> tst
    where
    noesc = option textList (long "noesc" <> metavar "CHAMPS" <> help "text5" )
    cols = option textList (long "cols" <> metavar "CHAMPS" <> help "text6" )
    ens = flag EnsEtoile  EnsDollar (short 'd' <> long "dollar" <> 
        help "text7") 
    tst = flag False True (short 't' <> long "test" <> 
        help "text8")

argCmdDico    = command "dico" infos
    where
    infos = info options desc
    desc  = progDesc "text9" 
    options = ArgCmdDico <$> 
        argOptDico

argOptDico = ArgOptDico <$> optional tables
    where
    tables = option textList (long "tables" <> metavar "TABLES" <>
        help "text10" )


text = str >>= return . pack
textList = str >>= return . splitOn "," . pack
4

2 回答 2

5

正如 Zeta 所指出的，单个命令的描述显示在<executable> <command> --help. 但是要使其正常工作，每个命令的子解析器都需要在optparse-applicative解析器中选择该选项。--help你只定义了一个<executable> --help（见你的haskell代码块的第二行）。如果没有针对特定命令的帮助解析器，则输出<executable> <command> --help将不是帮助消息，而是有关 aninvalid option --help和使用说明的通知。

一般模式是按顺序将解析器应用于--help选项，即helper，应用于命令参数的解析器，如下所示command "command-name" (info (yourCommandArgParser <**> helper) (fullDesc <> progDesc "your commands description" <> ...))：

因此，对于export您可以编写的命令：

argCmdExport = command "export" infos
    where
    infos = info (options <**> helper) desc
    desc  = progDesc "text4" 
    options = ArgCmdExport <$> 
        argModeExport <*> 
        argTableExport <*> 
        argOptExport

PS。这个问题很老，但是当我遇到同样的问题时，我偶然发现了它。网络上仍然没有任何关于它的信息。

于 2016-08-22T09:40:30.800 回答
3

optparse-applicative如果您只使用 . 会故意隐藏命令的详细描述--help。毕竟，您可能有十几个命令。例如，stack有 34 个。列表可能会垂直填充您的终端。如果它显示所有可能的参数，您最终会得到很多文本。

相反，--help只会显示常用参数和命令列表。为了显示单个命令的描述，您必须使用<executable> <command> --help：

$ stack --help | head
stack - The Haskell Tool Stack

Usage: stack [--help] [--version] [--numeric-version] [--docker*] [--nix*]
             ([--verbosity VERBOSITY] | [-v|--verbose]) [--work-dir WORK-DIR]
             [--[no-]system-ghc] [--[no-]install-ghc] [--arch ARCH] [--os OS]
             [--ghc-variant VARIANT] [-j|--jobs JOBS] [--extra-include-dirs DIR]
             [--extra-lib-dirs DIR] [--[no-]skip-ghc-check] [--[no-]skip-msys]
             [--local-bin-path DIR] [--[no-]modify-code-page]
             [--resolver RESOLVER] [--compiler COMPILER] [--[no-]terminal]
             [--stack-yaml STACK-YAML] COMMAND|FILE

$ stack --help | grep clean
  clean                    Clean the local packages

$ stack clean --help
Usage: stack clean [PACKAGE] [--help]
  Clean the local packages

Available options:
  PACKAGE                  If none specified, clean all local packages
  --help                   Show this help text

Run 'stack --help' for global options that apply to all subcommands.

这在一定程度上减少了混乱。它还遵循与其他流行的多命令应用程序相同的规则，例如gitand （除了仍然只显示一般帮助hg的小例外）。<executable> --help <command>

于 2016-02-16T08:17:15.230 回答