Xrefcheck.Verify

General verification

newtype VerifyResult e

Constructors

VerifyResult [e]

Instances

Functor VerifyResult

Defined in Xrefcheck.Verify

Methods

fmap :: (a -> b) -> VerifyResult a -> VerifyResult b

(<$) :: a -> VerifyResult b -> VerifyResult a

Show e => Show (VerifyResult e)

Defined in Xrefcheck.Verify

Methods

showsPrec :: Int -> VerifyResult e -> ShowS

show :: VerifyResult e -> String

showList :: [VerifyResult e] -> ShowS

Semigroup (VerifyResult e)

Defined in Xrefcheck.Verify

Methods

(<>) :: VerifyResult e -> VerifyResult e -> VerifyResult e

sconcat :: NonEmpty (VerifyResult e) -> VerifyResult e

stimes :: Integral b => b -> VerifyResult e -> VerifyResult e

Monoid (VerifyResult e)

Defined in Xrefcheck.Verify

Methods

mempty :: VerifyResult e

mappend :: VerifyResult e -> VerifyResult e -> VerifyResult e

mconcat :: [VerifyResult e] -> VerifyResult e

Buildable e => Buildable (VerifyResult e)

Defined in Xrefcheck.Verify

Methods

build :: VerifyResult e -> Builder

verifyOk :: VerifyResult e -> Bool

verifyErrors :: VerifyResult e -> Maybe (NonEmpty e)

verifying :: Monad m => ExceptT e m () -> m (VerifyResult e)

data WithReferenceLoc a

Constructors

WithReferenceLoc

Fields

• wrlFile :: FilePath
• wrlReference :: Reference
• wrlItem :: a

Instances

Buildable a => Buildable (WithReferenceLoc a)

Defined in Xrefcheck.Verify

Methods

build :: WithReferenceLoc a -> Builder

Cross-references validation

data VerifyError

Constructors

FileDoesNotExist FilePath

AnchorDoesNotExist Text [Anchor]

AmbiguousAnchorRef FilePath Text (NonEmpty Anchor)

ExternalResourceInvalidUri

ExternalResourceUnknownProtocol

ExternalResourceUnavailable Status

ExternalResourceSomeError Text

Instances

Show VerifyError

Defined in Xrefcheck.Verify

Methods

showsPrec :: Int -> VerifyError -> ShowS

show :: VerifyError -> String

showList :: [VerifyError] -> ShowS

Buildable VerifyError

Defined in Xrefcheck.Verify

Methods

build :: VerifyError -> Builder

verifyRepo :: Rewrite -> VerifyConfig -> VerifyMode -> FilePath -> RepoInfo -> IO (VerifyResult $ WithReferenceLoc VerifyError)

checkExternalResource :: VerifyConfig -> Text -> IO (VerifyResult VerifyError)