ShellCheck-0.4.4: Shell script analysis tool

Safe Haskell	None
Language	Haskell98

ShellCheck.Interface

Documentation

data SystemInterface m Source

Constructors

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

data CheckSpec Source

Constructors

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

Instances

Eq CheckSpec Source
Show CheckSpec Source

data CheckResult Source

Constructors

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

Instances

Eq CheckResult Source
Show CheckResult Source

emptyCheckSpec :: CheckSpec Source

data ParseSpec Source

Constructors

ParseSpec
Fields psFilename :: String psScript :: String

Instances

Eq ParseSpec Source
Show ParseSpec Source

data ParseResult Source

Constructors

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

Instances

Eq ParseResult Source
Show ParseResult Source

data AnalysisSpec Source

Constructors

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

data AnalysisResult Source

Constructors

AnalysisResult
Fields arComments :: [TokenComment]

data FormatterOptions Source

Constructors

FormatterOptions
Fields foColorOption :: ColorOption

data Shell Source

Constructors

Ksh
Sh
Bash
Dash

Instances

Eq Shell Source
Show Shell Source

data ExecutionMode Source

Constructors

Executed
Sourced

Instances

Eq ExecutionMode Source
Show ExecutionMode Source

type ErrorMessage = String Source

type Code = Integer Source

data Severity Source

Constructors

ErrorC
WarningC
InfoC
StyleC

Instances

Eq Severity Source
Ord Severity Source
Show Severity Source

data Position Source

Constructors

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

Instances

Eq Position Source
Show Position Source

data Comment Source

Constructors

Comment Severity Code String

Instances

Eq Comment Source
Show Comment Source

data PositionedComment Source

Constructors

PositionedComment Position Comment

Instances

Eq PositionedComment Source
Show PositionedComment Source

data TokenComment Source

Constructors

TokenComment Id Comment

Instances

Eq TokenComment Source
Show TokenComment Source

data ColorOption Source

Constructors

ColorAuto
ColorAlways
ColorNever

Instances

Eq ColorOption Source
Ord ColorOption Source
Show ColorOption Source

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