-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Helper functions for optparse-applicative.
--   
--   The optparse-applicative package, as well as optparse-simple, has some
--   undesirable behavior by default, and is quite verbose. This package
--   exists to work around those two.
--   
--   For instance:
--   
--   <ul>
--   <li>optparse-applicative does not show help on error by default.</li>
--   <li>optparse-applicative does not disambiguate commands. So, if you
--   have a command <tt>my-executable foobar</tt>, but your user runs
--   <tt>my-executable f</tt>, optparse-applicative will not disambiguate
--   this by default.</li>
--   </ul>
--   
--   For more specific documentation, see the module documentation for
--   <a>Options.Applicative.Helper</a>.
@package optparse-helper
@version 0.2.1.0


-- | Helper functions to complement <a>Options.Applicative</a>
--   
--   To use, do something like this:
--   
--   <pre>
--   module Main where
--   
--   import Options.Applicative
--   import Options.Applicative.Helper
--   
--   data ParserResult = Result1
--                     | Result2
--                     | Result3
--     deriving (Show)
--   
--   main :: IO ()
--   main =
--     do myResult &lt;- helperExecParser myParser (fpDesc "Demonstration")
--        doSomethingWith myResult
--   
--   myParser :: Parser ParserResult
--   myParser =
--     subconcat [ command "result1"
--                         (infoHelper (pure Result1)
--                                     (fpDesc "Result1"))
--               , command "result2"
--                         (infoHelper (pure Result2)
--                                     (fpDesc "Result2"))
--               , command "result3"
--                         (infoHelper (pure Result3)
--                                     (fpDesc "Result3"))
--               ]
--   
--   doSomethingWith :: ParserResult -&gt; IO ()
--   doSomethingWith = print
--   </pre>
module Options.Applicative.Helper

-- | Wrapper around <a>info</a> and <a>helper</a>
--   
--   <pre>
--   info (helper &lt;*&gt; a) ...
--   </pre>
--   
--   Instead, it's just
--   
--   <pre>
--   infoHelper a ...
--   </pre>
infoHelper :: Parser a -> InfoMod a -> ParserInfo a

-- | Sort of like <a>mconcat</a> for <a>Alternative</a>s
--   
--   Instead of
--   
--   <pre>
--   foo &lt;|&gt; bar &lt;|&gt; baz &lt;|&gt; quux &lt;|&gt; ...
--   </pre>
--   
--   Now, it's just
--   
--   <pre>
--   altconcat [ foo
--             , bar
--             , baz
--             , quux
--             ...
--             ]
--   </pre>
altconcat :: Alternative f => [f a] -> f a

-- | <pre>
--   altconcat . fmap subparser
--   </pre>
--   
--   Instead of
--   
--   <pre>
--   subparser (command "foo" ...)
--     &lt;|&gt; subparser (command "bar" ...)
--     &lt;|&gt; subparser (command "baz" ...)
--     ...
--   </pre>
--   
--   Instead it's
--   
--   <pre>
--   subconcat [ command "foo" ...
--             , command "bar" ...
--             , command "baz" ...
--             ...
--             ]
--   </pre>
subconcat :: [Mod CommandFields a] -> Parser a

-- | <pre>
--   mappend fullDesc . progDesc
--   </pre>
--   
--   <pre>
--   mconcat [ fullDesc
--           , progDesc "whatever"
--           ...
--           ]
--   </pre>
--   
--   Now, it's just
--   
--   <pre>
--   mconcat [ fpDesc "whatever"
--           ...
--           ]
--   </pre>
fpDesc :: String -> InfoMod a

-- | Preferences that I like. Using these preferences, your app will
--   
--   <ul>
--   <li>disambiguate shortened subcommands</li>
--   <li>show help whenever someone makes an error.</li>
--   </ul>
--   
--   Note that you should use this in combination with <a>infoHelper</a>
--   for maximum helpfulness.
--   
--   <pre>
--   prefs helperPrefsMod
--   </pre>
helperPrefs :: ParserPrefs

-- | The <a>PrefsMod</a> for <a>helperPrefs</a> so that you can add on your
--   own preferences.
--   
--   <pre>
--   mappend disambiguate showHelpOnError
--   </pre>
helperPrefsMod :: PrefsMod

-- | Wrapper around <a>customExecParser</a>, <a>helperPrefs</a>, and
--   <a>infoHelper</a>
--   
--   <pre>
--   helperExecParser a b = customExecParser helperPrefs (infoHelper a b)
--   </pre>
helperExecParser :: Parser a -> InfoMod a -> IO a