licence_audit/report

Types

pub type Mode {
  Default
  Audit
}

Constructors

  • Default
  • Audit
pub type Row {
  Row(
    package: String,
    version: String,
    licences: List(String),
    status: Status,
    scope: manifest.Scope,
    path: List(String),
  )
}

Constructors

  • Row(
      package: String,
      version: String,
      licences: List(String),
      status: Status,
      scope: manifest.Scope,
      path: List(String),
    )
pub type Status {
  NotChecked
  Checked(policy.AuditStatus)
  Reviewed(List(#(exception.Finding, exception.Decision)))
  Failed(String)
  Skipped(source: String)
}

Constructors

pub type Summary {
  Summary(skipped_names: List(String))
}

Constructors

  • Summary(skipped_names: List(String))

    skipped_names are the non-Hex packages encountered but not audited. The summary line reports both the count and the names so the user knows exactly what was omitted (issue #3).

Values

pub fn decisions(status: Status) -> List(exception.Decision)
pub fn filter_failing_trees(rows: List(Row)) -> List(Row)

Keep only rows that belong to a dependency tree containing at least one policy or metadata-fetch failure, or a matched exception. Used by check to focus output on trees that need attention.

pub fn format(
  rows: List(Row),
  summary: Summary,
  mode: Mode,
  palette: color.Palette,
) -> String
pub fn is_failure(status: Status) -> Bool
✨ Search Document