Xrefcheck.Core

Various primitives.

Documentation

data Flavor

Markdown flavor.

Unfortunatelly, CMark renderers used on different sites slightly differ, we have to account for that.

Constructors

GitHub

GitLab

Instances

FromJSON Flavor

Defined in Xrefcheck.Core

Methods

parseJSON :: Value -> Parser Flavor

parseJSONList :: Value -> Parser [Flavor]

omittedField :: Maybe Flavor

Bounded Flavor

Defined in Xrefcheck.Core

Methods

minBound :: Flavor

maxBound :: Flavor

Enum Flavor

Defined in Xrefcheck.Core

Methods

succ :: Flavor -> Flavor

pred :: Flavor -> Flavor

toEnum :: Int -> Flavor

fromEnum :: Flavor -> Int

enumFrom :: Flavor -> [Flavor]

enumFromThen :: Flavor -> Flavor -> [Flavor]

enumFromTo :: Flavor -> Flavor -> [Flavor]

enumFromThenTo :: Flavor -> Flavor -> Flavor -> [Flavor]

Show Flavor

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> Flavor -> ShowS

show :: Flavor -> String

showList :: [Flavor] -> ShowS

allFlavors :: [Flavor]

caseInsensitiveAnchors :: Flavor -> Bool

Whether anchors are case-sensitive for a given Markdown flavour or not.

newtype Position

Description of element position in source file. We keep this in text because scanners for different formats use different representation of this thing, and it actually appears in reports only.

Constructors

Position Text

Instances

Generic Position

Defined in Xrefcheck.Core

Associated Types

type Rep Position :: Type -> Type

Methods

from :: Position -> Rep Position x

to :: Rep Position x -> Position

Show Position

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

NFData Position

Defined in Xrefcheck.Core

Methods

rnf :: Position -> ()

Buildable Position

Defined in Xrefcheck.Core

Methods

build :: Position -> Builder

Eq Position

Defined in Xrefcheck.Core

Methods

(==) :: Position -> Position -> Bool

(/=) :: Position -> Position -> Bool

type Rep Position

Defined in Xrefcheck.Core

type Rep Position = D1 ('MetaData "Position" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'True) (C1 ('MetaCons "Position" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Reference

Full info about a reference.

Constructors

Reference

Fields

• rName :: Text

  Text displayed as reference.

• rPos :: Position

  Position in source file.

• rInfo :: ReferenceInfo

  More info about the reference.

Instances

Generic Reference

Defined in Xrefcheck.Core

Associated Types

type Rep Reference :: Type -> Type

Methods

from :: Reference -> Rep Reference x

to :: Rep Reference x -> Reference

Show Reference

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> Reference -> ShowS

show :: Reference -> String

showList :: [Reference] -> ShowS

NFData Reference

Defined in Xrefcheck.Core

Methods

rnf :: Reference -> ()

Given ColorMode => Buildable Reference

Defined in Xrefcheck.Core

Methods

build :: Reference -> Builder

type Rep Reference

Defined in Xrefcheck.Core

type Rep Reference = D1 ('MetaData "Reference" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "Reference" 'PrefixI 'True) (S1 ('MetaSel ('Just "rName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rPos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Position) :*: S1 ('MetaSel ('Just "rInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReferenceInfo))))

data ReferenceInfo

Info about the reference.

Constructors

RIExternal ExternalLink

RIFile ReferenceInfoFile

Instances

Generic ReferenceInfo

Defined in Xrefcheck.Core

Associated Types

type Rep ReferenceInfo :: Type -> Type

Methods

from :: ReferenceInfo -> Rep ReferenceInfo x

to :: Rep ReferenceInfo x -> ReferenceInfo

Show ReferenceInfo

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> ReferenceInfo -> ShowS

show :: ReferenceInfo -> String

showList :: [ReferenceInfo] -> ShowS

NFData ReferenceInfo

Defined in Xrefcheck.Core

Methods

rnf :: ReferenceInfo -> ()

type Rep ReferenceInfo

Defined in Xrefcheck.Core

type Rep ReferenceInfo = D1 ('MetaData "ReferenceInfo" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "RIExternal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExternalLink)) :+: C1 ('MetaCons "RIFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReferenceInfoFile)))

data ReferenceInfoFile

Constructors

ReferenceInfoFile

Fields

• rifAnchor :: Maybe Text

  Section or custom anchor tag.

• rifLink :: FileLink

  More info about the link.

Instances

Generic ReferenceInfoFile

Defined in Xrefcheck.Core

Associated Types

type Rep ReferenceInfoFile :: Type -> Type

Methods

from :: ReferenceInfoFile -> Rep ReferenceInfoFile x

to :: Rep ReferenceInfoFile x -> ReferenceInfoFile

Show ReferenceInfoFile

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> ReferenceInfoFile -> ShowS

show :: ReferenceInfoFile -> String

showList :: [ReferenceInfoFile] -> ShowS

NFData ReferenceInfoFile

Defined in Xrefcheck.Core

Methods

rnf :: ReferenceInfoFile -> ()

type Rep ReferenceInfoFile

Defined in Xrefcheck.Core

type Rep ReferenceInfoFile = D1 ('MetaData "ReferenceInfoFile" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "ReferenceInfoFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "rifAnchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rifLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileLink)))

data ExternalLink

Constructors

ELUrl Text

Reference to a file at outer site, e.g d.

ELOther Text

Entry not to be processed, e.g. mailto:e-mail.

Instances

Generic ExternalLink

Defined in Xrefcheck.Core

Associated Types

type Rep ExternalLink :: Type -> Type

Methods

from :: ExternalLink -> Rep ExternalLink x

to :: Rep ExternalLink x -> ExternalLink

Show ExternalLink

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> ExternalLink -> ShowS

show :: ExternalLink -> String

showList :: [ExternalLink] -> ShowS

NFData ExternalLink

Defined in Xrefcheck.Core

Methods

rnf :: ExternalLink -> ()

type Rep ExternalLink

Defined in Xrefcheck.Core

type Rep ExternalLink = D1 ('MetaData "ExternalLink" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "ELUrl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "ELOther" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data FileLink

Constructors

FLAbsolute RelPosixLink

Reference to a file or directory relative to the repository root.

FLRelative RelPosixLink

Reference to a file or directory relative to the given one.

FLLocal

Reference to this file.

Instances

Generic FileLink

Defined in Xrefcheck.Core

Associated Types

type Rep FileLink :: Type -> Type

Methods

from :: FileLink -> Rep FileLink x

to :: Rep FileLink x -> FileLink

Show FileLink

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> FileLink -> ShowS

show :: FileLink -> String

showList :: [FileLink] -> ShowS

NFData FileLink

Defined in Xrefcheck.Core

Methods

rnf :: FileLink -> ()

type Rep FileLink

Defined in Xrefcheck.Core

type Rep FileLink = D1 ('MetaData "FileLink" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "FLAbsolute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RelPosixLink)) :+: (C1 ('MetaCons "FLRelative" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RelPosixLink)) :+: C1 ('MetaCons "FLLocal" 'PrefixI 'False) (U1 :: Type -> Type)))

_RIFile :: Prism' ReferenceInfo ReferenceInfoFile

_RIExternal :: Prism' ReferenceInfo ExternalLink

_ELOther :: Prism' ExternalLink Text

_ELUrl :: Prism' ExternalLink Text

pattern PathSep :: Char

referenceInfo :: Text -> ReferenceInfo

Compute the ReferenceInfo corresponding to a given link.

data AnchorType

Context of anchor.

Constructors

HeaderAnchor Int

Every section header is usually an anchor

HandAnchor

They can be set up manually

BiblioAnchor

Id of entry in bibliography

Instances

Generic AnchorType

Defined in Xrefcheck.Core

Associated Types

type Rep AnchorType :: Type -> Type

Methods

from :: AnchorType -> Rep AnchorType x

to :: Rep AnchorType x -> AnchorType

Show AnchorType

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> AnchorType -> ShowS

show :: AnchorType -> String

showList :: [AnchorType] -> ShowS

NFData AnchorType

Defined in Xrefcheck.Core

Methods

rnf :: AnchorType -> ()

Given ColorMode => Buildable AnchorType

Defined in Xrefcheck.Core

Methods

build :: AnchorType -> Builder

Eq AnchorType

Defined in Xrefcheck.Core

Methods

(==) :: AnchorType -> AnchorType -> Bool

(/=) :: AnchorType -> AnchorType -> Bool

type Rep AnchorType

Defined in Xrefcheck.Core

type Rep AnchorType = D1 ('MetaData "AnchorType" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "HeaderAnchor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: (C1 ('MetaCons "HandAnchor" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BiblioAnchor" 'PrefixI 'False) (U1 :: Type -> Type)))

data Anchor

A referable anchor.

Constructors

Anchor

Fields

• aType :: AnchorType
• aName :: Text
• aPos :: Position

Instances

Generic Anchor

Defined in Xrefcheck.Core

Associated Types

type Rep Anchor :: Type -> Type

Methods

from :: Anchor -> Rep Anchor x

to :: Rep Anchor x -> Anchor

Show Anchor

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> Anchor -> ShowS

show :: Anchor -> String

showList :: [Anchor] -> ShowS

NFData Anchor

Defined in Xrefcheck.Core

Methods

rnf :: Anchor -> ()

Given ColorMode => Buildable Anchor

Defined in Xrefcheck.Core

Methods

build :: Anchor -> Builder

Eq Anchor

Defined in Xrefcheck.Core

Methods

(==) :: Anchor -> Anchor -> Bool

(/=) :: Anchor -> Anchor -> Bool

type Rep Anchor

Defined in Xrefcheck.Core

type Rep Anchor = D1 ('MetaData "Anchor" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "Anchor" 'PrefixI 'True) (S1 ('MetaSel ('Just "aType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AnchorType) :*: (S1 ('MetaSel ('Just "aName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "aPos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Position))))

data FileInfoDiff

Constructors

FileInfoDiff

Fields

• _fidReferences :: DList Reference
• _fidAnchors :: DList Anchor

Instances

Monoid FileInfoDiff

Defined in Xrefcheck.Core

Methods

mempty :: FileInfoDiff

mappend :: FileInfoDiff -> FileInfoDiff -> FileInfoDiff

mconcat :: [FileInfoDiff] -> FileInfoDiff

Semigroup FileInfoDiff

Defined in Xrefcheck.Core

Methods

(<>) :: FileInfoDiff -> FileInfoDiff -> FileInfoDiff

sconcat :: NonEmpty FileInfoDiff -> FileInfoDiff

stimes :: Integral b => b -> FileInfoDiff -> FileInfoDiff

fidReferences :: Lens' FileInfoDiff (DList Reference)

fidAnchors :: Lens' FileInfoDiff (DList Anchor)

diffToFileInfo :: FileInfoDiff -> FileInfo

data FileInfo

All information regarding a single file we care about.

Constructors

FileInfo

Fields

• _fiReferences :: [Reference]
• _fiAnchors :: [Anchor]

Instances

Generic FileInfo

Defined in Xrefcheck.Core

Associated Types

type Rep FileInfo :: Type -> Type

Methods

from :: FileInfo -> Rep FileInfo x

to :: Rep FileInfo x -> FileInfo

Show FileInfo

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> FileInfo -> ShowS

show :: FileInfo -> String

showList :: [FileInfo] -> ShowS

NFData FileInfo

Defined in Xrefcheck.Core

Methods

rnf :: FileInfo -> ()

Given ColorMode => Buildable FileInfo

Defined in Xrefcheck.Core

Methods

build :: FileInfo -> Builder

type Rep FileInfo

Defined in Xrefcheck.Core

type Rep FileInfo = D1 ('MetaData "FileInfo" "Xrefcheck.Core" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "FileInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "_fiReferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Reference]) :*: S1 ('MetaSel ('Just "_fiAnchors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Anchor])))

fiReferences :: Lens' FileInfo [Reference]

fiAnchors :: Lens' FileInfo [Anchor]

data ScanPolicy

Constructors

OnlyTracked

Scan and treat as existing only files tracked by Git. Warn when there are scannable files not added to Git yet.

IncludeUntracked

Also scan and treat as existing files that were neither tracked nor ignored by Git.

Instances

Show ScanPolicy

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> ScanPolicy -> ShowS

show :: ScanPolicy -> String

showList :: [ScanPolicy] -> ShowS

Eq ScanPolicy

Defined in Xrefcheck.Core

Methods

(==) :: ScanPolicy -> ScanPolicy -> Bool

(/=) :: ScanPolicy -> ScanPolicy -> Bool

data FileStatus

Constructors

Scanned FileInfo

NotScannable

Files that are not supported by our scanners.

NotAddedToGit

We are not scanning files that are not added to git unless --include-untracked CLI option was enabled, but we're gathering information about them to improve reports.

Instances

Show FileStatus

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> FileStatus -> ShowS

show :: FileStatus -> String

showList :: [FileStatus] -> ShowS

data DirectoryStatus

Constructors

TrackedDirectory

UntrackedDirectory

Instances

Show DirectoryStatus

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> DirectoryStatus -> ShowS

show :: DirectoryStatus -> String

showList :: [DirectoryStatus] -> ShowS

data RepoInfo

All tracked files and directories.

Constructors

RepoInfo

Fields

• riFiles :: Map CanonicalRelPosixLink (RelPosixLink, FileStatus)

  Files from the repo with FileInfo attached to files that we've scanned.

• riDirectories :: Map CanonicalRelPosixLink (RelPosixLink, DirectoryStatus)

  Directories containing those files.

Instances

Given ColorMode => Buildable RepoInfo

Defined in Xrefcheck.Core

Methods

build :: RepoInfo -> Builder

lookupFile :: CanonicalRelPosixLink -> RepoInfo -> Maybe FileStatus

lookupDirectory :: CanonicalRelPosixLink -> RepoInfo -> Maybe DirectoryStatus

data VerifyMode

Which parts of verification do we perform.

Constructors

LocalOnlyMode

ExternalOnlyMode

FullMode

shouldCheckLocal :: VerifyMode -> Bool

shouldCheckExternal :: VerifyMode -> Bool

headerToAnchor :: Flavor -> Text -> Text

Convert section header name to an anchor refering it. Conversion rules: https://docs.gitlab.com/ee/user/markdown.html#header-ids-and-links

stripAnchorDupNo :: Text -> Maybe Text

When there are several anchors with the same name, github automatically attaches "-number" suffixes to duplications to make them referable unambiguously. For instance, if there are two headers called "description", they would gain "description" and "description-1" anchors correspondingly.

This function strips this suffix and returns the original anchor in case when suffix is present.

data VerifyProgress

Constructors

VerifyProgress

Fields

• vrLocal :: !(Progress Int ())
• vrExternal :: !(Progress Int Text)

Instances

Show VerifyProgress

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> VerifyProgress -> ShowS

show :: VerifyProgress -> String

showList :: [VerifyProgress] -> ShowS

initVerifyProgress :: [Reference] -> VerifyProgress

showAnalyseProgress :: Given ColorMode => VerifyMode -> Time Second -> VerifyProgress -> Text

reprintAnalyseProgress :: Given ColorMode => Rewrite -> VerifyMode -> Time Second -> VerifyProgress -> IO ()