https://github.com/trskop/verbosity

Simple enum that encodes application verbosity.
https://github.com/trskop/verbosity

Last synced: 10 days ago
JSON representation

Simple enum that encodes application verbosity.

• Host: GitHub
• URL: https://github.com/trskop/verbosity
• Owner: trskop
• License: bsd-3-clause
• Created: 2015-08-01T21:18:55.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-07-02T18:24:38.000Z (over 4 years ago)
• Last Synced: 2024-04-25T15:43:30.449Z (7 months ago)
• Language: Haskell
• Homepage:
• Size: 47.9 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# verbosity

[![Hackage](http://img.shields.io/hackage/v/verbosity.svg)][Hackage: verbosity]

[![Hackage Dependencies](https://img.shields.io/hackage-deps/v/verbosity.svg)](http://packdeps.haskellers.com/feed?needle=verbosity)

[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)][Haskell.org]

[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)][tl;dr Legal: BSD3]

[![Build](https://travis-ci.org/trskop/verbosity.svg)](https://travis-ci.org/trskop/verbosity)

## Description

Simple enum that encodes application verbosity with various useful instances.

## Example

```Haskell

{-# 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."

        ]

```

[Hackage: verbosity]: http://hackage.haskell.org/package/verbosity "verbosity package on Hackage"

[Haskell.org]: http://www.haskell.org "The Haskell Programming Language"

[tl;dr Legal: BSD3]: https://tldrlegal.com/license/bsd-3-clause-license-%28revised%29 "BSD 3-Clause License (Revised)"