Module ux 

The ux command. User experience (UX) utilities for the Zoi CLI.

This module contains types and functions for formatting output, providing hints to the user, and emitting machine-readable plans.

Structs

ExplainItem

An item in an explanation report.

ExplainReport

A report explaining the reasons for certain actions or states.

PlanJsonV1

The standard JSON schema for Zoi execution plans.

PreflightRow

A single row in a preflight summary table.

PreflightSummary

A summary of preflight checks before an operation.

TransactionSummary

A summary of a transaction’s results.

Enums

InstallOrigin

Classifies the source and method used to install a package.

Functions

classify_source_origin

Classifies the origin of a package based on its source string and the action being performed.

emit_plan_json

Emits a plan in JSON format to stdout.

emit_plan_json_v1

Emits a version 1 plan in JSON format to stdout.

print_explain

Prints an explanation report to the console.

print_preflight

Prints a preflight summary to the console.

print_transaction_summary

Prints a transaction summary to the console.

with_failure_hint

Wraps an error with a user-friendly hint if one is available for the given error message and command.