Safe Haskell	Safe-Inferred
Language	Haskell2010

Hadolint.Shell

Synopsis

data CmdPart = CmdPart {
- arg :: Text
- partId :: Int
}
data Command = Command {
- name :: Text
- arguments :: [CmdPart]
- flags :: [CmdPart]
}
data ParsedShell = ParsedShell {
- original :: Text
- parsed :: ParseResult
- presentCommands :: [Command]
}
data ShellOpts = ShellOpts {
- shellName :: Text
- envVars :: Set Text
}
defaultShellOpts :: ShellOpts
addVars :: [Text] -> ShellOpts -> ShellOpts
setShell :: Text -> ShellOpts -> ShellOpts
shellcheck :: ShellOpts -> ParsedShell -> [PositionedComment]
nonPosixShells :: [Text]
hasUnsupportedShebang :: Text -> Bool
parseShell :: Text -> ParsedShell
findCommandsInResult :: ParseResult -> [Token]
extractTokensWith :: forall a. (Token -> Maybe a) -> ParseResult -> [a]
findPipes :: ParsedShell -> [Token]
hasPipes :: ParsedShell -> Bool
allCommands :: (Command -> Bool) -> ParsedShell -> Bool
noCommands :: (Command -> Bool) -> ParsedShell -> Bool
anyCommands :: (Command -> Bool) -> ParsedShell -> Bool
findCommandNames :: ParsedShell -> [Text]
cmdHasArgs :: Text -> [Text] -> Command -> Bool
cmdsHaveArgs :: [Text] -> [Text] -> Command -> Bool
cmdHasPrefixArg :: Text -> Text -> Command -> Bool
extractAllArgs :: Token -> [CmdPart]
getArgs :: Command -> [Text]
getAllFlags :: [CmdPart] -> [CmdPart]
getArgsNoFlags :: Command -> [Text]
hasFlag :: Text -> Command -> Bool
hasAnyFlag :: [Text] -> Command -> Bool
hasArg :: Text -> Command -> Bool
dropFlagArg :: [Text] -> Command -> Command
getFlagArg :: Text -> Command -> [Text]
getValueId :: Int -> [CmdPart] -> Int
usingProgram :: Text -> ParsedShell -> Bool
isPipInstall :: Command -> Bool

Documentation

data CmdPart Source #

Constructors

CmdPart
Fields arg :: Text partId :: Int

Instances

Instances details

Show CmdPart Source #
Instance details Defined in Hadolint.Shell Methods showsPrec :: Int -> CmdPart -> ShowS # show :: CmdPart -> String # showList :: [CmdPart] -> ShowS #
Eq CmdPart Source #
Instance details Defined in Hadolint.Shell Methods (==) :: CmdPart -> CmdPart -> Bool # (/=) :: CmdPart -> CmdPart -> Bool #

data Command Source #

Constructors

Command
Fields name :: Text arguments :: [CmdPart] flags :: [CmdPart]

Instances

Instances details

Show Command Source #
Instance details Defined in Hadolint.Shell Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
Eq Command Source #
Instance details Defined in Hadolint.Shell Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #

data ParsedShell Source #

Constructors

ParsedShell
Fields original :: Text parsed :: ParseResult presentCommands :: [Command]

data ShellOpts Source #

Constructors

ShellOpts
Fields shellName :: Text envVars :: Set Text

defaultShellOpts :: ShellOpts Source #

addVars :: [Text] -> ShellOpts -> ShellOpts Source #

setShell :: Text -> ShellOpts -> ShellOpts Source #

shellcheck :: ShellOpts -> ParsedShell -> [PositionedComment] Source #

nonPosixShells :: [Text] Source #

hasUnsupportedShebang :: Text -> Bool Source #

parseShell :: Text -> ParsedShell Source #

findCommandsInResult :: ParseResult -> [Token] Source #

extractTokensWith :: forall a. (Token -> Maybe a) -> ParseResult -> [a] Source #

findPipes :: ParsedShell -> [Token] Source #

hasPipes :: ParsedShell -> Bool Source #

allCommands :: (Command -> Bool) -> ParsedShell -> Bool Source #

noCommands :: (Command -> Bool) -> ParsedShell -> Bool Source #

anyCommands :: (Command -> Bool) -> ParsedShell -> Bool Source #

findCommandNames :: ParsedShell -> [Text] Source #

cmdHasArgs :: Text -> [Text] -> Command -> Bool Source #

cmdsHaveArgs :: [Text] -> [Text] -> Command -> Bool Source #

cmdHasPrefixArg :: Text -> Text -> Command -> Bool Source #

extractAllArgs :: Token -> [CmdPart] Source #

getArgs :: Command -> [Text] Source #

getAllFlags :: [CmdPart] -> [CmdPart] Source #

getArgsNoFlags :: Command -> [Text] Source #

hasFlag :: Text -> Command -> Bool Source #

hasAnyFlag :: [Text] -> Command -> Bool Source #

hasArg :: Text -> Command -> Bool Source #

dropFlagArg :: [Text] -> Command -> Command Source #

getFlagArg :: Text -> Command -> [Text] Source #

given a flag and a command, return list of arguments for that particulat flag. E.g., if the command is `useradd -u 12345 luser` and this function is called for the command u, it returns ["12345"].

getValueId :: Int -> [CmdPart] -> Int Source #

usingProgram :: Text -> ParsedShell -> Bool Source #

Check if a command contains a program call in the Run instruction

isPipInstall :: Command -> Bool Source #