Xrefcheck.Core

Various primitives.

Documentation

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 (Maybe Text)

Instances

Show Position

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Generic Position

Defined in Xrefcheck.Core

Associated Types

type Rep Position :: Type -> Type

Methods

from :: Position -> Rep Position x

to :: Rep Position x -> Position

NFData Position

Defined in Xrefcheck.Core

Methods

rnf :: Position -> ()

Buildable Position

Defined in Xrefcheck.Core

Methods

build :: Position -> Builder

type Rep Position

Defined in Xrefcheck.Core

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

data Reference

Full info about a reference.

Constructors

Reference

Fields

• rName :: Text

  Text displayed as reference.

• rLink :: Text

  File or site reference points to.

• rAnchor :: Maybe Text

  Section or custom anchor tag.

• rPos :: Position

Instances

Show Reference

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> Reference -> ShowS

show :: Reference -> String

showList :: [Reference] -> ShowS

Generic Reference

Defined in Xrefcheck.Core

Associated Types

type Rep Reference :: Type -> Type

Methods

from :: Reference -> Rep Reference x

to :: Rep Reference x -> Reference

NFData Reference

Defined in Xrefcheck.Core

Methods

rnf :: Reference -> ()

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.1.3-F53rXbYHjewJ5mYL7etcgU" 'False) (C1 ('MetaCons "Reference" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "rAnchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rPos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Position))))

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

Eq AnchorType

Defined in Xrefcheck.Core

Methods

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

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

Show AnchorType

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> AnchorType -> ShowS

show :: AnchorType -> String

showList :: [AnchorType] -> ShowS

Generic AnchorType

Defined in Xrefcheck.Core

Associated Types

type Rep AnchorType :: Type -> Type

Methods

from :: AnchorType -> Rep AnchorType x

to :: Rep AnchorType x -> AnchorType

NFData AnchorType

Defined in Xrefcheck.Core

Methods

rnf :: AnchorType -> ()

Buildable AnchorType

Defined in Xrefcheck.Core

Methods

build :: AnchorType -> Builder

type Rep AnchorType

Defined in Xrefcheck.Core

type Rep AnchorType = D1 ('MetaData "AnchorType" "Xrefcheck.Core" "xrefcheck-0.1.3-F53rXbYHjewJ5mYL7etcgU" '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

Show Anchor

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> Anchor -> ShowS

show :: Anchor -> String

showList :: [Anchor] -> ShowS

Generic Anchor

Defined in Xrefcheck.Core

Associated Types

type Rep Anchor :: Type -> Type

Methods

from :: Anchor -> Rep Anchor x

to :: Rep Anchor x -> Anchor

NFData Anchor

Defined in Xrefcheck.Core

Methods

rnf :: Anchor -> ()

Buildable Anchor

Defined in Xrefcheck.Core

Methods

build :: Anchor -> Builder

type Rep Anchor

Defined in Xrefcheck.Core

type Rep Anchor = D1 ('MetaData "Anchor" "Xrefcheck.Core" "xrefcheck-0.1.3-F53rXbYHjewJ5mYL7etcgU" '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 FileInfo

All information regarding a single file we care about.

Constructors

FileInfo

Fields

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

Instances

Show FileInfo

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> FileInfo -> ShowS

show :: FileInfo -> String

showList :: [FileInfo] -> ShowS

Generic FileInfo

Defined in Xrefcheck.Core

Associated Types

type Rep FileInfo :: Type -> Type

Methods

from :: FileInfo -> Rep FileInfo x

to :: Rep FileInfo x -> FileInfo

NFData FileInfo

Defined in Xrefcheck.Core

Methods

rnf :: FileInfo -> ()

Default FileInfo

Defined in Xrefcheck.Core

Methods

def :: FileInfo

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.1.3-F53rXbYHjewJ5mYL7etcgU" '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]

newtype RepoInfo

Constructors

RepoInfo (Map FilePath FileInfo)

Instances

Show RepoInfo

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> RepoInfo -> ShowS

show :: RepoInfo -> String

showList :: [RepoInfo] -> ShowS

Buildable RepoInfo

Defined in Xrefcheck.Core

Methods

build :: RepoInfo -> Builder

finaliseFileInfo :: FileInfo -> FileInfo

pattern PathSep :: Char

data LocationType

Type of reference.

Constructors

LocalLoc

Reference on this file

RelativeLoc

Reference to a file relative to given one

AbsoluteLoc

Reference to a file relative to the root

ExternalLoc

Reference to a file at outer site

OtherLoc

Entry not to be processed (e.g. "mailto:e-mail")

Instances

Show LocationType

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> LocationType -> ShowS

show :: LocationType -> String

showList :: [LocationType] -> ShowS

Buildable LocationType

Defined in Xrefcheck.Core

Methods

build :: LocationType -> Builder

isExternal :: LocationType -> Bool

Whether this is a link to external resource.

isLocal :: LocationType -> Bool

Whether this is a link to repo-local resource.

locationType :: Text -> LocationType

Get type of reference.

data VerifyMode

Which parts of verification do we perform.

Constructors

LocalOnlyMode

ExternalOnlyMode

FullMode

shouldCheckLocal :: VerifyMode -> Bool

shouldCheckExternal :: VerifyMode -> Bool

headerToAnchor :: 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.

canonizeLocalRef :: Text -> Text

Strip ./ prefix from local references.

data VerifyProgress

Constructors

VerifyProgress

Fields

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

Instances

Show VerifyProgress

Defined in Xrefcheck.Core

Methods

showsPrec :: Int -> VerifyProgress -> ShowS

show :: VerifyProgress -> String

showList :: [VerifyProgress] -> ShowS

initVerifyProgress :: [Reference] -> VerifyProgress

showAnalyseProgress :: VerifyMode -> VerifyProgress -> Text

reprintAnalyseProgress :: Rewrite -> VerifyMode -> VerifyProgress -> IO ()