ready-set-rust 0.1.0

Rust capability provider plugin for ready-set.
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

//! Rust capability provider plugin for `ready-set`.
//!
//! Contributes four capabilities (`workspace`, `toolchain`, `formatting`,
//! `linting`) to the readiness matrix and answers the `__ready` / `__set` /
//! `__go` lifecycle protocol per capability. The plugin requires a Cargo
//! workspace; outside one, lifecycle calls return
//! [`ExitCode::ProjectRequirementMissing`](ready_set_sdk::ExitCode::ProjectRequirementMissing).
//!
//! Contracts this provider conforms to:
//! [`capabilities.md`](https://github.com/pulsearc-ai/ReadySet/blob/main/docs/contracts/capabilities.md)
//! (descriptor and report shapes),
//! [`change-log.md`](https://github.com/pulsearc-ai/ReadySet/blob/main/docs/contracts/change-log.md)
//! (records every `__set` write for reversibility), and
//! [`ready-set-toml.md`](https://github.com/pulsearc-ai/ReadySet/blob/main/docs/contracts/ready-set-toml.md)
//! (the `.ready-set.toml` schema this provider seeds).

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

pub mod gitignore;
pub mod manifest_edit;
pub mod members;
pub mod options;
pub mod readiness;
pub mod ready_set_toml;
pub mod runner;
pub mod templates;
pub mod workflow;
pub mod workspace;

use ready_set_sdk::describe::{Describe, Platform, Stability};
use ready_set_sdk::{CapabilityDescriptor, CapabilityRelevance, CapabilityVerb, ProviderId};

/// Provider id used by this plugin's capability descriptors.
pub const PROVIDER_ID: &str = "rust";

/// Return the plugin metadata payload.
#[must_use]
pub fn describe() -> Describe {
    Describe {
        description: "Rust product capabilities".into(),
        version: env!("CARGO_PKG_VERSION")
            .parse()
            .unwrap_or_else(|_| semver::Version::new(0, 0, 0)),
        stability: Stability::Stable,
        min_dispatcher_version: "0.1.0"
            .parse()
            .unwrap_or_else(|_| semver::Version::new(0, 1, 0)),
        platforms: vec![Platform::Linux, Platform::Macos, Platform::Windows],
        project_requirements: vec!["cargo-workspace".into()],
        capabilities: rust_capabilities(),
        command_aliases: Vec::new(),
    }
}

/// Capability descriptors contributed by this plugin.
#[must_use]
pub fn rust_capabilities() -> Vec<CapabilityDescriptor> {
    vec![
        descriptor(
            "workspace",
            "Workspace",
            &[CapabilityVerb::Ready, CapabilityVerb::Set],
        ),
        descriptor(
            "toolchain",
            "Toolchain",
            &[CapabilityVerb::Ready, CapabilityVerb::Set],
        ),
        descriptor(
            "formatting",
            "Formatting",
            &[
                CapabilityVerb::Ready,
                CapabilityVerb::Set,
                CapabilityVerb::Go,
            ],
        ),
        descriptor(
            "linting",
            "Linting",
            &[
                CapabilityVerb::Ready,
                CapabilityVerb::Set,
                CapabilityVerb::Go,
            ],
        ),
    ]
}

fn descriptor(id: &str, title: &str, verbs: &[CapabilityVerb]) -> CapabilityDescriptor {
    CapabilityDescriptor {
        id: id.into(),
        title: title.into(),
        provider: ProviderId::from(PROVIDER_ID),
        verbs: verbs.to_vec(),
        default_relevance: CapabilityRelevance::Required,
    }
}