Safe Haskell	None
Language	Haskell2010

Krank.Checkers.IssueTracker

Synopsis

data GitIssue = GitIssue {
- server :: GitServer
- owner :: Text
- repo :: Text
- issueNum :: Int
}
data GitServer
- = Github
- | Gitlab GitlabHost
data Localized t = Localized {
- getLocation :: SourcePos
- unLocalized :: t
}
checkText :: MonadKrank m => FilePath -> ByteString -> m [Violation]
extractIssues :: FilePath -> ByteString -> [Localized GitIssue]
gitRepoRe :: Regex
serverDomain :: GitServer -> Text
extractIssuesOnALine :: ByteString -> [(Int, GitIssue)]

Documentation

data GitIssue Source #

Constructors

GitIssue
Fields server :: GitServer owner :: Text repo :: Text issueNum :: Int

Instances

Eq GitIssue Source #
Instance details Defined in Krank.Checkers.IssueTracker Methods (==) :: GitIssue -> GitIssue -> Bool # (/=) :: GitIssue -> GitIssue -> Bool #
Show GitIssue Source #
Instance details Defined in Krank.Checkers.IssueTracker Methods showsPrec :: Int -> GitIssue -> ShowS # show :: GitIssue -> String # showList :: [GitIssue] -> ShowS #

data GitServer Source #

Constructors

Github
Gitlab GitlabHost

Instances

Eq GitServer Source #
Instance details Defined in Krank.Checkers.IssueTracker Methods (==) :: GitServer -> GitServer -> Bool # (/=) :: GitServer -> GitServer -> Bool #
Show GitServer Source #
Instance details Defined in Krank.Checkers.IssueTracker Methods showsPrec :: Int -> GitServer -> ShowS # show :: GitServer -> String # showList :: [GitServer] -> ShowS #

data Localized t Source #

Represents a localized chunk of information in a file

Constructors

Localized
Fields getLocation :: SourcePos unLocalized :: t

Instances

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 Methods showsPrec :: Int -> Localized t -> ShowS # show :: Localized t -> String # showList :: [Localized t] -> ShowS #

checkText :: MonadKrank m => FilePath -> ByteString -> m [Violation] Source #

extractIssues Source #

Arguments

:: FilePath	Path of the file
-> ByteString	Content of the file
-> [Localized GitIssue]

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

serverDomain :: GitServer -> Text Source #

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

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