Safe Haskell	None
Language	Haskell98

ShellCheck.Interface

Documentation

newtype SystemInterface m Source #

Constructors

SystemInterface
Fields siReadFile :: String -> m (Either ErrorMessage String)

data CheckSpec Source #

Constructors

CheckSpec
Fields csFilename :: String csScript :: String csCheckSourced :: Bool csExcludedWarnings :: [Integer] csShellTypeOverride :: Maybe Shell

Instances

Eq CheckSpec Source #
Methods (==) :: CheckSpec -> CheckSpec -> Bool # (/=) :: CheckSpec -> CheckSpec -> Bool #
Show CheckSpec Source #
Methods showsPrec :: Int -> CheckSpec -> ShowS # show :: CheckSpec -> String # showList :: [CheckSpec] -> ShowS #

data CheckResult Source #

Constructors

CheckResult
Fields crFilename :: String crComments :: [PositionedComment]

Instances

Eq CheckResult Source #
Methods (==) :: CheckResult -> CheckResult -> Bool # (/=) :: CheckResult -> CheckResult -> Bool #
Show CheckResult Source #
Methods showsPrec :: Int -> CheckResult -> ShowS # show :: CheckResult -> String # showList :: [CheckResult] -> ShowS #

emptyCheckSpec :: CheckSpec Source #

data ParseSpec Source #

Constructors

ParseSpec
Fields psFilename :: String psScript :: String psCheckSourced :: Bool

Instances

Eq ParseSpec Source #
Methods (==) :: ParseSpec -> ParseSpec -> Bool # (/=) :: ParseSpec -> ParseSpec -> Bool #
Show ParseSpec Source #
Methods showsPrec :: Int -> ParseSpec -> ShowS # show :: ParseSpec -> String # showList :: [ParseSpec] -> ShowS #

data ParseResult Source #

Constructors

ParseResult
Fields prComments :: [PositionedComment] prTokenPositions :: Map Id Position prRoot :: Maybe Token

Instances

Eq ParseResult Source #
Methods (==) :: ParseResult -> ParseResult -> Bool # (/=) :: ParseResult -> ParseResult -> Bool #
Show ParseResult Source #
Methods showsPrec :: Int -> ParseResult -> ShowS # show :: ParseResult -> String # showList :: [ParseResult] -> ShowS #

data AnalysisSpec Source #

Constructors

AnalysisSpec
Fields asScript :: Token asShellType :: Maybe Shell asExecutionMode :: ExecutionMode asCheckSourced :: Bool

newtype AnalysisResult Source #

Constructors

AnalysisResult
Fields arComments :: [TokenComment]

newtype FormatterOptions Source #

Constructors

FormatterOptions
Fields foColorOption :: ColorOption

data Shell Source #

Constructors

Ksh
Sh
Bash
Dash

Instances

Eq Shell Source #
Methods (==) :: Shell -> Shell -> Bool # (/=) :: Shell -> Shell -> Bool #
Show Shell Source #
Methods showsPrec :: Int -> Shell -> ShowS # show :: Shell -> String # showList :: [Shell] -> ShowS #

data ExecutionMode Source #

Constructors

Executed
Sourced

Instances

Eq ExecutionMode Source #
Methods (==) :: ExecutionMode -> ExecutionMode -> Bool # (/=) :: ExecutionMode -> ExecutionMode -> Bool #
Show ExecutionMode Source #
Methods showsPrec :: Int -> ExecutionMode -> ShowS # show :: ExecutionMode -> String # showList :: [ExecutionMode] -> ShowS #

type ErrorMessage = String Source #

type Code = Integer Source #

data Severity Source #

Constructors

ErrorC
WarningC
InfoC
StyleC

Instances

Eq Severity Source #
Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #
Ord Severity Source #
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 Source #
Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #

data Position Source #

Constructors

Position
Fields posFile :: String posLine :: Integer posColumn :: Integer

Instances

Eq Position Source #
Methods (==) :: Position -> Position -> Bool # (/=) :: Position -> Position -> Bool #
Show Position Source #
Methods showsPrec :: Int -> Position -> ShowS # show :: Position -> String # showList :: [Position] -> ShowS #

data Comment Source #

Constructors

Comment Severity Code String

Instances

Eq Comment Source #
Methods (==) :: Comment -> Comment -> Bool # (/=) :: Comment -> Comment -> Bool #
Show Comment Source #
Methods showsPrec :: Int -> Comment -> ShowS # show :: Comment -> String # showList :: [Comment] -> ShowS #

data PositionedComment Source #

Constructors

PositionedComment Position Position Comment

Instances

Eq PositionedComment Source #
Methods (==) :: PositionedComment -> PositionedComment -> Bool # (/=) :: PositionedComment -> PositionedComment -> Bool #
Show PositionedComment Source #
Methods showsPrec :: Int -> PositionedComment -> ShowS # show :: PositionedComment -> String # showList :: [PositionedComment] -> ShowS #

data TokenComment Source #

Constructors

TokenComment Id Comment

Instances

Eq TokenComment Source #
Methods (==) :: TokenComment -> TokenComment -> Bool # (/=) :: TokenComment -> TokenComment -> Bool #
Show TokenComment Source #
Methods showsPrec :: Int -> TokenComment -> ShowS # show :: TokenComment -> String # showList :: [TokenComment] -> ShowS #

data ColorOption Source #

Constructors

ColorAuto
ColorAlways
ColorNever

Instances

Eq ColorOption Source #
Methods (==) :: ColorOption -> ColorOption -> Bool # (/=) :: ColorOption -> ColorOption -> Bool #
Ord ColorOption Source #
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 Source #
Methods showsPrec :: Int -> ColorOption -> ShowS # show :: ColorOption -> String # showList :: [ColorOption] -> ShowS #

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