NPM.Security.TaskReporter (NPM v0.7.1)

Shared reporting helpers for npm security Mix tasks.

Summary

output_format()

policy()

Raise according to policy when compromised-package findings exist.

Parse a task output format option.

Parse a compromised-package task policy option.

Report compromised-package findings in text or JSON format.

@type output_format() :: :text | :json

@type policy() :: :error | :warn | :off

@spec enforce([NPM.Security.Compromised.finding()], policy()) :: :ok | no_return()

Raise according to policy when compromised-package findings exist.

@spec parse_format(String.t() | nil) :: {:ok, output_format()} | :error

Parse a task output format option.

@spec parse_policy(String.t() | nil) :: {:ok, policy()} | :error

Parse a compromised-package task policy option.

@spec report(
  [NPM.Security.Compromised.finding()],
  output_format(),
  String.t(),
  String.t()
) :: :ok

Report compromised-package findings in text or JSON format.