Safe Haskell	Safe-Inferred
Language	Haskell2010

Weeder.Config

Contents

Config
Marking instances as roots

Synopsis

type Config = ConfigType Regex
type ConfigParsed = ConfigType String
data ConfigType a = Config {
- rootPatterns :: [a]
- typeClassRoots :: Bool
- rootInstances :: [InstancePattern a]
- unusedTypes :: Bool
- rootModules :: [a]
}
compileConfig :: ConfigParsed -> Either String Config
configToToml :: ConfigParsed -> String
decodeNoDefaults :: Decoder Config
defaultConfig :: ConfigParsed
data InstancePattern a
modulePattern :: InstancePattern a -> Maybe a
instancePattern :: InstancePattern a -> Maybe a
classPattern :: InstancePattern a -> Maybe a
pattern InstanceOnly :: a -> InstancePattern a
pattern ClassOnly :: a -> InstancePattern a
pattern ModuleOnly :: a -> InstancePattern a

Config

type Config = ConfigType Regex Source #

Configuration for Weeder analysis.

type ConfigParsed = ConfigType String Source #

Configuration that has been parsed from TOML (and can still be converted back), but not yet compiled to a Config.

data ConfigType a Source #

Underlying type for Config and ConfigParsed.

Constructors

Config

Fields

rootPatterns :: [a]
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. Overrides root-instances.
rootInstances :: [InstancePattern a]
All matching instances will be added to the root set. An absent field will always match.
unusedTypes :: Bool
Toggle to look for and output unused types. Type family instances will be marked as implicit roots.
rootModules :: [a]
All matching modules will be added to the root set.

Instances

Instances details

Foldable ConfigType Source #
Instance details Defined in Weeder.Config Methods fold :: Monoid m => ConfigType m -> m # foldMap :: Monoid m => (a -> m) -> ConfigType a -> m # foldMap' :: Monoid m => (a -> m) -> ConfigType a -> m # foldr :: (a -> b -> b) -> b -> ConfigType a -> b # foldr' :: (a -> b -> b) -> b -> ConfigType a -> b # foldl :: (b -> a -> b) -> b -> ConfigType a -> b # foldl' :: (b -> a -> b) -> b -> ConfigType a -> b # foldr1 :: (a -> a -> a) -> ConfigType a -> a # foldl1 :: (a -> a -> a) -> ConfigType a -> a # toList :: ConfigType a -> [a] # null :: ConfigType a -> Bool # length :: ConfigType a -> Int # elem :: Eq a => a -> ConfigType a -> Bool # maximum :: Ord a => ConfigType a -> a # minimum :: Ord a => ConfigType a -> a # sum :: Num a => ConfigType a -> a # product :: Num a => ConfigType a -> a #
Traversable ConfigType Source #
Instance details Defined in Weeder.Config Methods traverse :: Applicative f => (a -> f b) -> ConfigType a -> f (ConfigType b) # sequenceA :: Applicative f => ConfigType (f a) -> f (ConfigType a) # mapM :: Monad m => (a -> m b) -> ConfigType a -> m (ConfigType b) # sequence :: Monad m => ConfigType (m a) -> m (ConfigType a) #
Functor ConfigType Source #
Instance details Defined in Weeder.Config Methods fmap :: (a -> b) -> ConfigType a -> ConfigType b # (<$) :: a -> ConfigType b -> ConfigType a #
DecodeTOML Config Source #
Instance details Defined in Weeder.Config Methods tomlDecoder :: Decoder Config #
DecodeTOML ConfigParsed Source #
Instance details Defined in Weeder.Config Methods tomlDecoder :: Decoder ConfigParsed #
Show a => Show (ConfigType a) Source #
Instance details Defined in Weeder.Config Methods showsPrec :: Int -> ConfigType a -> ShowS # show :: ConfigType a -> String # showList :: [ConfigType a] -> ShowS #
Eq a => Eq (ConfigType a) Source #
Instance details Defined in Weeder.Config Methods (==) :: ConfigType a -> ConfigType a -> Bool # (/=) :: ConfigType a -> ConfigType a -> Bool #

compileConfig :: ConfigParsed -> Either String Config Source #

configToToml :: ConfigParsed -> String Source #

decodeNoDefaults :: Decoder Config Source #

defaultConfig :: ConfigParsed Source #

Marking instances as roots

data InstancePattern a Source #

Construct via InstanceOnly, ClassOnly or ModuleOnly, and combine with the Semigroup instance. The Semigroup instance ignores duplicate fields, prioritising the left argument.

Instances

Instances details

Foldable InstancePattern Source #
Instance details Defined in Weeder.Config Methods fold :: Monoid m => InstancePattern m -> m # foldMap :: Monoid m => (a -> m) -> InstancePattern a -> m # foldMap' :: Monoid m => (a -> m) -> InstancePattern a -> m # foldr :: (a -> b -> b) -> b -> InstancePattern a -> b # foldr' :: (a -> b -> b) -> b -> InstancePattern a -> b # foldl :: (b -> a -> b) -> b -> InstancePattern a -> b # foldl' :: (b -> a -> b) -> b -> InstancePattern a -> b # foldr1 :: (a -> a -> a) -> InstancePattern a -> a # foldl1 :: (a -> a -> a) -> InstancePattern a -> a # toList :: InstancePattern a -> [a] # null :: InstancePattern a -> Bool # length :: InstancePattern a -> Int # elem :: Eq a => a -> InstancePattern a -> Bool # maximum :: Ord a => InstancePattern a -> a # minimum :: Ord a => InstancePattern a -> a # sum :: Num a => InstancePattern a -> a # product :: Num a => InstancePattern a -> a #
Traversable InstancePattern Source #
Instance details Defined in Weeder.Config Methods traverse :: Applicative f => (a -> f b) -> InstancePattern a -> f (InstancePattern b) # sequenceA :: Applicative f => InstancePattern (f a) -> f (InstancePattern a) # mapM :: Monad m => (a -> m b) -> InstancePattern a -> m (InstancePattern b) # sequence :: Monad m => InstancePattern (m a) -> m (InstancePattern a) #
Functor InstancePattern Source #
Instance details Defined in Weeder.Config Methods fmap :: (a -> b) -> InstancePattern a -> InstancePattern b # (<$) :: a -> InstancePattern b -> InstancePattern a #
Semigroup (InstancePattern a) Source #
Instance details Defined in Weeder.Config Methods (<>) :: InstancePattern a -> InstancePattern a -> InstancePattern a # sconcat :: NonEmpty (InstancePattern a) -> InstancePattern a # stimes :: Integral b => b -> InstancePattern a -> InstancePattern a #
Show a => Show (InstancePattern a) Source #
Instance details Defined in Weeder.Config Methods showsPrec :: Int -> InstancePattern a -> ShowS # show :: InstancePattern a -> String # showList :: [InstancePattern a] -> ShowS #
Eq a => Eq (InstancePattern a) Source #
Instance details Defined in Weeder.Config Methods (==) :: InstancePattern a -> InstancePattern a -> Bool # (/=) :: InstancePattern a -> InstancePattern a -> Bool #
Ord a => Ord (InstancePattern a) Source #
Instance details Defined in Weeder.Config Methods compare :: InstancePattern a -> InstancePattern a -> Ordering # (<) :: InstancePattern a -> InstancePattern a -> Bool # (<=) :: InstancePattern a -> InstancePattern a -> Bool # (>) :: InstancePattern a -> InstancePattern a -> Bool # (>=) :: InstancePattern a -> InstancePattern a -> Bool # max :: InstancePattern a -> InstancePattern a -> InstancePattern a # min :: InstancePattern a -> InstancePattern a -> InstancePattern a #
DecodeTOML (InstancePattern String) Source #
Instance details Defined in Weeder.Config Methods tomlDecoder :: Decoder (InstancePattern String) #

modulePattern :: InstancePattern a -> Maybe a Source #

instancePattern :: InstancePattern a -> Maybe a Source #

classPattern :: InstancePattern a -> Maybe a Source #

pattern InstanceOnly :: a -> InstancePattern a Source #

pattern ClassOnly :: a -> InstancePattern a Source #

pattern ModuleOnly :: a -> InstancePattern a Source #