ShellCheck-0.4.1: Shell script analysis tool

Safe HaskellNone
LanguageHaskell98

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

data CheckResult Source

Constructors

CheckResult 

Fields

crFilename :: String
 
crComments :: [PositionedComment]
 

Instances

emptyCheckSpec :: CheckSpec Source

data ParseSpec Source

Constructors

ParseSpec 

Fields

psFilename :: String
 
psScript :: String
 

Instances

data ParseResult Source

Constructors

ParseResult 

Fields

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

Instances

data AnalysisSpec Source

Constructors

AnalysisSpec 

Fields

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

data AnalysisResult Source

Constructors

AnalysisResult 

Fields

arComments :: [TokenComment]
 

data Shell Source

Constructors

Ksh 
Sh 
Bash 

Instances

data ExecutionMode Source

Constructors

Executed 
Sourced 

Instances

type ErrorMessage = String Source

type Code = Integer Source

data Severity Source

Constructors

ErrorC 
WarningC 
InfoC 
StyleC 

Instances

data Position Source

Constructors

Position 

Fields

posFile :: String
 
posLine :: Integer
 
posColumn :: Integer
 

Instances

data Comment Source

Constructors

Comment Severity Code String 

Instances

data PositionedComment Source

Constructors

PositionedComment Position Comment 

Instances

data TokenComment Source

Constructors

TokenComment Id Comment 

Instances

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