xrefcheck-0.3.0

Safe Haskell	Safe-Inferred
Language	Haskell2010

Xrefcheck.CLI

Synopsis

data VerifyMode
- = LocalOnlyMode
- | ExternalOnlyMode
- | FullMode
data ExclusionOptions = ExclusionOptions {
- eoIgnore :: [CanonicalRelGlobPattern]
}
data Command
- = DefaultCommand Options
- | DumpConfig Flavor DumpConfigMode
data DumpConfigMode
- = DCMFile Bool FilePath
- | DCMStdout
data Options = Options {
- oConfigPath :: Maybe FilePath
- oRoot :: FilePath
- oMode :: VerifyMode
- oVerbose :: Bool
- oShowProgressBar :: Maybe Bool
- oColorMode :: Maybe ColorMode
- oPrintUnixPaths :: PrintUnixPaths
- oExclusionOptions :: ExclusionOptions
- oNetworkingOptions :: NetworkingOptions
- oScanPolicy :: ScanPolicy
}
data NetworkingOptions = NetworkingOptions {
- noMaxRetries :: Maybe Int
}
addNetworkingOptions :: NetworkingConfig -> NetworkingOptions -> NetworkingConfig
shouldCheckLocal :: VerifyMode -> Bool
shouldCheckExternal :: VerifyMode -> Bool
addExclusionOptions :: ExclusionConfig -> ExclusionOptions -> ExclusionConfig
defaultConfigPaths :: [FilePath]
getCommand :: IO Command

Documentation

data VerifyMode Source #

Which parts of verification do we perform.

Constructors

LocalOnlyMode
ExternalOnlyMode
FullMode

data ExclusionOptions Source #

Constructors

ExclusionOptions
Fields eoIgnore :: [CanonicalRelGlobPattern]

data Command Source #

Constructors

DefaultCommand Options
DumpConfig Flavor DumpConfigMode

data DumpConfigMode Source #

Constructors

DCMFile Bool FilePath
DCMStdout

data Options Source #

Constructors

Options
Fields oConfigPath :: Maybe FilePath oRoot :: FilePath oMode :: VerifyMode oVerbose :: Bool oShowProgressBar :: Maybe Bool oColorMode :: Maybe ColorMode oPrintUnixPaths :: PrintUnixPaths oExclusionOptions :: ExclusionOptions oNetworkingOptions :: NetworkingOptions oScanPolicy :: ScanPolicy

data NetworkingOptions Source #

Constructors

NetworkingOptions
Fields noMaxRetries :: Maybe Int

addNetworkingOptions :: NetworkingConfig -> NetworkingOptions -> NetworkingConfig Source #

shouldCheckLocal :: VerifyMode -> Bool Source #

shouldCheckExternal :: VerifyMode -> Bool Source #

addExclusionOptions :: ExclusionConfig -> ExclusionOptions -> ExclusionConfig Source #

defaultConfigPaths :: [FilePath] Source #

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

getCommand :: IO Command Source #