Data.SARIF.ReportingDescriptor

Provides the ReportingDescriptor type, which is essentially used to represent descriptions of rules that a static analysis tool has applied.

Documentation

newtype ReportingConfiguration

Represents default configurations for ReportingDescriptor values. That is properties which may be overriden by individual results.

Constructors

MkReportingConfiguration

Fields

• rcLevel :: Maybe Level

  The default severity of the reporting descriptor.

Instances

FromJSON ReportingConfiguration

Defined in Data.SARIF.ReportingDescriptor

Methods

parseJSON :: Value -> Parser ReportingConfiguration

parseJSONList :: Value -> Parser [ReportingConfiguration]

ToJSON ReportingConfiguration

Defined in Data.SARIF.ReportingDescriptor

Methods

toJSON :: ReportingConfiguration -> Value

toEncoding :: ReportingConfiguration -> Encoding

toJSONList :: [ReportingConfiguration] -> Value

toEncodingList :: [ReportingConfiguration] -> Encoding

Show ReportingConfiguration

Defined in Data.SARIF.ReportingDescriptor

Methods

showsPrec :: Int -> ReportingConfiguration -> ShowS

show :: ReportingConfiguration -> String

showList :: [ReportingConfiguration] -> ShowS

Eq ReportingConfiguration

Defined in Data.SARIF.ReportingDescriptor

Methods

(==) :: ReportingConfiguration -> ReportingConfiguration -> Bool

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

defaultReportingConfiguration :: ReportingConfiguration

defaultReportingConfiguration is a default ReportingConfiguration value.

data ReportingDescriptor

Represents rules that a static analysis tool

Constructors

MkReportingDescriptor

Fields

• rdId :: Text

  The unique ID of the rule.

• rdName :: Maybe Text

  A friendly name for the rule, which should be one word in upper camel case.

• rdShortDescription :: Maybe MultiformatMessageString

  A short description for the rule, which may contain spaces and symbols.

• rdFullDescription :: Maybe MultiformatMessageString

  The full description.

• rdHelpUri :: Maybe Text

  A URL to some help for this rule.

• rdHelp :: Maybe MultiformatMessageString

  A recommendation for what to do in order to resolve an occurrence of this rule.

• rdDefaultConfiguration :: Maybe ReportingConfiguration

  The default reporting configuration for the rule.

• rdProperties :: Map Text Value

  Extra properties for this rule.

Instances

FromJSON ReportingDescriptor

Defined in Data.SARIF.ReportingDescriptor

Methods

parseJSON :: Value -> Parser ReportingDescriptor

parseJSONList :: Value -> Parser [ReportingDescriptor]

ToJSON ReportingDescriptor

Defined in Data.SARIF.ReportingDescriptor

Methods

toJSON :: ReportingDescriptor -> Value

toEncoding :: ReportingDescriptor -> Encoding

toJSONList :: [ReportingDescriptor] -> Value

toEncodingList :: [ReportingDescriptor] -> Encoding

Show ReportingDescriptor

Defined in Data.SARIF.ReportingDescriptor

Methods

showsPrec :: Int -> ReportingDescriptor -> ShowS

show :: ReportingDescriptor -> String

showList :: [ReportingDescriptor] -> ShowS

Eq ReportingDescriptor

Defined in Data.SARIF.ReportingDescriptor

Methods

(==) :: ReportingDescriptor -> ReportingDescriptor -> Bool

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

defaultReportingDescriptor :: Text -> ReportingDescriptor

defaultReportingDescriptor id constructs a default ReportingDescriptor with the given id, which must be unique.