VulnCheck.Types.Workspace (VulnCheck v1.0.1)

Copy Markdown View Source

The fully resolved project under audit: project type, target runtime, locked packages with their scopes and the compiled artifact locations.

Summary

Functions

Returns the packages that are excluded from the production closure (development, test and build-time only dependencies).

Returns the packages that belong to the production closure.

Types

project_type()

@type project_type() :: :mix | :umbrella | :rebar3 | :gleam

t()

@type t() :: %VulnCheck.Types.Workspace{
  artifact_issues: [{String.t() | nil, String.t()}],
  build_dir: String.t() | nil,
  build_env: String.t() | nil,
  configured_adapters: %{required(atom()) => [String.t()]},
  consolidated_dirs: [String.t()],
  direct_deps: [String.t()],
  elixir_version: String.t() | nil,
  env: :prod | :dev | :test,
  lockfile: String.t() | nil,
  otp_release: String.t(),
  packages: %{required(String.t()) => VulnCheck.Types.Package.t()},
  project_name: String.t(),
  project_type: project_type(),
  project_version: String.t() | nil,
  root_apps: [String.t()],
  root_dir: String.t(),
  root_ebin_dirs: [String.t()],
  warnings: [String.t()]
}

Functions

non_prod_packages(workspace)

@spec non_prod_packages(t()) :: [VulnCheck.Types.Package.t()]

Returns the packages that are excluded from the production closure (development, test and build-time only dependencies).

prod_packages(workspace)

@spec prod_packages(t()) :: [VulnCheck.Types.Package.t()]

Returns the packages that belong to the production closure.