Safe Haskell	None
Language	Haskell2010

Hadolint.Config

Synopsis

applyConfig :: Maybe FilePath -> LintOptions -> IO (Either String LintOptions)
getConfig :: Maybe FilePath -> IO (Maybe FilePath)
data ConfigFile = ConfigFile {
- overrideRules :: Maybe OverrideConfig
- ignoredRules :: Maybe [IgnoreRule]
- trustedRegistries :: Maybe [TrustedRegistry]
- labelSchemaConfig :: Maybe LabelSchema
- strictLabelSchema :: Maybe Bool
- failureThreshold :: Maybe DLSeverity
}
data OverrideConfig = OverrideConfig {
- overrideErrorRules :: Maybe [ErrorRule]
- overrideWarningRules :: Maybe [WarningRule]
- overrideInfoRules :: Maybe [InfoRule]
- overrideStyleRules :: Maybe [StyleRule]
}

Documentation

applyConfig :: Maybe FilePath -> LintOptions -> IO (Either String LintOptions) Source #

If both the ignoreRules and rulesConfig properties of Lint options are empty then this function will fill them with the default found in the passed config file. If there is an error parsing the default config file, this function will return the error string.

getConfig :: Maybe FilePath -> IO (Maybe FilePath) Source #

Gets the configuration file which Hadolint uses

data ConfigFile Source #

Constructors

ConfigFile
Fields overrideRules :: Maybe OverrideConfig ignoredRules :: Maybe [IgnoreRule] trustedRegistries :: Maybe [TrustedRegistry] labelSchemaConfig :: Maybe LabelSchema strictLabelSchema :: Maybe Bool failureThreshold :: Maybe DLSeverity

Instances

Instances details

Eq ConfigFile Source #
Instance details Defined in Hadolint.Config Methods (==) :: ConfigFile -> ConfigFile -> Bool (/=) :: ConfigFile -> ConfigFile -> Bool
Show ConfigFile Source #
Instance details Defined in Hadolint.Config Methods showsPrec :: Int -> ConfigFile -> ShowS show :: ConfigFile -> String showList :: [ConfigFile] -> ShowS
Generic ConfigFile Source #
Instance details Defined in Hadolint.Config Associated Types type Rep ConfigFile :: Type -> Type Methods from :: ConfigFile -> Rep ConfigFile x to :: Rep ConfigFile x -> ConfigFile
FromYAML ConfigFile Source #
Instance details Defined in Hadolint.Config Methods parseYAML :: Node Pos -> Parser ConfigFile
type Rep ConfigFile Source #
Instance details Defined in Hadolint.Config type Rep ConfigFile = D1 ('MetaData "ConfigFile" "Hadolint.Config" "hadolint-2.7.0-3QxIUNnf0xQ3UQPX95eU8L" 'False) (C1 ('MetaCons "ConfigFile" 'PrefixI 'True) ((S1 ('MetaSel ('Just "overrideRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OverrideConfig)) :: (S1 ('MetaSel ('Just "ignoredRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IgnoreRule])) :: S1 ('MetaSel ('Just "trustedRegistries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrustedRegistry])))) :: (S1 ('MetaSel ('Just "labelSchemaConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LabelSchema)) :: (S1 ('MetaSel ('Just "strictLabelSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "failureThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DLSeverity))))))

data OverrideConfig Source #

Constructors

OverrideConfig
Fields overrideErrorRules :: Maybe [ErrorRule] overrideWarningRules :: Maybe [WarningRule] overrideInfoRules :: Maybe [InfoRule] overrideStyleRules :: Maybe [StyleRule]

Instances

Instances details

Eq OverrideConfig Source #
Instance details Defined in Hadolint.Config Methods (==) :: OverrideConfig -> OverrideConfig -> Bool (/=) :: OverrideConfig -> OverrideConfig -> Bool
Show OverrideConfig Source #
Instance details Defined in Hadolint.Config Methods showsPrec :: Int -> OverrideConfig -> ShowS show :: OverrideConfig -> String showList :: [OverrideConfig] -> ShowS
Generic OverrideConfig Source #
Instance details Defined in Hadolint.Config Associated Types type Rep OverrideConfig :: Type -> Type Methods from :: OverrideConfig -> Rep OverrideConfig x to :: Rep OverrideConfig x -> OverrideConfig
Semigroup OverrideConfig Source #
Instance details Defined in Hadolint.Config Methods (<>) :: OverrideConfig -> OverrideConfig -> OverrideConfig sconcat :: NonEmpty OverrideConfig -> OverrideConfig stimes :: Integral b => b -> OverrideConfig -> OverrideConfig
Monoid OverrideConfig Source #
Instance details Defined in Hadolint.Config Methods mempty :: OverrideConfig mappend :: OverrideConfig -> OverrideConfig -> OverrideConfig mconcat :: [OverrideConfig] -> OverrideConfig
FromYAML OverrideConfig Source #
Instance details Defined in Hadolint.Config Methods parseYAML :: Node Pos -> Parser OverrideConfig
type Rep OverrideConfig Source #
Instance details Defined in Hadolint.Config type Rep OverrideConfig = D1 ('MetaData "OverrideConfig" "Hadolint.Config" "hadolint-2.7.0-3QxIUNnf0xQ3UQPX95eU8L" 'False) (C1 ('MetaCons "OverrideConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "overrideErrorRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ErrorRule])) :: S1 ('MetaSel ('Just "overrideWarningRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WarningRule]))) :: (S1 ('MetaSel ('Just "overrideInfoRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InfoRule])) :*: S1 ('MetaSel ('Just "overrideStyleRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StyleRule])))))