zuke_cli library
Supported application-facing programmatic CLI API.
Classes
- AlignmentDoctor
- Checks the consumer's declared, overridden, and resolved Zuke tuple.
- AlignmentDoctorReport
- ArtifactAudit
- Audits the exact directory that a CI workflow intends to upload.
- ArtifactAuditCommand
- ArtifactAuditFinding
- A finding in an assurance artifact bundle. The finding never includes the matched value, because the report may itself be uploaded to CI.
- ArtifactAuditReport
- ArtifactPackageCommand
- Builds an upload bundle from framework-produced artifact directories.
- ConsumerPolicyDocument
-
Typed model for the consumer-owned policy document
(
policies/project-policy.yamlby default). - CoverageCommand
- Parses and evaluates LCOV as an independent quality gate.
- CoverageExclusion
- FlutterToolchainResolver
- Resolves a Windows Flutter runner to a direct snapshot invocation.
- GatewayCanonicalizeCommand
- Produces a stable, non-secret APIM policy-evidence envelope from a raw export collected by the protected Azure workflow. The raw export is never checked into Git; only this canonical, content-addressed representation is passed to the external attestation command.
- GenerateCommand
- LcovFile
- LcovReport
- LocalProcessSupervisor
- The only production boundary that launches configured test processes.
- OpenApiContractCommand
- OpenApiContractReport
- Compares the parsed OpenAPI path/method surface with extracted route topology. It deliberately does not claim response-schema or authorization verification; those require separate contract and runtime evidence.
- OpenApiContractVerifier
- PolicyCommand
- Runs the reusable risk-acceptance verifier against a consumer-owned record.
- ProcessRunRequest
- ProcessSupervisor
- RegistrationAudit
- RegistrationAuditDiagnostic
- A source-level diagnostic produced while inspecting direct registrations.
- RegistrationAuditResult
-
Result of inspecting direct
zukeTest,zukeUnit, andzukeTestWidgetscalls. - RegistrationAuditSnapshot
- Analyzer-backed inspection for direct Zuke test registrations.
- RegistrationExecutionAudit
- Reconciles direct registrations with the result artifacts produced by a selected profile. This is intentionally separate from AST inspection so a source registration cannot be mistaken for proof that the test actually ran.
- RegistrationExecutionAuditResult
- Result of comparing statically declared registrations with one fresh managed execution. The comparison is case-aware: multiple evidence types may be emitted for one case, but a missing, skipped, failed, duplicated, or unexpected case is still an execution failure.
- RiskAcceptancePolicy
-
Typed
riskAcceptancesection of the consumer policy. - ScenarioSelection
- Immutable, deterministic provenance for a single profile selection. This is written only after all configured runners have succeeded, alongside the evidence observation; it is never an input that can make a later run pass.
- ScenarioSelector
- Resolves the configured profile's tag expression against parsed scenarios.
- TestDartCommand
- The Dart command descriptor used by tests that spawn the CLI. It resolves the SDK driving the test before falling back to PATH, and always keeps the non-persistent analytics option before the Dart subcommand.
- TestRunSummary
- Deterministic summary emitted after a successful Zuke test run.
- ToolInvocation
- A fully prepared child-process invocation.
- ValidateCommand
- WatchCoordinator
- WatchTimer
- WorkspaceRegistrationAudit
- Static registration checks over configured runner roots and contracts. Execution evidence is verified separately by the managed test command.
- ZukeCli
- ZukeRegistration
- One direct Zuke registration found in a Dart source file.
Enums
- ProcessFailureKind
- ToolRunnerMode
- Strategy used to launch Dart and Flutter tools.
Functions
-
buildCoverageBaseline(
LcovReport report, {String? root, required List< String> includedRoots, List<CoverageExclusion> exclusions = const [], String? revision}) → Map<String, Object?> - Creates the immutable, reviewable shape used for coverage preservation.
-
isFlutterTool(
String executable) → bool -
Whether
executablenames Flutter's supported command-line launcher. -
parseLcov(
String contents) → LcovReport -
prepareToolInvocation(
String executable, List< String> arguments, Map<String, String> environment, {FlutterToolchainResolver? flutterResolver, ToolRunnerMode runnerMode = ToolRunnerMode.auto}) → ToolInvocation - Applies SDK-safe, non-persistent environment defaults to a tool launch.
-
resolveTestDartCommand(
) → TestDartCommand
Typedefs
-
CoverageProcessRunner
= Future<
ProcessResult> Function(String executable, List<String> arguments, {String? workingDirectory}) - Runs an external tool for coverage evaluation.
- FlutterCacheAccessProbe = void Function(String lockfilePath)
- Probes whether Flutter can open the cache lockfile required for a launch.
- FlutterExecutableLookup = String? Function()
- Looks up the configured Flutter executable.
- WatchSchedule = WatchTimer Function(Duration delay, void callback())
Exceptions / Errors
- SupervisedProcessException
- ToolInvocationException
- A stable, coded failure while preparing a configured tool invocation.