ctl_core/
lib.rs

1//! Shared clap chassis and presentation kernel for the `*ctl` CLIs.
2//!
3//! Not a command. Import as [`ctl_core`](crate). Domain handlers return typed
4//! data. [`Document`] describes the human view, [`View`] chooses pretty,
5//! colorless, or JSON, and the terminal engine remains private to this crate.
6//!
7//! ## Cargo features
8#![doc = document_features::document_features!()]
9//!
10//! Unused features do not compile `clap`, `comfy-table`, or `schemars`.
11//!
12//! Crate docs live here. The GitHub README is not rustdoc.
13
14#![deny(missing_docs, rustdoc::broken_intra_doc_links)]
15#![allow(clippy::missing_errors_doc)]
16
17/// Fluent typed CLI lifecycle.
18#[cfg(feature = "app")]
19pub mod app;
20/// Color policy (`auto` / `always` / `never`).
21pub mod color;
22/// Semantic human presentation independent of a terminal engine.
23#[cfg(feature = "document")]
24pub mod document;
25/// Output representation (`pretty` / `json`).
26pub mod format;
27/// Schema-first wire types.
28pub mod model;
29
30/// Clap flatten structs for shared flags.
31#[cfg(feature = "cli")]
32pub mod flags;
33/// Styled `-h` / `--help` renderer.
34#[cfg(feature = "help")]
35pub mod help;
36#[cfg(feature = "render")]
37mod layout;
38/// Parser defaults (`-h` / `-V` stay on).
39#[cfg(feature = "cli")]
40pub mod parser;
41/// One-import surface for a *ctl binary (`use ctl_core::prelude::*`).
42pub mod prelude;
43/// Semantic document renderer.
44#[cfg(feature = "render")]
45pub mod render;
46/// Process `ExitCode` wrapper.
47#[cfg(feature = "cli")]
48pub mod run;
49#[cfg(feature = "render")]
50mod style;
51/// Shared Clap-derived operator surface and Jinja fragments.
52#[cfg(feature = "surface")]
53pub mod surface;
54/// Compact pretty tables for command output.
55#[cfg(feature = "render")]
56pub mod table;
57/// Mise Usage spec from a clap command.
58#[cfg(feature = "usage")]
59pub mod usage;
60/// Pretty / JSON / colorless emitters.
61#[cfg(feature = "view")]
62pub mod view;
63
64#[cfg(feature = "app")]
65pub use app::App;
66pub use color::ColorMode;
67#[cfg(feature = "document")]
68pub use document::{
69    Block, Document, Fields, Notice, NoticeLevel, Role, Rule, Section, Span, Table, Text,
70};
71#[cfg(feature = "cli")]
72pub use flags::{
73    ColorLong, DryRunArgs, FlagWarning, FormatArgs, FormatLong, OutputArgs, WarningKind,
74    chassis_warnings, emit_warnings, resolve_color, switch, warn_opposites,
75};
76pub use format::OutputFormat;
77pub use indoc::{concatdoc, eprintdoc, formatdoc, indoc, printdoc, writedoc};
78pub use model::{Envelope, ErrorBody, SCHEMA_VERSION};
79#[cfg(feature = "render")]
80pub use render::{RenderOptions, Renderer};
81#[cfg(feature = "cli")]
82pub use run::main as run;
83#[cfg(feature = "surface")]
84pub use surface::{Surface, SurfaceArgument, SurfaceCommand, SurfaceRequirement, SurfaceScope};
85#[cfg(feature = "render")]
86pub use table::{grid, kv};
87#[cfg(feature = "usage")]
88pub use usage::{mount_line, spec, spec_bin, take};
89#[cfg(feature = "view")]
90pub use view::{Captured, MessageKind, Present, Stream, View};
ctl_core/lib.rs

ctl_core/
lib.rs
