Safe Haskell	Safe-Inferred
Language	Haskell2010

OptEnvConf.Doc

Contents

Internal

Synopsis

renderVersionPage :: String -> Version -> [Chunk]
parserDocs :: Parser a -> AnyDocs (Maybe SetDoc)
commandParserDocs :: Command a -> CommandDoc (Maybe SetDoc)
renderHelpPage :: String -> Version -> String -> AnyDocs (Maybe SetDoc) -> [Chunk]
renderCommandHelpPage :: String -> [String] -> CommandDoc (Maybe SetDoc) -> [Chunk]
renderManPage :: String -> Version -> String -> AnyDocs (Maybe SetDoc) -> [Chunk]
renderReferenceDocumentation :: String -> AnyDocs (Maybe SetDoc) -> [Chunk]
parserOptDocs :: Parser a -> AnyDocs (Maybe OptDoc)
docsToOptDocs :: AnyDocs (Maybe SetDoc) -> AnyDocs (Maybe OptDoc)
renderLongOptDocs :: AnyDocs (Maybe OptDoc) -> [Chunk]
renderShortOptDocs :: String -> AnyDocs (Maybe OptDoc) -> [Chunk]
parserEnvDocs :: Parser a -> AnyDocs EnvDoc
docsToEnvDocs :: AnyDocs (Maybe SetDoc) -> AnyDocs EnvDoc
renderEnvDocs :: AnyDocs EnvDoc -> [Chunk]
parserConfDocs :: Parser a -> AnyDocs ConfDoc
docsToConfDocs :: AnyDocs (Maybe SetDoc) -> AnyDocs ConfDoc
renderConfDocs :: AnyDocs ConfDoc -> [Chunk]
data AnyDocs a
- = AnyDocsCommands !(Maybe String) [CommandDoc a]
- | AnyDocsAnd ![AnyDocs a]
- | AnyDocsOr ![AnyDocs a]
- | AnyDocsSingle !a
data SetDoc = SetDoc {
- setDocTryArgument :: !Bool
- setDocTrySwitch :: !Bool
- setDocTryOption :: !Bool
- setDocDasheds :: ![Dashed]
- setDocEnvVars :: !(Maybe (NonEmpty String))
- setDocConfKeys :: !(Maybe (NonEmpty (NonEmpty String, JSONSchema)))
- setDocDefault :: !(Maybe String)
- setDocExamples :: ![String]
- setDocMetavar :: !(Maybe Metavar)
- setDocHelp :: !(Maybe String)
}
data OptDoc = OptDoc {
- optDocTryArgument :: !Bool
- optDocTrySwitch :: !Bool
- optDocTryOption :: !Bool
- optDocDasheds :: ![Dashed]
- optDocDefault :: !(Maybe String)
- optDocExamples :: ![String]
- optDocMetavar :: !(Maybe Metavar)
- optDocHelp :: !(Maybe String)
}
data EnvDoc = EnvDoc {
- envDocVars :: !(NonEmpty String)
- envDocDefault :: !(Maybe String)
- envDocExamples :: ![String]
- envDocMetavar :: !(Maybe Metavar)
- envDocHelp :: !(Maybe String)
}
data ConfDoc = ConfDoc {
- confDocKeys :: !(NonEmpty (NonEmpty String, JSONSchema))
- confDocDefault :: !(Maybe String)
- confDocExamples :: ![String]
- confDocHelp :: !(Maybe String)
}
data CommandDoc a = CommandDoc {
- commandDocArgument :: String
- commandDocHelp :: Help
- commandDocs :: AnyDocs a
}
settingSetDoc :: Setting a -> Maybe SetDoc
renderSetDoc :: SetDoc -> [[Chunk]]
settingOptDoc :: Setting a -> Maybe OptDoc
renderOptDocLong :: OptDoc -> [[Chunk]]
settingEnvDoc :: Setting a -> Maybe EnvDoc
renderEnvDoc :: EnvDoc -> [[Chunk]]
settingConfDoc :: Setting a -> Maybe ConfDoc
renderConfDoc :: ConfDoc -> [[Chunk]]
helpLines :: Help -> [[Chunk]]

Documentation

renderVersionPage :: String -> Version -> [Chunk] Source #

Render the output of --version

parserDocs :: Parser a -> AnyDocs (Maybe SetDoc) Source #

Derive parser documentation

API Note: We return a Maybe inside the AnyDocs so that we can keep track of hidden settings and use this information to know whether settings are optional or not.

commandParserDocs :: Command a -> CommandDoc (Maybe SetDoc) Source #

renderHelpPage :: String -> Version -> String -> AnyDocs (Maybe SetDoc) -> [Chunk] Source #

Render the output of top-level --help

renderCommandHelpPage :: String -> [String] -> CommandDoc (Maybe SetDoc) -> [Chunk] Source #

Render the output of a --help with at least one command

renderManPage :: String -> Version -> String -> AnyDocs (Maybe SetDoc) -> [Chunk] Source #

Render the output of `--render-man-page` for reading with man

renderReferenceDocumentation :: String -> AnyDocs (Maybe SetDoc) -> [Chunk] Source #

Render reference documentation

parserOptDocs :: Parser a -> AnyDocs (Maybe OptDoc) Source #

docsToOptDocs :: AnyDocs (Maybe SetDoc) -> AnyDocs (Maybe OptDoc) Source #

renderLongOptDocs :: AnyDocs (Maybe OptDoc) -> [Chunk] Source #

Render long-form documentation of options

renderShortOptDocs :: String -> AnyDocs (Maybe OptDoc) -> [Chunk] Source #

Render short-form documentation of options

parserEnvDocs :: Parser a -> AnyDocs EnvDoc Source #

docsToEnvDocs :: AnyDocs (Maybe SetDoc) -> AnyDocs EnvDoc Source #

renderEnvDocs :: AnyDocs EnvDoc -> [Chunk] Source #

Render documentation of envionment variables

parserConfDocs :: Parser a -> AnyDocs ConfDoc Source #

docsToConfDocs :: AnyDocs (Maybe SetDoc) -> AnyDocs ConfDoc Source #

renderConfDocs :: AnyDocs ConfDoc -> [Chunk] Source #

Render documentation of configuration values

Internal

data AnyDocs a Source #

Constructors

AnyDocsCommands !(Maybe String) [CommandDoc a]
AnyDocsAnd ![AnyDocs a]
AnyDocsOr ![AnyDocs a]
AnyDocsSingle !a

Instances

Instances details

Functor AnyDocs Source #
Instance details Defined in OptEnvConf.Doc Methods fmap :: (a -> b) -> AnyDocs a -> AnyDocs b # (<$) :: a -> AnyDocs b -> AnyDocs a #
Show a => Show (AnyDocs a) Source #
Instance details Defined in OptEnvConf.Doc Methods showsPrec :: Int -> AnyDocs a -> ShowS # show :: AnyDocs a -> String # showList :: [AnyDocs a] -> ShowS #

data SetDoc Source #

Constructors

SetDoc
Fields setDocTryArgument :: !Bool setDocTrySwitch :: !Bool setDocTryOption :: !Bool setDocDasheds :: ![Dashed] setDocEnvVars :: !(Maybe (NonEmpty String)) setDocConfKeys :: !(Maybe (NonEmpty (NonEmpty String, JSONSchema))) setDocDefault :: !(Maybe String) setDocExamples :: ![String] setDocMetavar :: !(Maybe Metavar) setDocHelp :: !(Maybe String)

Instances

Instances details

Show SetDoc Source #
Instance details Defined in OptEnvConf.Doc Methods showsPrec :: Int -> SetDoc -> ShowS # show :: SetDoc -> String # showList :: [SetDoc] -> ShowS #

data OptDoc Source #

Constructors

OptDoc
Fields optDocTryArgument :: !Bool optDocTrySwitch :: !Bool optDocTryOption :: !Bool optDocDasheds :: ![Dashed] optDocDefault :: !(Maybe String) optDocExamples :: ![String] optDocMetavar :: !(Maybe Metavar) optDocHelp :: !(Maybe String)

Instances

Instances details

Show OptDoc Source #
Instance details Defined in OptEnvConf.Doc Methods showsPrec :: Int -> OptDoc -> ShowS # show :: OptDoc -> String # showList :: [OptDoc] -> ShowS #

data EnvDoc Source #

Constructors

EnvDoc
Fields envDocVars :: !(NonEmpty String) envDocDefault :: !(Maybe String) envDocExamples :: ![String] envDocMetavar :: !(Maybe Metavar) envDocHelp :: !(Maybe String)

Instances

Instances details

Show EnvDoc Source #
Instance details Defined in OptEnvConf.Doc Methods showsPrec :: Int -> EnvDoc -> ShowS # show :: EnvDoc -> String # showList :: [EnvDoc] -> ShowS #

data ConfDoc Source #

Constructors

ConfDoc
Fields confDocKeys :: !(NonEmpty (NonEmpty String, JSONSchema)) confDocDefault :: !(Maybe String) confDocExamples :: ![String] confDocHelp :: !(Maybe String)

Instances

Instances details

Show ConfDoc Source #
Instance details Defined in OptEnvConf.Doc Methods showsPrec :: Int -> ConfDoc -> ShowS # show :: ConfDoc -> String # showList :: [ConfDoc] -> ShowS #

data CommandDoc a Source #

Constructors

CommandDoc
Fields commandDocArgument :: String commandDocHelp :: Help commandDocs :: AnyDocs a

Instances

Instances details

Functor CommandDoc Source #
Instance details Defined in OptEnvConf.Doc Methods fmap :: (a -> b) -> CommandDoc a -> CommandDoc b # (<$) :: a -> CommandDoc b -> CommandDoc a #
Show a => Show (CommandDoc a) Source #
Instance details Defined in OptEnvConf.Doc Methods showsPrec :: Int -> CommandDoc a -> ShowS # show :: CommandDoc a -> String # showList :: [CommandDoc a] -> ShowS #

settingSetDoc :: Setting a -> Maybe SetDoc Source #

renderSetDoc :: SetDoc -> [[Chunk]] Source #

settingOptDoc :: Setting a -> Maybe OptDoc Source #

renderOptDocLong :: OptDoc -> [[Chunk]] Source #

settingEnvDoc :: Setting a -> Maybe EnvDoc Source #

renderEnvDoc :: EnvDoc -> [[Chunk]] Source #

settingConfDoc :: Setting a -> Maybe ConfDoc Source #

renderConfDoc :: ConfDoc -> [[Chunk]] Source #

helpLines :: Help -> [[Chunk]] Source #