krank-0.2.3: Krank checks issue tracker link status in your source code
Safe HaskellNone
LanguageHaskell2010

Krank.Checkers.IssueTracker

Synopsis

Documentation

data GitIssueRef Source #

Constructors

GitIssueRef 

Fields

Instances

Instances details
Eq GitIssueRef Source # 
Instance details

Defined in Krank.Checkers.IssueTracker

Show GitIssueRef Source # 
Instance details

Defined in Krank.Checkers.IssueTracker

data GitServer Source #

Constructors

Github 
Gitlab GitlabHost 

Instances

Instances details
Eq GitServer Source # 
Instance details

Defined in Krank.Checkers.IssueTracker

Show GitServer Source # 
Instance details

Defined in Krank.Checkers.IssueTracker

data Localized t Source #

Represents a localized chunk of information in a file

Constructors

Localized 

Instances

Instances details
Eq t => Eq (Localized t) Source # 
Instance details

Defined in Krank.Types

Methods

(==) :: Localized t -> Localized t -> Bool #

(/=) :: Localized t -> Localized t -> Bool #

Show t => Show (Localized t) Source # 
Instance details

Defined in Krank.Types

extractIssues Source #

Arguments

:: FilePath

Path of the file

-> ByteString

Content of the file

-> [Localized GitIssueRef] 

Extract all issues correctly localized Note: we use ByteString internally. This way we do not have to care about the possible encoding of the input files. In programming world, we mostly use ascii variants. This gives a few performance improvement compared to initially converting everything to Text and search on it.

gitRepoRe :: Regex Source #

This regex represents a github/gitlab issue URL

extractIssuesOnALine :: ByteString -> [(Int, GitIssueRef)] Source #

Extract all issues on one line and returns a list of the raw text associated with an issue