Hadolint.Rules

Documentation

data Metadata

Constructors

Metadata

Fields

• code :: Text
• severity :: Severity
• message :: Text

Instances

Eq Metadata

Defined in Hadolint.Rules

Methods

(==) :: Metadata -> Metadata -> Bool

(/=) :: Metadata -> Metadata -> Bool

data RuleCheck

Constructors

RuleCheck

Fields

• metadata :: Metadata
• filename :: Filename
• linenumber :: Linenumber
• success :: Bool

Instances

Eq RuleCheck

Defined in Hadolint.Rules

Methods

(==) :: RuleCheck -> RuleCheck -> Bool

(/=) :: RuleCheck -> RuleCheck -> Bool

Ord RuleCheck

Defined in Hadolint.Rules

Methods

compare :: RuleCheck -> RuleCheck -> Ordering

(<) :: RuleCheck -> RuleCheck -> Bool

(<=) :: RuleCheck -> RuleCheck -> Bool

(>) :: RuleCheck -> RuleCheck -> Bool

(>=) :: RuleCheck -> RuleCheck -> Bool

max :: RuleCheck -> RuleCheck -> RuleCheck

min :: RuleCheck -> RuleCheck -> RuleCheck

newtype RulesConfig

Contains the required parameters for optional rules

Constructors

RulesConfig

Fields

• allowedRegistries :: Set Registry

  The docker registries that are allowed in FROM

Instances

Eq RulesConfig

Defined in Hadolint.Rules

Methods

(==) :: RulesConfig -> RulesConfig -> Bool

(/=) :: RulesConfig -> RulesConfig -> Bool

Show RulesConfig

Defined in Hadolint.Rules

Methods

showsPrec :: Int -> RulesConfig -> ShowS

show :: RulesConfig -> String

showList :: [RulesConfig] -> ShowS

Semigroup RulesConfig

Defined in Hadolint.Rules

Methods

(<>) :: RulesConfig -> RulesConfig -> RulesConfig

sconcat :: NonEmpty RulesConfig -> RulesConfig

stimes :: Integral b => b -> RulesConfig -> RulesConfig

Monoid RulesConfig

Defined in Hadolint.Rules

Methods

mempty :: RulesConfig

mappend :: RulesConfig -> RulesConfig -> RulesConfig

mconcat :: [RulesConfig] -> RulesConfig

type IgnoreRuleParser = Parsec Void Text

type ParsedFile = [InstructionPos ParsedShell]

type SimpleCheckerWithState state = state -> Linenumber -> Instruction ParsedShell -> (state, Bool)

A function to check individual dockerfile instructions. It gets the current state and a line number. It should return the new state and whether or not the check passes for the given instruction.

type SimpleCheckerWithLine = Linenumber -> Instruction ParsedShell -> Bool

A function to check individual dockerfile instructions. It gets the current line number. It should return True if the check passes for the given instruction.

type CheckerWithState state = state -> Linenumber -> Instruction ParsedShell -> (state, [Metadata])

A function to check individual dockerfile instructions. It should return the new state and a list of Metadata records. Each Metadata record signifies a failing check for the given instruction.

link :: Metadata -> Text

type Rule = ParsedFile -> [RuleCheck]

mapInstructions :: CheckerWithState state -> state -> Rule

instructionRule :: Text -> Severity -> Text -> (Instruction ParsedShell -> Bool) -> Rule

instructionRuleLine :: Text -> Severity -> Text -> SimpleCheckerWithLine -> Rule

instructionRuleState :: Text -> Severity -> Text -> SimpleCheckerWithState state -> state -> Rule

withState :: a -> b -> (a, b)

argumentsRule :: (ParsedShell -> a) -> Arguments ParsedShell -> a

analyze :: [Rule] -> Dockerfile -> [RuleCheck]

ignored :: Dockerfile -> [(Linenumber, [Text])]

rules :: [Rule]

optionalRules :: RulesConfig -> [Rule]

allFromImages :: ParsedFile -> [(Linenumber, BaseImage)]

allAliasedImages :: ParsedFile -> [(Linenumber, ImageAlias)]

allImageNames :: ParsedFile -> [(Linenumber, Text)]

previouslyDefinedAliases :: Linenumber -> ParsedFile -> [Text]

Returns a list of all image aliases in FROM instructions that are defined before the given line number.

aliasMustBe :: (Text -> Bool) -> Instruction a -> Bool

Returns the result of running the check function on the image alias name, if the passed instruction is a FROM instruction with a stage alias. Otherwise, returns True.

fromName :: BaseImage -> Text

fromAlias :: BaseImage -> Maybe ImageAlias

shellcheck :: Rule

commentMetadata :: PositionedComment -> Metadata

Converts ShellCheck errors into our own errors type

absoluteWorkdir :: Rule

hasNoMaintainer :: Rule

usingProgram :: Text -> ParsedShell -> Bool

multipleCmds :: Rule

multipleEntrypoints :: Rule

wgetOrCurl :: Rule

invalidCmd :: Rule

noRootUser :: Rule

noCd :: Rule

noSudo :: Rule

noAptGetUpgrade :: Rule

noUntagged :: Rule

noLatestTag :: Rule

aptGetVersionPinned :: Rule

aptGetPackages :: ParsedShell -> [Text]

aptGetCleanup :: Rule

noApkUpgrade :: Rule

apkAddVersionPinned :: Rule

apkAddPackages :: ParsedShell -> [Text]

apkAddNoCache :: Rule

useAdd :: Rule

invalidPort :: Rule

pipVersionPinned :: Rule

stripInstallPrefix :: [Text] -> [Text]

npmVersionPinned :: Rule

Rule for pinning NPM packages to version, tag, or commit supported formats by Hadolint npm install (with no args, in package dir) npm install [@scope/]name npm install [@scope/]nametag npm install [<scope>/]name@version npm install git[+http|+https]:/git-hostgit-user/repo-name[semver:semver] npm install git+ssh:/git-host:git-userrepo-name[semver:semver]

aptGetYes :: Rule

aptGetNoRecommends :: Rule

isArchive :: Text -> Bool

isUrl :: Text -> Bool

copyInsteadAdd :: Rule

copyEndingSlash :: Rule

copyFromExists :: Rule

copyFromAnother :: Rule

fromAliasUnique :: Rule

useShell :: Rule

useJsonArgs :: Rule

noApt :: Rule

usePipefail :: Rule

registryIsAllowed :: Set Registry -> Rule

gemVersionPinned :: Rule

gems :: ParsedShell -> [Text]