rituals 0.2.0

Ritual — what a task is, and how a composed command line dispatches to one.
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
48
49
50
51
52
53

#![doc = include_str!("../readme.md")]
//!
//! ## What this crate provides
//!
//! - For writing a task: [`Task`], [`Outcome`], [`Failure`], [`report()`], [`warn()`],
//!   and [`clap`]; and for a refusal that exits with a status other than 1,
//!   [`RefusalStatus`] and [`InvalidRefusalStatus`].
//! - For a task that needs the command line it runs in:
//!   [`Task::receiving_command_line`], [`CommandLine`] and [`Identity`].
//! - For generated code and scaffolding tools rather than tasks: [`run`],
//!   [`identity!`], [`Name`], [`InvalidName`] and [`VERSION`].

pub use clap;

mod command_line;
mod dispatch;
mod identity;
mod name;
mod outcome;
mod report;
mod task;
#[cfg(test)]
mod test_support;

pub use command_line::CommandLine;
pub use dispatch::run;
pub use identity::Identity;
pub use name::{InvalidName, Name};
pub use outcome::{Failure, InvalidRefusalStatus, Outcome, RefusalStatus};
pub use report::{report, warn};
pub use task::Task;

/// The version of this crate, as the build that compiled it saw it.
///
/// This is the version of the framework, not of any command line built on
/// it; that one is [`Identity::version`]. Ritual's scaffolding tasks write
/// it into a new project's manifests, so the project asks crates.io for the
/// `rituals` and `rituals-core` the scaffolding binary was built with.
///
/// # Examples
///
/// ```
/// let requirement = format!("rituals = \"{}\"", rituals::VERSION);
/// assert!(requirement.starts_with("rituals = \""));
/// ```
//
// One constant can name every crate ritual publishes because they are all
// released at the same version together. A project imports `rituals`
// directly and `rituals-core` for its management tasks, and the generated
// `main.rs` passes a task from one to a function in the other: requested at
// different versions, the two could resolve to two copies of `rituals`
// whose `Task` types are not the same type.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");