Safe Haskell	None
Language	Haskell2010

Chapelure.Types

Synopsis

data Diagnostic = Diagnostic {
- code :: Maybe Text
- severity :: Severity
- message :: Maybe DocText
- help :: Maybe DocText
- link :: Maybe Text
- snippets :: Maybe (NonEmptyVector Snippet)
}
data Severity
- = Info
- | Warning
- | Error
newtype Offset = Offset Word
newtype Line = Line Word
incrementLine :: Line -> Line
newtype Column = Column Word
incrementColumn :: Column -> Column
data Snippet = Snippet {
- location :: (Maybe Text, Line, Column)
- highlights :: Maybe (NonEmptyVector Highlight)
- content :: Vector DocText
}
data Highlight = Highlight {
- label :: Maybe DocText
- spans :: NonEmptyVector (Line, Column, Column)
}

Documentation

data Diagnostic Source #

Constructors

Diagnostic

Fields

code :: Maybe Text
Unique diagnostic code that be used to look up more information. Should be globally unique, and documented for easy searching.
severity :: Severity
Diagnostic severity, this may be used by the Report Handler to adapt the formatting of the diagnostic.
message :: Maybe DocText
A short description of the diagnostic. Rendered at the top.
help :: Maybe DocText
Additional free-form text for the poor bastard at the end of it all. Rendered at the bottom
link :: Maybe Text
Link to visit for a more detailed explanation. Can make use of the $sel:code:Diagnostic component.
snippets :: Maybe (NonEmptyVector Snippet)
Contextual snippet to provide relevant source data.

Instances

Instances details

Show Diagnostic Source #
Instance details Defined in Chapelure.Types Methods showsPrec :: Int -> Diagnostic -> ShowS # show :: Diagnostic -> String # showList :: [Diagnostic] -> ShowS #
Generic Diagnostic Source #
Instance details Defined in Chapelure.Types Associated Types type Rep Diagnostic :: Type -> Type # Methods from :: Diagnostic -> Rep Diagnostic x # to :: Rep Diagnostic x -> Diagnostic #
type Rep Diagnostic Source #
Instance details Defined in Chapelure.Types type Rep Diagnostic = D1 ('MetaData "Diagnostic" "Chapelure.Types" "chapelure-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Diagnostic" 'PrefixI 'True) ((S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Severity) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocText)))) :: (S1 ('MetaSel ('Just "help") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocText)) :: (S1 ('MetaSel ('Just "link") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snippets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmptyVector Snippet)))))))

data Severity Source #

Enum used to indicate the severity of a diagnostic. The Report Handlers will use this to adapt the formatting of the diagnostic.

Constructors

Info
Warning
Error

Instances

Instances details

Bounded Severity Source #
Instance details Defined in Chapelure.Types Methods minBound :: Severity # maxBound :: Severity #
Enum Severity Source #
Instance details Defined in Chapelure.Types Methods succ :: Severity -> Severity # pred :: Severity -> Severity # toEnum :: Int -> Severity # fromEnum :: Severity -> Int # enumFrom :: Severity -> [Severity] # enumFromThen :: Severity -> Severity -> [Severity] # enumFromTo :: Severity -> Severity -> [Severity] # enumFromThenTo :: Severity -> Severity -> Severity -> [Severity] #
Eq Severity Source #
Instance details Defined in Chapelure.Types Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #
Show Severity Source #
Instance details Defined in Chapelure.Types Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #
Display Severity Source #
Instance details Defined in Chapelure.Types Methods displayBuilder :: Severity -> Builder # displayList :: [Severity] -> Builder # displayPrec :: Int -> Severity -> Builder #

newtype Offset Source #

Wrapper to mark an offset from the beginning of a Highlight.

Constructors

Offset Word

Instances

Instances details

Enum Offset Source #
Instance details Defined in Chapelure.Types Methods succ :: Offset -> Offset # pred :: Offset -> Offset # toEnum :: Int -> Offset # fromEnum :: Offset -> Int # enumFrom :: Offset -> [Offset] # enumFromThen :: Offset -> Offset -> [Offset] # enumFromTo :: Offset -> Offset -> [Offset] # enumFromThenTo :: Offset -> Offset -> Offset -> [Offset] #
Eq Offset Source #
Instance details Defined in Chapelure.Types Methods (==) :: Offset -> Offset -> Bool # (/=) :: Offset -> Offset -> Bool #
Ord Offset Source #
Instance details Defined in Chapelure.Types Methods compare :: Offset -> Offset -> Ordering # (<) :: Offset -> Offset -> Bool # (<=) :: Offset -> Offset -> Bool # (>) :: Offset -> Offset -> Bool # (>=) :: Offset -> Offset -> Bool # max :: Offset -> Offset -> Offset # min :: Offset -> Offset -> Offset #
Show Offset Source #
Instance details Defined in Chapelure.Types Methods showsPrec :: Int -> Offset -> ShowS # show :: Offset -> String # showList :: [Offset] -> ShowS #
Generic Offset Source #
Instance details Defined in Chapelure.Types Associated Types type Rep Offset :: Type -> Type # Methods from :: Offset -> Rep Offset x # to :: Rep Offset x -> Offset #
Pretty Offset Source #
Instance details Defined in Chapelure.Types Methods pretty :: Offset -> Doc ann # prettyList :: [Offset] -> Doc ann #
type Rep Offset Source #
Instance details Defined in Chapelure.Types type Rep Offset = D1 ('MetaData "Offset" "Chapelure.Types" "chapelure-0.0.1.0-inplace" 'True) (C1 ('MetaCons "Offset" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

newtype Line Source #

Wrapper that represents a line in a Diagnostic report

Constructors

Line Word

Instances

Instances details

Enum Line Source #
Instance details Defined in Chapelure.Types Methods succ :: Line -> Line # pred :: Line -> Line # toEnum :: Int -> Line # fromEnum :: Line -> Int # enumFrom :: Line -> [Line] # enumFromThen :: Line -> Line -> [Line] # enumFromTo :: Line -> Line -> [Line] # enumFromThenTo :: Line -> Line -> Line -> [Line] #
Eq Line Source #
Instance details Defined in Chapelure.Types Methods (==) :: Line -> Line -> Bool # (/=) :: Line -> Line -> Bool #
Ord Line Source #
Instance details Defined in Chapelure.Types Methods compare :: Line -> Line -> Ordering # (<) :: Line -> Line -> Bool # (<=) :: Line -> Line -> Bool # (>) :: Line -> Line -> Bool # (>=) :: Line -> Line -> Bool # max :: Line -> Line -> Line # min :: Line -> Line -> Line #
Show Line Source #
Instance details Defined in Chapelure.Types Methods showsPrec :: Int -> Line -> ShowS # show :: Line -> String # showList :: [Line] -> ShowS #
Generic Line Source #
Instance details Defined in Chapelure.Types Associated Types type Rep Line :: Type -> Type # Methods from :: Line -> Rep Line x # to :: Rep Line x -> Line #
Pretty Line Source #
Instance details Defined in Chapelure.Types Methods pretty :: Line -> Doc ann # prettyList :: [Line] -> Doc ann #
Display Line Source #
Instance details Defined in Chapelure.Types Methods displayBuilder :: Line -> Builder # displayList :: [Line] -> Builder # displayPrec :: Int -> Line -> Builder #
type Rep Line Source #
Instance details Defined in Chapelure.Types type Rep Line = D1 ('MetaData "Line" "Chapelure.Types" "chapelure-0.0.1.0-inplace" 'True) (C1 ('MetaCons "Line" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

incrementLine :: Line -> Line Source #

newtype Column Source #

Wrapper that represents a column in a Diagnostic report

Constructors

Column Word

Instances

Instances details

Enum Column Source #
Instance details Defined in Chapelure.Types Methods succ :: Column -> Column # pred :: Column -> Column # toEnum :: Int -> Column # fromEnum :: Column -> Int # enumFrom :: Column -> [Column] # enumFromThen :: Column -> Column -> [Column] # enumFromTo :: Column -> Column -> [Column] # enumFromThenTo :: Column -> Column -> Column -> [Column] #
Eq Column Source #
Instance details Defined in Chapelure.Types Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Ord Column Source #
Instance details Defined in Chapelure.Types Methods compare :: Column -> Column -> Ordering # (<) :: Column -> Column -> Bool # (<=) :: Column -> Column -> Bool # (>) :: Column -> Column -> Bool # (>=) :: Column -> Column -> Bool # max :: Column -> Column -> Column # min :: Column -> Column -> Column #
Show Column Source #
Instance details Defined in Chapelure.Types Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #
Generic Column Source #
Instance details Defined in Chapelure.Types Associated Types type Rep Column :: Type -> Type # Methods from :: Column -> Rep Column x # to :: Rep Column x -> Column #
Pretty Column Source #
Instance details Defined in Chapelure.Types Methods pretty :: Column -> Doc ann # prettyList :: [Column] -> Doc ann #
Display Column Source #
Instance details Defined in Chapelure.Types Methods displayBuilder :: Column -> Builder # displayList :: [Column] -> Builder # displayPrec :: Int -> Column -> Builder #
type Rep Column Source #
Instance details Defined in Chapelure.Types type Rep Column = D1 ('MetaData "Column" "Chapelure.Types" "chapelure-0.0.1.0-inplace" 'True) (C1 ('MetaCons "Column" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

incrementColumn :: Column -> Column Source #

data Snippet Source #

A datatype holding a message, some source data and a span to highlight.

Constructors

Snippet
Fields location :: (Maybe Text, Line, Column) A location name (filename or other), and the line and columns at which the snippet starts. highlights :: Maybe (NonEmptyVector Highlight) Highlights of the source that are of interest content :: Vector DocText Subject that is being reported. Each member is a line.

Instances

Instances details

Show Snippet Source #
Instance details Defined in Chapelure.Types Methods showsPrec :: Int -> Snippet -> ShowS # show :: Snippet -> String # showList :: [Snippet] -> ShowS #
Generic Snippet Source #
Instance details Defined in Chapelure.Types Associated Types type Rep Snippet :: Type -> Type # Methods from :: Snippet -> Rep Snippet x # to :: Rep Snippet x -> Snippet #
type Rep Snippet Source #
Instance details Defined in Chapelure.Types type Rep Snippet = D1 ('MetaData "Snippet" "Chapelure.Types" "chapelure-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Snippet" 'PrefixI 'True) (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text, Line, Column)) :: (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmptyVector Highlight))) :: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector DocText)))))

data Highlight Source #

A piece of source data that is shown when reporting an error. Pointers on a source are always on a single line.

Constructors

Highlight
Fields label :: Maybe DocText An optional label for the highlight spans :: NonEmptyVector (Line, Column, Column) Where the highlight is

Instances

Instances details

Show Highlight Source #
Instance details Defined in Chapelure.Types Methods showsPrec :: Int -> Highlight -> ShowS # show :: Highlight -> String # showList :: [Highlight] -> ShowS #
Generic Highlight Source #
Instance details Defined in Chapelure.Types Associated Types type Rep Highlight :: Type -> Type # Methods from :: Highlight -> Rep Highlight x # to :: Rep Highlight x -> Highlight #
type Rep Highlight Source #
Instance details Defined in Chapelure.Types type Rep Highlight = D1 ('MetaData "Highlight" "Chapelure.Types" "chapelure-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Highlight" 'PrefixI 'True) (S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocText)) :*: S1 ('MetaSel ('Just "spans") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmptyVector (Line, Column, Column)))))