Xrefcheck.Config

Documentation

data Config

Overall config.

Constructors

Config

Fields

• cTraversal :: TraversalConfig
• cVerification :: VerifyConfig

Instances

FromJSON Config

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

data TraversalConfig

Config of repositry traversal.

Constructors

TraversalConfig

Fields

• tcIgnored :: [FilePath]

  Files and folders, files in which we completely ignore.

Instances

FromJSON TraversalConfig

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser TraversalConfig

parseJSONList :: Value -> Parser [TraversalConfig]

data VerifyConfig

Config of verification.

Constructors

VerifyConfig

Fields

• vcAnchorSimilarityThreshold :: Double
• vcExternalRefCheckTimeout :: Time Second
• vcVirtualFiles :: [RelGlobPattern]

  Files which we pretend do exist.

• vcNotScanned :: [FilePath]

  Prefixes of files, references in which we should not analyze.

• vcIgnoreRefs :: Maybe [Regex]

  Regular expressions that match external references we should not verify.

Instances

FromJSON VerifyConfig

Defined in Xrefcheck.Config

Methods

parseJSON :: Value -> Parser VerifyConfig

parseJSONList :: Value -> Parser [VerifyConfig]

cVerificationL :: Lens' Config VerifyConfig

cTraversalL :: Lens' Config TraversalConfig

vcVirtualFilesL :: Lens' VerifyConfig [RelGlobPattern]

vcNotScannedL :: Lens' VerifyConfig [FilePath]

vcIgnoreRefsL :: Lens' VerifyConfig (Maybe [Regex])

vcExternalRefCheckTimeoutL :: Lens' VerifyConfig (Time Second)

vcAnchorSimilarityThresholdL :: Lens' VerifyConfig Double

defConfigText :: ByteString

Default config in textual representation.

Sometimes you cannot just use defConfig because clarifying comments would be lost.

defConfig :: HasCallStack => Config

defaultCompOption :: CompOption

defaultExecOption :: ExecOption

Orphan instances

FromJSON Regex

Methods

parseJSON :: Value -> Parser Regex

parseJSONList :: Value -> Parser [Regex]

KnownRatName unit => FromJSON (Time unit)

Methods

parseJSON :: Value -> Parser (Time unit)

parseJSONList :: Value -> Parser [Time unit]