verbosity
Simple enum that encodes application verbosity.
https://github.com/trskop/verbosity
| LTS Haskell 22.43: | 0.4.0.0 |
| Stackage Nightly 2023-12-26: | 0.4.0.0 |
| Latest on Hackage: | 0.4.0.0 |
Maintained by [email protected]
This version can be pinned in stack with:
verbosity-0.4.0.0@sha256:b396e2cb6880cf0b23794579f1903bace1c07db48d536ce3df0c80bc4569233d,4958Module documentation for 0.4.0.0
Depends on 6 packages(full list with versions):
verbosity
Description
Simple enum that encodes application verbosity with various useful instances.
Example
{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DerivingStrategies #-}
module Main.Options
( AppConfig(..)
, quietFlag
, incrementVerbosityFlag
)
where
import GHC.Generics (Generic)
import Data.Verbosity (Verbosity)
import qualified Data.Verbosity as Verbosity (Verbosity(Silent), increment')
import Data.Verbosity.Class (HasVerbosity, modifyVerbosity, setVerbosity)
import qualified Options.Applicative as Options
-- | Application configuration.
data AppConfig = AppConfig
{ verbosity :: Verbosity
-- , ...
}
deriving stock (Generic, Show)
deriving anyclass (HasVerbosity)
-- | Option for suppressing unnecessary output.
--
-- > -q, --quiet
-- > Quiet mode. Suppress normal diagnostic or result output.
quietFlag :: HasVerbosity a => Options.Parser (a -> a)
quietFlag = Options.flag id (setVerbosity Verbosity.Silent) $ mconcat
[ Options.long "quiet"
, Options.short 'q'
, Options.help "Quiet mode. Suppress normal diagnostic or result output."
]
-- | Flag for incrementing verbosity by one level. It can be used multiple
-- times to increase it more.
--
-- > -v
-- > Increment verbosity by one level. Can be used multiple times.
--
-- See 'Verbosity.increment'' for more details.
--
-- Note that this definition uses 'Options.flag'' under the hood to allow using
-- 'Control.Applicative.some' and 'Control.Applicative.many' combinators. In
-- other words, it will fail when used without these combinators or
-- 'Control.Applicative.optional'.
incrementVerbosityFlag :: HasVerbosity a => Options.Parser (a -> a)
incrementVerbosityFlag =
Options.flag' (modifyVerbosity Verbosity.increment') $ mconcat
[ Options.short 'v'
, Options.help "Increment verbosity by one level. Can be used multiple times."
]