Policy evaluation

Policy evaluation determines whether a set of findings passes or fails. Source: packages/verification/src/policy/.

evaluatePolicy(findings, policy, baselineFingerprints)Copy Anchor Link

Evaluate findings against a policy. Returns a PolicyResult. Pass an empty array for baselineFingerprints when no baseline exists.

import { evaluatePolicy, DEFAULT_POLICY } from "@sverka/sdk";

const result = evaluatePolicy(findings, DEFAULT_POLICY, []);
console.log(result.verdict); // "pass" | "fail"
console.log(result.summary); // human-readable summary

DEFAULT_POLICYCopy Anchor Link

The built-in default policy fails on any finding with severity high (all findings) or medium (only new findings not in the baseline).

import { DEFAULT_POLICY } from "@sverka/sdk";

// DEFAULT_POLICY = {
//   name: "default",
//   default: "pass",
//   failOn: [
//     { severity: "high", onlyNew: false },
//     { severity: "medium", onlyNew: true },
//   ],
// }

createPolicy(config)Copy Anchor Link

Create a custom policy.

import { createPolicy } from "@sverka/sdk";

const policy = createPolicy({
  name: "strict",
  default: "pass",
  failOn: [
    { severity: "medium", onlyNew: false },
    { severity: "low", onlyNew: true, checkIds: ["eslint"] },
  ],
});

FailOnRuleCopy Anchor Link

Each rule in failOn specifies:

A finding triggers a rule if its severity rank is >= the rule's threshold and (when onlyNew is true) its fingerprint is not in the baseline.

PolicyResultCopy Anchor Link

VerdictCopy Anchor Link

type Verdict = "pass" | "fail";

The CLI's exit code reflects the verdict: 0 for pass, 1 for fail.