ShellCheck-0.10.0: Shell script analysis tool
Safe HaskellNone
LanguageHaskell98

ShellCheck.AnalyzerLib

Documentation

type Analysis = AnalyzerM () Source #

type AnalyzerM a = RWS Parameters [TokenComment] Cache a Source #

nullCheck :: b -> RWST Parameters [TokenComment] Cache Identity () Source #

data Checker Source #

Constructors

Checker 

Fields

Instances

Instances details
Monoid Checker Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

mempty :: Checker #

mappend :: Checker -> Checker -> Checker #

mconcat :: [Checker] -> Checker #

Semigroup Checker Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

(<>) :: Checker -> Checker -> Checker #

sconcat :: NonEmpty Checker -> Checker #

stimes :: Integral b => b -> Checker -> Checker #

runChecker :: Parameters -> Checker -> [TokenComment] Source #

composeAnalyzers :: (a -> Analysis) -> (a -> Analysis) -> a -> Analysis Source #

data Parameters Source #

Constructors

Parameters 

Fields

Instances

Instances details
Show Parameters Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

showsPrec :: Int -> Parameters -> ShowS #

show :: Parameters -> String #

showList :: [Parameters] -> ShowS #

data Cache Source #

Constructors

Cache 

data Scope Source #

Constructors

SubshellScope String 
NoneScope 

Instances

Instances details
Show Scope Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

showsPrec :: Int -> Scope -> ShowS #

show :: Scope -> String #

showList :: [Scope] -> ShowS #

Eq Scope Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

(==) :: Scope -> Scope -> Bool #

(/=) :: Scope -> Scope -> Bool #

data StackData Source #

Constructors

StackScope Scope 
StackScopeEnd 
Assignment (Token, Token, String, DataType) 
Reference (Token, Token, String) 

Instances

Instances details
Show StackData Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

showsPrec :: Int -> StackData -> ShowS #

show :: StackData -> String #

showList :: [StackData] -> ShowS #

data DataType Source #

Constructors

DataString DataSource 
DataArray DataSource 

Instances

Instances details
Show DataType Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

showsPrec :: Int -> DataType -> ShowS #

show :: DataType -> String #

showList :: [DataType] -> ShowS #

data DataSource Source #

Constructors

SourceFrom [Token] 
SourceExternal 
SourceDeclaration 
SourceInteger 
SourceChecked 

Instances

Instances details
Show DataSource Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

showsPrec :: Int -> DataSource -> ShowS #

show :: DataSource -> String #

showList :: [DataSource] -> ShowS #

data VariableState Source #

Constructors

Dead Token String 
Alive 

Instances

Instances details
Show VariableState Source # 
Instance details

Defined in ShellCheck.AnalyzerLib

Methods

showsPrec :: Int -> VariableState -> ShowS #

show :: VariableState -> String #

showList :: [VariableState] -> ShowS #

defaultSpec :: ParseResult -> AnalysisSpec Source #

pScript :: String -> ParseResult Source #

producesComments :: Checker -> String -> Maybe Bool Source #

makeComment :: Severity -> Id -> Code -> String -> TokenComment Source #

addComment :: (NFData a, MonadWriter [a] m) => a -> m () Source #

warn :: MonadWriter [TokenComment] m => Id -> Code -> String -> m () Source #

err :: MonadWriter [TokenComment] m => Id -> Code -> String -> m () Source #

info :: MonadWriter [TokenComment] m => Id -> Code -> String -> m () Source #

style :: MonadWriter [TokenComment] m => Id -> Code -> String -> m () Source #

errWithFix :: MonadWriter [TokenComment] m => Id -> Code -> String -> Fix -> m () Source #

warnWithFix :: MonadWriter [TokenComment] m => Id -> Code -> String -> Fix -> m () Source #

infoWithFix :: MonadWriter [TokenComment] m => Id -> Code -> String -> Fix -> m () Source #

styleWithFix :: MonadWriter [TokenComment] m => Id -> Code -> String -> Fix -> m () Source #

addCommentWithFix :: MonadWriter [TokenComment] m => Severity -> Id -> Code -> String -> Fix -> m () Source #

makeCommentWithFix :: Severity -> Id -> Code -> String -> Fix -> TokenComment Source #

makeParameters :: AnalysisSpec -> Parameters Source #

containsSetE :: Token -> Bool Source #

containsSetOption :: [Char] -> Token -> Bool Source #

containsShopt :: [Char] -> Token -> Bool Source #

isOptionSet :: [Char] -> Token -> Bool Source #

prop_determineShell0 :: Bool Source #

prop_determineShell1 :: Bool Source #

prop_determineShell2 :: Bool Source #

prop_determineShell3 :: Bool Source #

prop_determineShell4 :: Bool Source #

prop_determineShell5 :: Bool Source #

prop_determineShell6 :: Bool Source #

prop_determineShell7 :: Bool Source #

prop_determineShell8 :: Bool Source #

prop_determineShell9 :: Bool Source #

prop_determineShell10 :: Bool Source #

prop_determineShell11 :: Bool Source #

prop_determineShell12 :: Bool Source #

determineShellTest :: String -> Shell Source #

determineShellTest' :: Maybe Shell -> String -> Shell Source #

determineShell :: Maybe Shell -> Token -> Shell Source #

getParentTree :: Token -> Map Id Token Source #

getTokenMap :: Token -> Map Id Token Source #

isStrictlyQuoteFree :: Shell -> Map Id Token -> Token -> Bool Source #

isQuoteFree :: Shell -> Map Id Token -> Token -> Bool Source #

isQuoteFreeNode :: Bool -> Shell -> Map Id Token -> Token -> Bool Source #

isParamTo :: Map Id Token -> String -> Token -> Bool Source #

getClosestCommand :: Map Id Token -> Token -> Maybe Token Source #

getClosestCommandM :: MonadReader Parameters m => Token -> m (Maybe Token) Source #

usedAsCommandName :: Map Id Token -> Token -> Bool Source #

getPathM :: MonadReader Parameters m => Token -> m (NonEmpty Token) Source #

isParentOf :: Map Id Token -> Token -> Token -> Bool Source #

parents :: Parameters -> Token -> NonEmpty Token Source #

findFirst :: (a -> Maybe Bool) -> [a] -> Maybe a Source #

tokenIsJustCommandOutput :: Token -> Bool Source #

getVariableFlow :: Parameters -> Token -> [StackData] Source #

leadType :: Parameters -> Token -> Scope Source #

getModifiedVariables :: Token -> [(Token, Token, String, DataType)] Source #

getReferencedVariableCommand :: Token -> [(Token, Token, String)] Source #

getModifiedVariableCommand :: Token -> [(Token, Token, [Char], DataType)] Source #

getVariableForTestDashV :: Token -> Maybe String Source #

getReferencedVariables :: Map Id Token -> Token -> [(Token, Token, [Char])] Source #

isDereferencingBinaryOp :: String -> Bool Source #

dataTypeFrom :: (DataSource -> DataType) -> Token -> DataType Source #

isCommand :: Token -> String -> Bool Source #

isUnqualifiedCommand :: Token -> String -> Bool Source #

isCommandMatch :: Token -> (String -> Bool) -> Bool Source #

isConfusedGlobRegex :: String -> Bool Source #

getVariablesFromLiteralToken :: Token -> [String] Source #

prop_getVariablesFromLiteral1 :: Bool Source #

getVariablesFromLiteral :: String -> [String] Source #

whenShell :: (MonadReader Parameters m, Foldable t) => t Shell -> m () -> m () Source #

filterByAnnotation :: AnalysisSpec -> Parameters -> [TokenComment] -> [TokenComment] Source #

shouldIgnoreCode :: Parameters -> Integer -> Token -> Bool Source #

isCountingReference :: Token -> Bool Source #

isQuotedAlternativeReference :: Token -> Bool Source #

supportsArrays :: Shell -> Bool Source #

isBashLike :: Parameters -> Bool Source #

isTrueAssignmentSource :: DataType -> Bool Source #

modifiesVariable :: Parameters -> Token -> String -> Bool Source #

runTests :: IO Bool Source #