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
Show CheckSpec

data CheckResult Source

Constructors

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

Instances

Eq CheckResult
Show CheckResult

emptyCheckSpec :: CheckSpec Source

data ParseSpec Source

Constructors

ParseSpec
Fields psFilename :: String psScript :: String

Instances

Eq ParseSpec
Show ParseSpec

data ParseResult Source

Constructors

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

Instances

Eq ParseResult
Show ParseResult

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

Eq Shell
Show Shell

data ExecutionMode Source

Constructors

Executed
Sourced

Instances

Eq ExecutionMode
Show ExecutionMode

type ErrorMessage = String Source

type Code = Integer Source

data Severity Source

Constructors

ErrorC
WarningC
InfoC
StyleC

Instances

Eq Severity
Ord Severity
Show Severity

data Position Source

Constructors

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

Instances

Eq Position
Show Position

data Comment Source

Constructors

Comment Severity Code String

Instances

Eq Comment
Show Comment

data PositionedComment Source

Constructors

PositionedComment Position Comment

Instances

Eq PositionedComment
Show PositionedComment
JSON PositionedComment

data TokenComment Source

Constructors

TokenComment Id Comment

Instances

Eq TokenComment
Show TokenComment

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