Krank.Types

Documentation

newtype GithubKey

Constructors

GithubKey Text

Instances

Show GithubKey

Defined in Krank.Types

Methods

showsPrec :: Int -> GithubKey -> ShowS

show :: GithubKey -> String

showList :: [GithubKey] -> ShowS

newtype GitlabHost

Constructors

GitlabHost Text

Instances

Eq GitlabHost

Defined in Krank.Types

Methods

(==) :: GitlabHost -> GitlabHost -> Bool

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

Ord GitlabHost

Defined in Krank.Types

Methods

compare :: GitlabHost -> GitlabHost -> Ordering

(<) :: GitlabHost -> GitlabHost -> Bool

(<=) :: GitlabHost -> GitlabHost -> Bool

(>) :: GitlabHost -> GitlabHost -> Bool

(>=) :: GitlabHost -> GitlabHost -> Bool

max :: GitlabHost -> GitlabHost -> GitlabHost

min :: GitlabHost -> GitlabHost -> GitlabHost

Show GitlabHost

Defined in Krank.Types

Methods

showsPrec :: Int -> GitlabHost -> ShowS

show :: GitlabHost -> String

showList :: [GitlabHost] -> ShowS

newtype GitlabKey

Constructors

GitlabKey Text

Instances

Show GitlabKey

Defined in Krank.Types

Methods

showsPrec :: Int -> GitlabKey -> ShowS

show :: GitlabKey -> String

showList :: [GitlabKey] -> ShowS

data Violation

Constructors

Violation

Fields

• checker :: Text

  A textual representation of the checker. Most of the time that's the chunck of text parsed

• level :: ViolationLevel

  The ViolationLevel associated with the result

• message :: Text

  A message describing the error

• location :: SourcePos

  The position in the input sources of the chunck

Instances

Show Violation

Defined in Krank.Types

Methods

showsPrec :: Int -> Violation -> ShowS

show :: Violation -> String

showList :: [Violation] -> ShowS

data ViolationLevel

Constructors

Info

Warning

Error

Instances

Show ViolationLevel

Defined in Krank.Types

Methods

showsPrec :: Int -> ViolationLevel -> ShowS

show :: ViolationLevel -> String

showList :: [ViolationLevel] -> ShowS

data KrankConfig

Constructors

KrankConfig

Fields

• githubKey :: Maybe GithubKey

  The github oAuth token

• gitlabKeys :: Map GitlabHost GitlabKey

  The gitlab oAuth token

• dryRun :: Bool

  If True, all IO operations, such as HTTP requests, are ignored

• useColors :: Bool

  Use color for formatting

Instances

Show KrankConfig

Defined in Krank.Types

Methods

showsPrec :: Int -> KrankConfig -> ShowS

show :: KrankConfig -> String

showList :: [KrankConfig] -> ShowS

data SourcePos

Constructors

SourcePos

Fields

• file :: FilePath
• lineNumber :: Int
• colNumber :: Int

Instances

Eq SourcePos

Defined in Krank.Types

Methods

(==) :: SourcePos -> SourcePos -> Bool

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

Ord SourcePos

Defined in Krank.Types

Methods

compare :: SourcePos -> SourcePos -> Ordering

(<) :: SourcePos -> SourcePos -> Bool

(<=) :: SourcePos -> SourcePos -> Bool

(>) :: SourcePos -> SourcePos -> Bool

(>=) :: SourcePos -> SourcePos -> Bool

max :: SourcePos -> SourcePos -> SourcePos

min :: SourcePos -> SourcePos -> SourcePos

Show SourcePos

Defined in Krank.Types

Methods

showsPrec :: Int -> SourcePos -> ShowS

show :: SourcePos -> String

showList :: [SourcePos] -> ShowS

data Localized t

Represents a localized chunk of information in a file

Constructors

Localized

Fields

• getLocation :: SourcePos
• unLocalized :: t

Instances

Eq t => Eq (Localized t)

Defined in Krank.Types

Methods

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

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

Show t => Show (Localized t)

Defined in Krank.Types

Methods

showsPrec :: Int -> Localized t -> ShowS

show :: Localized t -> String

showList :: [Localized t] -> ShowS

class (Monad m, MonadCatch m) => MonadKrank m where

This monad represents all the effect that Krank needs

Minimal complete definition

krankRunRESTRequest, krankAsks, krankMapConcurrently, krankReadFile, krankPutStrLnStderr, krankPutStr

Methods

krankRunRESTRequest :: FromJSON t => Url Https -> Option Https -> m t

Run a REST requet

krankAsks :: (KrankConfig -> b) -> m b

Read the configuration

krankMapConcurrently :: (a -> m b) -> [a] -> m [b]

Apply a function on many item in a concurrent way

krankForConcurrently :: [a] -> (a -> m b) -> m [b]

krankReadFile :: FilePath -> m ByteString

Read a file from filesystem

krankPutStrLnStderr :: Text -> m ()

Log an error (with trailing n)

krankPutStr :: Text -> m ()

Log a message (without trailing n)

Instances

MonadKrank Krank

The real monad implementation for Krank

Defined in Krank

Methods

krankRunRESTRequest :: FromJSON t => Url Https -> Option Https -> Krank t

krankAsks :: (KrankConfig -> b) -> Krank b

krankMapConcurrently :: (a -> Krank b) -> [a] -> Krank [b]

krankForConcurrently :: [a] -> (a -> Krank b) -> Krank [b]

krankReadFile :: FilePath -> Krank ByteString

krankPutStrLnStderr :: Text -> Krank ()

krankPutStr :: Text -> Krank ()