@czap/audit

Runs structure, integrity, and surface checks over @czap/* packages and reports findings as structured data — against the LiteShip monorepo or against the packages installed in your own app.

Install this directly when you want to run the audit passes programmatically. Most projects run it through czap audit from @czap/cli instead, which wraps the same engine in a JSON receipt.

Install

pnpm add -D @czap/audit

No peer dependencies and no other @czap/* dependencies — it works on its own.

30 seconds

import { consumerDevopsProfile, runAuditPasses } from '@czap/audit';

const result = runAuditPasses(consumerDevopsProfile(process.cwd()));

console.log(result.counts); // { error, warning, info }
for (const f of result.findings) {
  console.log(f.severity, f.rule, f.title);
}

In a repo with @czap/* packages installed, this logs the merged counts and one line per finding. consumerDevopsProfile(cwd) audits what is actually installed in node_modules (every czap package publishes src/ alongside dist/, so source-level checks run on shipped artifacts); inside the LiteShip monorepo itself, call runAuditPasses() with no argument to glob packages/* instead.

Rule ids

Every finding carries a rule id — the key you use in a profile's allowlists: console-call, default-export, export-target-missing, fallback-laundering, host-surface, missing-manifest-dependency, missing-manifest-dependency-dynamic, missing-runtime-capability, orphan-export-candidate, package-export-surface, package-topology, placeholder-content, stub-marker, suspicious-reimplementation, symbol-orphan-candidate, unknown-internal-package, unresolved-internal-import, virtual-module-surface.

Where it sits

Standalone — this package depends on no other @czap/* package, only fast-glob and the TypeScript compiler API, so you can install it without the rest of the stack. The czap audit verb in @czap/cli is the only adapter that wires the engine; @czap/command and @czap/mcp-server see a structured summary of the result, never the engine itself. LiteShip's repo-local scoring and report rendering are not in this package — they compose it from the monorepo's scripts. See the package surfaces map for the full layout.

If it does nothing

Consumer discovery walks node_modules; if no @czap/* packages are installed where you ran it, the audit finds zero packages and reports zero findings — a clean result that verified nothing. Before trusting a silent pass, check Object.keys(consumerDevopsProfile(cwd).packageRoots).length is what you expect.

Docs

• Getting started
• Audit guide — profiles, passes, and the receipt contract
• Glossary — the vocabulary used above
• API reference — generated from source

Part of LiteShip — powered by the CZAP engine (Content-Zoned Adaptive Projection), distributed as @czap/* packages.