cli-engine 0.2.0

Rust CLI framework for consistent command modules
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! Structured output envelopes and renderers.
//!
//! Command handlers return JSON-serializable data and a backend system id. The
//! middleware wraps that data in an [`Envelope`], applies filtering, pagination,
//! JMESPath expressions, field projection, and then renders the result as JSON,
//! human text, or TOON.
//!
//! JSON is the default for the Rust crate. Human output is intended for terminal
//! readability, and TOON remains available as an explicit migration format.

mod envelope;
mod fields;
mod human;
mod json;
mod pipeline;
mod renderer;
mod schema;
mod toon;

pub use crate::error::{DetailedError, ExitCoder, exit_code_for_error, exit_code_for_exit_coder};
pub use envelope::{
    Envelope, ErrorEnvelope, Metadata, NextAction, NextActionParam, PaginationMeta,
    build_detailed_error_envelope, build_error_envelope,
};
pub use fields::{FieldTree, filter_fields, parse_fields};
pub use human::{
    HumanViewDef, HumanViewFn, HumanViewRegistry, HumanViewRenderer, TableColumn,
    global_human_view_registry_snapshot, lookup_global_human_view_columns,
    lookup_global_human_view_func, register_global_human_view, register_global_human_view_func,
    render_human, render_human_with_registry, render_human_with_registry_for_schema,
    render_human_with_view,
};
pub use json::render_json;
pub use pipeline::{PipelineOpts, apply_pipeline};
pub use renderer::{
    OutputFormat, RendererFactory, is_valid_output_format, render, render_data, render_data_format,
    render_detailed_error, render_detailed_error_format, render_error, render_error_format,
    render_format, write_render,
};
pub use schema::{
    FieldInfo, OutputField, OutputSchema, SchemaInfo, SchemaRegistry, fields_for,
    fields_from_json_schema, format_help_section, get_global_schema_by_path,
    global_schema_registry_snapshot, json_schema_for, json_schema_info,
    register_global_json_schema, register_global_schema, register_global_schema_fields,
    register_global_schema_info,
};
pub use toon::render_toon;