snyk-docker-plugin

analyseDockerfile: (contents: string) => Promise<DockerFileAnalysis>;

display: (
    scanResults: ScanResult[],
    testResults: TestResult[],
    errors: string[],
    options?: Options
) => Promise<string>;

extractContent: (
    extractActions: ExtractAction[],
    options?: Partial<PluginOptions>
) => Promise<ExtractionResult>;

parseDockerfile: (content: string) => Dockerfile;

scan: (options?: Partial<PluginOptions>) => Promise<PluginResponse>;

updateDockerfileBaseImageName: (
    contents: string,
    newBaseImageName: string
) => UpdateDockerfileBaseImageNameResult;

type FactType =
    | 'autoDetectedUserInstructions'
    | 'depGraph'
    | 'dockerfileAnalysis'
    | 'imageCreationTime'
    | 'imageId'
    | 'imageLabels'
    // Collects the file names of the individual .tar layers found in the scanned image.
    | 'imageLayers'
    // Package manager manifests (e.g. requirements.txt, Gemfile.lock) collected as part of an application scan.
    | 'imageManifestFiles'
    | 'imageNames'
    | 'imageOsReleasePrettyName'
    | 'imageSizeBytes'
    // Hashes of extracted *.jar binaries, hashed with sha1 algorithm
    | 'jarFingerprints'
    // Hashes of executables not installed by a package manager (e.g. if they were copied straight onto the image).
    | 'keyBinariesHashes'
    | 'loadedPackages'
    | 'ociDistributionMetadata'
    | 'rootFs'
    // Used for application dependencies scanning; shows which files were used in the analysis of the dependencies.
    | 'testedFiles'
    // Application files observed in the image
    | 'applicationFiles';