ShellCheck.Interface

Documentation

newtype SystemInterface m

Constructors

SystemInterface

Fields

• siReadFile :: String -> m (Either ErrorMessage String)

data CheckSpec

Instances

Eq CheckSpec

Defined in ShellCheck.Interface

Methods

(==) :: CheckSpec -> CheckSpec -> Bool

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

Show CheckSpec

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> CheckSpec -> ShowS

show :: CheckSpec -> String

showList :: [CheckSpec] -> ShowS

data CheckResult

Instances

Eq CheckResult

Defined in ShellCheck.Interface

Methods

(==) :: CheckResult -> CheckResult -> Bool

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

Show CheckResult

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> CheckResult -> ShowS

show :: CheckResult -> String

showList :: [CheckResult] -> ShowS

data ParseSpec

Instances

Eq ParseSpec

Defined in ShellCheck.Interface

Methods

(==) :: ParseSpec -> ParseSpec -> Bool

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

Show ParseSpec

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> ParseSpec -> ShowS

show :: ParseSpec -> String

showList :: [ParseSpec] -> ShowS

data ParseResult

Instances

Eq ParseResult

Defined in ShellCheck.Interface

Methods

(==) :: ParseResult -> ParseResult -> Bool

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

Show ParseResult

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> ParseResult -> ShowS

show :: ParseResult -> String

showList :: [ParseResult] -> ShowS

data AnalysisSpec

data AnalysisResult

data FormatterOptions

data Shell

Constructors

Ksh

Sh

Bash

Dash

Instances

Eq Shell

Defined in ShellCheck.Interface

Methods

(==) :: Shell -> Shell -> Bool

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

Show Shell

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> Shell -> ShowS

show :: Shell -> String

showList :: [Shell] -> ShowS

data ExecutionMode

Constructors

Executed

Sourced

Instances

Eq ExecutionMode

Defined in ShellCheck.Interface

Methods

(==) :: ExecutionMode -> ExecutionMode -> Bool

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

Show ExecutionMode

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> ExecutionMode -> ShowS

show :: ExecutionMode -> String

showList :: [ExecutionMode] -> ShowS

type ErrorMessage = String

type Code = Integer

data Severity

Constructors

ErrorC

WarningC

InfoC

StyleC

Instances

Eq Severity

Defined in ShellCheck.Interface

Methods

(==) :: Severity -> Severity -> Bool

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

Ord Severity

Defined in ShellCheck.Interface

Methods

compare :: Severity -> Severity -> Ordering

(<) :: Severity -> Severity -> Bool

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

(>) :: Severity -> Severity -> Bool

(>=) :: Severity -> Severity -> Bool

max :: Severity -> Severity -> Severity

min :: Severity -> Severity -> Severity

Show Severity

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> Severity -> ShowS

show :: Severity -> String

showList :: [Severity] -> ShowS

data Position

Instances

Eq Position

Defined in ShellCheck.Interface

Methods

(==) :: Position -> Position -> Bool

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

Show Position

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

data Comment

Instances

Eq Comment

Defined in ShellCheck.Interface

Methods

(==) :: Comment -> Comment -> Bool

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

Show Comment

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

data PositionedComment

Instances

Eq PositionedComment

Defined in ShellCheck.Interface

Methods

(==) :: PositionedComment -> PositionedComment -> Bool

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

Show PositionedComment

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> PositionedComment -> ShowS

show :: PositionedComment -> String

showList :: [PositionedComment] -> ShowS

ToJSON PositionedComment

Defined in ShellCheck.Formatter.JSON

Methods

toJSON :: PositionedComment -> Value

toEncoding :: PositionedComment -> Encoding

toJSONList :: [PositionedComment] -> Value

toEncodingList :: [PositionedComment] -> Encoding

data ColorOption

Constructors

ColorAuto

ColorAlways

ColorNever

Instances

Eq ColorOption

Defined in ShellCheck.Interface

Methods

(==) :: ColorOption -> ColorOption -> Bool

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

Ord ColorOption

Defined in ShellCheck.Interface

Methods

compare :: ColorOption -> ColorOption -> Ordering

(<) :: ColorOption -> ColorOption -> Bool

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

(>) :: ColorOption -> ColorOption -> Bool

(>=) :: ColorOption -> ColorOption -> Bool

max :: ColorOption -> ColorOption -> ColorOption

min :: ColorOption -> ColorOption -> ColorOption

Show ColorOption

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> ColorOption -> ShowS

show :: ColorOption -> String

showList :: [ColorOption] -> ShowS

data TokenComment

Instances

Eq TokenComment

Defined in ShellCheck.Interface

Methods

(==) :: TokenComment -> TokenComment -> Bool

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

Show TokenComment

Defined in ShellCheck.Interface

Methods

showsPrec :: Int -> TokenComment -> ShowS

show :: TokenComment -> String

showList :: [TokenComment] -> ShowS

emptyCheckResult :: CheckResult

newParseResult :: ParseResult

newAnalysisSpec :: Token -> AnalysisSpec

newAnalysisResult :: AnalysisResult

newFormatterOptions :: FormatterOptions

newPosition :: Position

newTokenComment :: TokenComment

mockedSystemInterface :: [(String, String)] -> SystemInterface Identity

newParseSpec :: ParseSpec

emptyCheckSpec :: CheckSpec

newPositionedComment :: PositionedComment

newComment :: Comment