hm-plugin-protocol 0.0.1

Wire-level data types shared between the hm binary and hm plugins.
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

//! Lifecycle hook wire types.

use schemars::JsonSchema as DeriveJsonSchema;
use serde::{Deserialize, Serialize};

use crate::events::BuildEvent;

/// Hook entry-point input. The host wraps a `BuildEvent` and tells
/// the plugin which phase this call is.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, DeriveJsonSchema)]
#[serde(deny_unknown_fields)]
pub struct HookEvent {
    pub event: BuildEvent,
    pub phase: HookPhase,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, DeriveJsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum HookPhase {
    /// May return [`HookOutcome::Abort`] to fail the build.
    Before,
    /// Read-only; the return value is discarded.
    After,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, DeriveJsonSchema)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum HookOutcome {
    /// Continue the build.
    Continue,
    /// Abort the build. Only honoured for `phase: Before`; ignored on
    /// `After` (with a host-side warning).
    Abort { reason: String },
}

/// Subset of [`crate::hook::HookEvent`] discriminants used at manifest time.
///
/// The manifest declares *what* events the plugin wants, not the per-event
/// payload. Kept in this file so plugin authors only import one module.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, DeriveJsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum HookEventKind {
    BuildStart,
    StepQueued,
    StepStart,
    StepLog,
    StepCacheHit,
    StepEnd,
    BuildEnd,
}