xrefcheck-0.1.2

Safe Haskell	None
Language	Haskell2010

Xrefcheck.CLI

Synopsis

data VerifyMode
- = LocalOnlyMode
- | ExternalOnlyMode
- | FullMode
shouldCheckLocal :: VerifyMode -> Bool
shouldCheckExternal :: VerifyMode -> Bool
data Command
- = DefaultCommand Options
- | DumpConfig FilePath
data Options = Options {
- oConfigPath :: Maybe FilePath
- oRoot :: FilePath
- oMode :: VerifyMode
- oVerbose :: Bool
- oShowProgressBar :: Maybe Bool
- oTraversalOptions :: TraversalOptions
}
data TraversalOptions = TraversalOptions {
- toIgnored :: [FilePath]
}
addTraversalOptions :: TraversalConfig -> TraversalOptions -> TraversalConfig
defaultConfigPaths :: [FilePath]
getCommand :: IO Command

Documentation

data VerifyMode Source #

Which parts of verification do we perform.

Constructors

LocalOnlyMode
ExternalOnlyMode
FullMode

shouldCheckLocal :: VerifyMode -> Bool Source #

shouldCheckExternal :: VerifyMode -> Bool Source #

data Command Source #

Constructors

DefaultCommand Options
DumpConfig FilePath

data Options Source #

Constructors

Options
Fields oConfigPath :: Maybe FilePath oRoot :: FilePath oMode :: VerifyMode oVerbose :: Bool oShowProgressBar :: Maybe Bool oTraversalOptions :: TraversalOptions

data TraversalOptions Source #

Constructors

TraversalOptions
Fields toIgnored :: [FilePath]

addTraversalOptions :: TraversalConfig -> TraversalOptions -> TraversalConfig Source #

defaultConfigPaths :: [FilePath] Source #

Where to try to seek configuration if specific path is not set.

getCommand :: IO Command Source #