playground

Documentation

Overview

Command playground is the browser build of lockvet. It compiles to WebAssembly and powers https://matteo-sung.github.io/lockvet/ — paste a pull-request / compare / commit URL from any supported forge, or drop two lockfiles, and get the full lockvet report without installing anything.

It exposes two globals to JavaScript:

lockvetRun(opts) -> Promise<result>
lockvetVersion   -> string

opts (a plain object):

mode:      "url" | "files"
url:       PR / MR / compare / commit URL (mode "url")
token:     optional API token for the matched forge (mode "url")
oldName, oldData, newName, newData:  file names + Uint8Array (mode "files")
only:      -only filter pattern ("" = all)
freshDays: like -fresh-days (default 7)
noVulns, noMeta: like the CLI flags

result (a plain object):

terminal, markdown, json: the three report renderings (terminal = ANSI)
base, target, title:      labels
noChanges:  true when nothing relevant changed (message says why)
message:    human text when noChanges
warnings:   []string (non-fatal, e.g. OSV skipped)