weeder-2.6.0: src/Weeder/Config.hs

{-# language ApplicativeDo #-}
{-# language BlockArguments #-}
{-# language OverloadedStrings #-}
{-# language RecordWildCards #-}

module Weeder.Config ( Config(..) ) where

-- containers
import Data.Set ( Set )

-- toml-reader
import qualified TOML


-- | Configuration for Weeder analysis.
data Config = Config
  { rootPatterns :: Set String
    -- ^ Any declarations matching these regular expressions will be added to
    -- the root set.
  , typeClassRoots :: Bool
    -- ^ If True, consider all declarations in a type class as part of the root
    -- set. Weeder is currently unable to identify whether or not a type class
    -- instance is used - enabling this option can prevent false positives.
  }

instance TOML.DecodeTOML Config where
  tomlDecoder = do
    rootPatterns <- TOML.getField "roots"
    typeClassRoots <- TOML.getField "type-class-roots"

    return Config{..}