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


-- | Generate checklists relevant to a given patch
--   
--   Generate checklists relevant to a given patch
@package checkmate
@version 0.4.0

module Checkmate.Range
data Range
Range :: Int -> Int -> Range
[rangeStartingLineNumber] :: Range -> Int
[rangeNumberOfLines] :: Range -> Int
rangesOverlap :: Range -> Range -> Bool

module Checkmate.Check
data Check
Check :: Scope -> Int -> Text -> Check
[checkScope] :: Check -> Scope
[checkOrderIndex] :: Check -> Int
[checkText] :: Check -> Text
type Checklist = Set Check
data Scope
FileBlock :: FilePath -> Range -> Scope
[scopePath] :: Scope -> FilePath
[scopeRange] :: Scope -> Range
Directory :: FilePath -> Scope
[scopePath] :: Scope -> FilePath

-- | <i>O(m*log(n/m + 1)), m &lt;= n</i>. The union of two sets, preferring
--   the first set when equal elements are encountered.
union :: Ord a => Set a -> Set a -> Set a
instance GHC.Show.Show Checkmate.Check.Check
instance GHC.Classes.Eq Checkmate.Check.Check
instance GHC.Show.Show Checkmate.Check.Scope
instance GHC.Classes.Ord Checkmate.Check.Check
instance GHC.Classes.Eq Checkmate.Check.Scope

module Checkmate.Parser.IndentBlock
type ParseError = ParseError Char Void
parser :: Parser Checklist
parseSourceCode :: FilePath -> Text -> Either ParseError Checklist
parseSourceFile :: FilePath -> IO (Either ParseError Checklist)
instance GHC.Show.Show Checkmate.Parser.IndentBlock.Line
instance GHC.Classes.Ord Checkmate.Parser.IndentBlock.Line
instance GHC.Classes.Eq Checkmate.Parser.IndentBlock.Line

module Checkmate.Parser.CheckFile
type ParseError = ParseError Char Void
parseCheckFile :: FilePath -> IO (Either ParseError Checklist)
parseCheckFileText :: FilePath -> Text -> Either ParseError Checklist
parser :: FilePath -> Parser Checklist

module Checkmate.Discover
type FileDeltas = [FileDelta]
discover :: FilePath -> FileDeltas -> IO Checklist
discoverDirectory :: FilePath -> FilePath -> IO Checklist
discoverFile :: FilePath -> FileDelta -> IO Checklist
parseDiff :: Text -> Either String FileDeltas

module Checkmate.Renderer
toCommonMark :: FilePath -> Int -> Checklist -> Text
toGFMarkdown :: FilePath -> Int -> Checklist -> Text

module Checkmate.Publisher.GitHub

-- | Errors have been tagged according to their source, so you can more
--   easily dispatch and handle them.
data Error

-- | A HTTP error occurred. The actual caught error is included.
HTTPError :: !HttpException -> Error

-- | An error in the parser itself.
ParseError :: !Text -> Error

-- | The JSON is malformed or unexpected.
JsonError :: !Text -> Error

-- | Incorrect input.
UserError :: !Text -> Error
type OwnerName = Name Owner
type PullRequestId = Id PullRequest
type RepoName = Name Repo
type Token = ByteString

-- | Data representing URLs in responses.
--   
--   <i>N.B.</i> syntactical validity is not verified.
newtype URL
URL :: Text -> URL
leaveComment :: Maybe OwnerName -> RepoName -> PullRequestId -> Token -> Maybe Text -> FilePath -> Checklist -> IO (Either Error (Maybe URL))
mkOwnerName :: Text -> OwnerName
mkPullRequestId :: Int -> PullRequestId
mkRepoName :: Text -> RepoName
pullRequestBaseSha :: Maybe OwnerName -> RepoName -> PullRequestId -> Token -> Maybe Text -> IO (Either Error Text)