-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Krank checks your code source comments for important markers
--   
--   Comments are part of our code and are not usually tested correctly.
--   Hence their content can become incoherent or obsolete. Krank tries to
--   avoid that by running checkers on the comment themselves.
@package krank
@version 0.1.0

module Krank.Types
newtype GithubKey
GithubKey :: String -> GithubKey
data Violation
Violation :: Text -> ViolationLevel -> Text -> Text -> SourcePos -> Violation
[checker] :: Violation -> Text
[level] :: Violation -> ViolationLevel
[snippet] :: Violation -> Text
[message] :: Violation -> Text
[location] :: Violation -> SourcePos
data ViolationLevel
Info :: ViolationLevel
Warning :: ViolationLevel
Error :: ViolationLevel
data KrankConfig
KrankConfig :: Maybe GithubKey -> Bool -> KrankConfig
[githubKey] :: KrankConfig -> Maybe GithubKey
[dryRun] :: KrankConfig -> Bool
instance GHC.Show.Show Krank.Types.Violation
instance GHC.Show.Show Krank.Types.ViolationLevel

module Krank.Formatter
showViolations :: [Violation] -> Text

module Krank.Checkers.IssueTracker
data GitIssue
GitIssue :: GitServer -> Text -> Text -> Int -> GitIssue
[$sel:server:GitIssue] :: GitIssue -> GitServer
[$sel:owner:GitIssue] :: GitIssue -> Text
[$sel:repo:GitIssue] :: GitIssue -> Text
[$sel:issueNum:GitIssue] :: GitIssue -> Int
data GitServer
Github :: GitServer

-- | Represents a localized chunk of information in a file
data Localized t
Localized :: SourcePos -> t -> Localized t
[$sel:location:Localized] :: Localized t -> SourcePos
[$sel:unLocalized:Localized] :: Localized t -> t
checkText :: FilePath -> String -> ReaderT KrankConfig IO [Violation]
extractIssues :: FilePath -> String -> [Localized GitIssue]
githubRE :: Parser GitIssue
gitRepoRE :: GitServer -> Parser GitIssue
instance GHC.Show.Show Krank.Checkers.IssueTracker.GitIssueWithStatus
instance GHC.Classes.Eq Krank.Checkers.IssueTracker.GitIssueWithStatus
instance GHC.Show.Show Krank.Checkers.IssueTracker.GitIssue
instance GHC.Classes.Eq Krank.Checkers.IssueTracker.GitIssue
instance GHC.Classes.Eq t => GHC.Classes.Eq (Krank.Checkers.IssueTracker.Localized t)
instance GHC.Show.Show t => GHC.Show.Show (Krank.Checkers.IssueTracker.Localized t)
instance GHC.Show.Show Krank.Checkers.IssueTracker.IssueStatus
instance GHC.Classes.Eq Krank.Checkers.IssueTracker.IssueStatus
instance GHC.Show.Show Krank.Checkers.IssueTracker.GitServer
instance GHC.Classes.Eq Krank.Checkers.IssueTracker.GitServer

module Krank
processFile :: FilePath -> ReaderT KrankConfig IO [Violation]