Skip to main content

usage/
lib.rs

1#[cfg(test)]
2extern crate insta;
3extern crate log;
4
5pub use crate::parse::{Parser, available_flags, parse};
6pub use crate::spec::Spec;
7pub use crate::spec::admonition::{SpecAdmonition, SpecAdmonitionKind};
8pub use crate::spec::arg::{SpecArg, SpecDoubleDashChoices, SpecRequiredIfEq};
9pub use crate::spec::builder::{SpecArgBuilder, SpecCommandBuilder, SpecFlagBuilder};
10pub use crate::spec::choices::{SpecChoice, SpecChoiceAlias, SpecChoices};
11pub use crate::spec::clause::SpecClause;
12pub use crate::spec::cmd::SpecCommand;
13pub use crate::spec::complete::SpecComplete;
14pub use crate::spec::effect::SpecCommandEffect;
15pub use crate::spec::exit_code::{SpecExitCode, effective_exit_codes, effective_exit_codes_ref};
16pub use crate::spec::flag::{SpecDefaultIf, SpecFlag, SpecFlagAction, SpecRequiresIf};
17pub use crate::spec::flagset::{SpecFlagSet, SpecUse};
18pub use crate::spec::group::SpecGroup;
19pub use crate::spec::mount::SpecMount;
20pub use crate::spec::output::{
21    Framing, Selector, SpecOutput, effective_outputs, effective_outputs_ref, effective_select,
22    effective_select_ref,
23};
24pub use crate::spec::unknown_env::SpecUnknownEnv;
25pub use crate::spec::unknown_flags::UnknownFlags;
26pub use crate::spec::view::SpecView;
27pub use crate::warn::{Warning, WarningKind};
28
29#[macro_use]
30#[allow(unused_assignments)] // Fields in struct variants are read by derive macros
31pub mod error;
32mod case;
33#[doc(hidden)]
34pub mod kdl;
35pub mod miette;
36#[macro_use]
37mod enum_value;
38#[macro_use]
39pub mod macros;
40pub mod complete;
41pub mod spec;
42pub use error::Result;
43
44#[cfg(any(feature = "docs", feature = "cli-help"))]
45pub mod docs;
46pub mod go;
47pub mod help_template;
48pub mod parse;
49pub mod sdk;
50pub mod sh;
51#[doc(hidden)]
52pub mod shell_words;
53pub(crate) mod string;
54#[cfg(test)]
55mod test;
56pub mod warn;