Stan.Observation

Observation — a vulnerability found in the target project by Stan.

Documentation

data Observation

Data type to represent discovered by Stan vulnerabilities.

Constructors

Observation

Fields

• observationId :: !(Id Observation)
• observationInspectionId :: !(Id Inspection)
• observationLoc :: !RealSrcSpan
• observationFile :: !FilePath
• observationModuleName :: !ModuleName
• observationFileContent :: !ByteString

Instances

Eq Observation

Defined in Stan.Observation

Methods

(==) :: Observation -> Observation -> Bool

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

Show Observation

Defined in Stan.Observation

Methods

showsPrec :: Int -> Observation -> ShowS

show :: Observation -> String

showList :: [Observation] -> ShowS

type Observations = Slist Observation

Type alias for the sized list of Observations.

Smart constructors

mkObservation

Arguments

:: Id Inspection

Corresponding Inspections Id.

-> HieFile

-> RealSrcSpan

Position.

-> Observation

Smart constructor for Observations from HieFiles.

mkObservationId :: Id Inspection -> ModuleName -> RealSrcSpan -> Id Observation

Create a stable Observation Id in a such way that:

1. Id doesn't depend on other inspections in this file.
2. Id uniquely identifies Observation location.
3. Ids are guaranteed to be the same if the module content didn't change between different stan runs.

The Observation Id should look like this:

OBS-STAN-XXXX-module-name-hash-10:42

ignoredObservations

Arguments

:: [Id Observation]

-> Observations

-> ([Id Observation], [Id Observation])

Ignored ^ Unknown

Pretty print

prettyShowObservation :: ReportSettings -> Observation -> Text

Show Observation in a human-friendly format.

prettyShowIgnoredObservations :: [Id Observation] -> Observations -> Text

prettyObservationSource

Arguments

:: Bool

Use colouring

-> Observation

-> [Text]