ShellCheck-0.4.5: Shell script analysis tool

Safe Haskell	None
Language	Haskell98

ShellCheck.AnalyzerLib

Documentation

type Analysis = ReaderT Parameters (Writer [TokenComment]) () Source #

data Parameters Source #

Constructors

Parameters
Fields variableFlow :: [StackData] parentMap :: Map Id Token shellType :: Shell shellTypeSpecified :: Bool

data Scope Source #

Constructors

SubshellScope String
NoneScope

Instances

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

data StackData Source #

Constructors

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

Instances

Show StackData Source #
Methods showsPrec :: Int -> StackData -> ShowS # show :: StackData -> String # showList :: [StackData] -> ShowS #

data DataType Source #

Constructors

DataString DataSource
DataArray DataSource

Instances

Show DataType Source #
Methods showsPrec :: Int -> DataType -> ShowS # show :: DataType -> String # showList :: [DataType] -> ShowS #

data DataSource Source #

Constructors

SourceFrom [Token]
SourceExternal
SourceDeclaration
SourceInteger

Instances

Show DataSource Source #
Methods showsPrec :: Int -> DataSource -> ShowS # show :: DataSource -> String # showList :: [DataSource] -> ShowS #

data VariableState Source #

Constructors

Dead Token String
Alive

Instances

Show VariableState Source #
Methods showsPrec :: Int -> VariableState -> ShowS # show :: VariableState -> String # showList :: [VariableState] -> ShowS #

defaultSpec :: Token -> AnalysisSpec Source #

pScript :: String -> Maybe Token Source #

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

addComment :: MonadWriter [t] m => t -> 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 #

makeParameters :: AnalysisSpec -> Parameters 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 #

determineShell :: Token -> Shell Source #

getParentTree :: Token -> Map Id Token Source #

getTokenMap :: Token -> Map Id Token Source #

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

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

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

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

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

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

getPath :: Map Id Token -> Token -> [Token] Source #

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

parents :: Parameters -> Token -> [Token] Source #

pathTo :: MonadReader Parameters m => Token -> m [Token] Source #

tokenIsJustCommandOutput :: Token -> Bool Source #

getVariableFlow :: Shell -> Map Id Token -> Token -> [StackData] Source #

leadType :: Shell -> Map Id Token -> Token -> Scope Source #

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

isClosingFileOp :: Token -> Bool Source #

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

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

getIndexReferences :: String -> [String] Source #

getOffsetReferences :: String -> [String] Source #

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

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

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

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

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

isConfusedGlobRegex :: [Char] -> Bool Source #

isVariableStartChar :: Char -> Bool Source #

isVariableChar :: Char -> Bool Source #

variableNameRegex :: Regex Source #

prop_isVariableName1 :: Bool Source #

prop_isVariableName2 :: Bool Source #

prop_isVariableName3 :: Bool Source #

isVariableName :: [Char] -> Bool Source #

getVariablesFromLiteralToken :: Token -> [String] Source #

prop_getVariablesFromLiteral1 :: Bool Source #

getVariablesFromLiteral :: String -> [String] Source #

prop_getBracedReference1 :: Bool Source #

prop_getBracedReference2 :: Bool Source #

prop_getBracedReference3 :: Bool Source #

prop_getBracedReference4 :: Bool Source #

prop_getBracedReference5 :: Bool Source #

prop_getBracedReference6 :: Bool Source #

prop_getBracedReference7 :: Bool Source #

prop_getBracedReference8 :: Bool Source #

prop_getBracedReference9 :: Bool Source #

prop_getBracedReference10 :: Bool Source #

prop_getBracedReference11 :: Bool Source #

prop_getBracedReference12 :: Bool Source #

prop_getBracedReference13 :: Bool Source #

getBracedReference :: [Char] -> [Char] Source #

prop_getBracedModifier1 :: Bool Source #

prop_getBracedModifier2 :: Bool Source #

prop_getBracedModifier3 :: Bool Source #

getBracedModifier :: [Char] -> [Char] Source #

potentially :: Monad m => Maybe (m ()) -> m () Source #

headOrDefault :: t -> [t] -> t Source #

(!!!) :: [a] -> Int -> Maybe a Source #

filterByAnnotation :: Token -> [TokenComment] -> [TokenComment] Source #

runTests :: IO Bool Source #