ready-set 0.1.0-alpha.1

ready, set, go: capability lifecycle orchestration for projects.
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! ready-set core: dispatcher + built-ins.
//!
//! Most consumers want the `ready-set` binary, not this library. The library
//! is exposed so integration tests can drive the dispatcher in-process.
//!
//! The dispatcher↔plugin contracts the core implements are versioned and
//! live under
//! [`docs/contracts/`](https://github.com/pulsearc-ai/ready-set/tree/main/docs/contracts):
//! [`env-vars.md`](https://github.com/pulsearc-ai/ready-set/blob/main/docs/contracts/env-vars.md)
//! (the `READY_SET_*` env surface),
//! [`capabilities.md`](https://github.com/pulsearc-ai/ready-set/blob/main/docs/contracts/capabilities.md)
//! (descriptor and report shapes),
//! [`describe.md`](https://github.com/pulsearc-ai/ready-set/blob/main/docs/contracts/describe.md)
//! and
//! [`manifest.md`](https://github.com/pulsearc-ai/ready-set/blob/main/docs/contracts/manifest.md)
//! (plugin metadata discovery),
//! [`exit-codes.md`](https://github.com/pulsearc-ai/ready-set/blob/main/docs/contracts/exit-codes.md)
//! (process exit code semantics),
//! [`cache.md`](https://github.com/pulsearc-ai/ready-set/blob/main/docs/contracts/cache.md)
//! (the `--list` cache).

#![forbid(unsafe_code)]
#![warn(missing_docs)]

pub mod builtins;
pub mod cache;
pub mod capabilities;
pub mod cli;
pub mod discovery;
pub mod env;
pub mod exec;
pub mod lifecycle;
pub mod metadata;
pub mod project;

use std::ffi::OsString;
use std::path::PathBuf;

use ready_set_sdk::context::{ColorMode, LogLevel};
use ready_set_sdk::{ExitCode, OutputMode};

/// Entry point shared by `main.rs` and integration tests.
pub fn run(argv: impl IntoIterator<Item = OsString>) -> ExitCode {
    let parsed = cli::parse(argv.into_iter());
    let cwd = std::env::current_dir().unwrap_or_else(|_| PathBuf::from("."));
    match parsed {
        cli::ParsedArgs::Help => {
            let contract = build_contract(&cli::GlobalFlags::default(), &cwd);
            builtins::help::run(&[], &contract)
        },
        cli::ParsedArgs::Version => {
            let contract = build_contract(&cli::GlobalFlags::default(), &cwd);
            builtins::version::run(&[], &contract)
        },
        cli::ParsedArgs::List { all, globals } => {
            let contract = build_contract(&globals, &cwd);
            let forwarded: Vec<OsString> = if all {
                vec![OsString::from("--all")]
            } else {
                Vec::new()
            };
            builtins::list::run(&forwarded, &contract)
        },
        cli::ParsedArgs::Empty { globals } => {
            let contract = build_contract(&globals, &cwd);
            builtins::ready::run(&[], &contract)
        },
        cli::ParsedArgs::Subcommand {
            name,
            args,
            globals,
        } => {
            let contract = build_contract(&globals, &cwd);
            if let Some(handler) = builtins::route(&name) {
                return handler(&args, &contract);
            }
            // Fall through to plugin discovery.
            let Some(entry) = discovery::find_plugin(&name) else {
                eprintln!(
                    "ready-set: unknown subcommand `{name}`\n\
                     hint: search crates.io for `ready-set-{name}` to install one"
                );
                return ExitCode::UnknownSubcommand;
            };
            exec::dispatch_to_plugin(&entry, &args, &contract)
        },
    }
}

fn build_contract(globals: &cli::GlobalFlags, cwd: &std::path::Path) -> env::EnvContract {
    let project_root = project::detect_project_root(cwd);
    let config_path = project_root
        .as_deref()
        .map(|root| root.join(".ready-set.toml"))
        .filter(|p| p.is_file());

    env::EnvContract {
        dispatcher_version: env!("CARGO_PKG_VERSION")
            .parse()
            .unwrap_or_else(|_| semver::Version::new(0, 0, 0)),
        project_root,
        config_path,
        output: globals.output.unwrap_or(OutputMode::Human),
        log: globals.log.unwrap_or(LogLevel::Normal),
        color: globals.color.unwrap_or(ColorMode::Auto),
    }
}