Servant.Lint

Documentation

lintAPI :: forall api. Lintable api => IO ()

Pass your API type for lint errors thrown in IO This is typically useful for testing

lintAPI' :: forall api. Lintable api => [Error]

Pass your API type for lint errors as Chunks Chunks are colored terminal bits from Text.Colour for making pretty errors.

printLintAPI :: forall api. Lintable api => IO ()

Pass your API type for lint via putStrLn in stdout

newtype Error

Pretty errors via Text.Colour

Constructors

Error

Fields

• toChunks :: [[Chunk]]

Instances

Monoid Error

Defined in Servant.Lint

Methods

mempty :: Error

mappend :: Error -> Error -> Error

mconcat :: [Error] -> Error

Semigroup Error

Defined in Servant.Lint

Methods

(<>) :: Error -> Error -> Error

sconcat :: NonEmpty Error -> Error

stimes :: Integral b => b -> Error -> Error

Show Error

Defined in Servant.Lint

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Eq Error

Defined in Servant.Lint

Methods

(==) :: Error -> Error -> Bool

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

data Path

A term level representation of the API Its defined recursive to flatten the API to a list of routes instead of a tree

Constructors

PPath String !Path

PCapture String TypeRep !Path

PCaptureAll String TypeRep !Path

PQueryParam String TypeRep !Path

PQueryParams String TypeRep !Path

PReqBody TypeRep !Path

PVerb ByteString Integer TypeRep

Instances

Show Path

Defined in Servant.Lint

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

Eq Path

Defined in Servant.Lint

Methods

(==) :: Path -> Path -> Bool

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

Ord Path

Defined in Servant.Lint

Methods

compare :: Path -> Path -> Ordering

(<) :: Path -> Path -> Bool

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

(>) :: Path -> Path -> Bool

(>=) :: Path -> Path -> Bool

max :: Path -> Path -> Path

min :: Path -> Path -> Path

class Lintable a where

The Lintable type class describes how to go from a Servant Combinator to a Path This is essentially a function from `Type -> [Path]` If you have custom Servant Combinators you may need to add an instance of Lintable for your Combinator, typically ignoring the custom Combinator.

Methods

paths :: [Path]

Instances

(Lintable a, Lintable b) => Lintable (a :<|> b)

Defined in Servant.Lint

Methods

paths :: [Path]

ReflectMethod method => Lintable (NoContentVerb method)

Defined in Servant.Lint

Methods

paths :: [Path]

(KnownSymbol a, Lintable b) => Lintable (a :> b)

Defined in Servant.Lint

Methods

paths :: [Path]

(Lintable b, KnownSymbol hint, Typeable a) => Lintable (Capture' _mods hint a :> b)

Defined in Servant.Lint

Methods

paths :: [Path]

(Lintable b, KnownSymbol hint, Typeable a) => Lintable (CaptureAll hint a :> b)

Defined in Servant.Lint

Methods

paths :: [Path]

(Lintable b, KnownSymbol hint, Typeable a) => Lintable (QueryParam hint a :> b)

Defined in Servant.Lint

Methods

paths :: [Path]

(Lintable b, KnownSymbol hint, Typeable a) => Lintable (QueryParams hint a :> b)

Defined in Servant.Lint

Methods

paths :: [Path]

(Lintable b, Typeable a) => Lintable (ReqBody' _mods _ms a :> b)

Defined in Servant.Lint

Methods

paths :: [Path]

(Typeable ret, ReflectMethod method, KnownNat code) => Lintable (Verb method code _cs ret)

Defined in Servant.Lint

Methods

paths :: [Path]

data Ambiguity

This is a striped down version of the Path focusing on removing details that ambiguate routes

Constructors

ACapture

ACaptureAll

AQueryParam String

APath String

AReqBody

AVerb ByteString Integer

Instances

Generic Ambiguity

Defined in Servant.Lint

Associated Types

type Rep Ambiguity :: Type -> Type

Methods

from :: Ambiguity -> Rep Ambiguity x

to :: Rep Ambiguity x -> Ambiguity

Show Ambiguity

Defined in Servant.Lint

Methods

showsPrec :: Int -> Ambiguity -> ShowS

show :: Ambiguity -> String

showList :: [Ambiguity] -> ShowS

Eq Ambiguity

Defined in Servant.Lint

Methods

(==) :: Ambiguity -> Ambiguity -> Bool

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

Ord Ambiguity

Defined in Servant.Lint

Methods

compare :: Ambiguity -> Ambiguity -> Ordering

(<) :: Ambiguity -> Ambiguity -> Bool

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

(>) :: Ambiguity -> Ambiguity -> Bool

(>=) :: Ambiguity -> Ambiguity -> Bool

max :: Ambiguity -> Ambiguity -> Ambiguity

min :: Ambiguity -> Ambiguity -> Ambiguity

type Rep Ambiguity

Defined in Servant.Lint

type Rep Ambiguity = D1 ('MetaData "Ambiguity" "Servant.Lint" "servant-lint-0.1.0.0-inplace" 'False) ((C1 ('MetaCons "ACapture" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ACaptureAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AQueryParam" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))) :+: (C1 ('MetaCons "APath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: (C1 ('MetaCons "AReqBody" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AVerb" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))))

unlinesChunks :: [[Chunk]] -> [Chunk]

Exported for testing only