alp-core 0.1.6

Pure domain logic for the ALP SDK tooling: board.yaml model/validate, build-plan + system-manifest contracts, presets, and debug/doctor reports. Shared by the `alp` CLI.
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

// SPDX-License-Identifier: Apache-2.0
//! Effective-config preview helpers (Rust mirror of LSP preview payload).

use serde::Serialize;

use crate::model::{BoardModel, normalize_board_model};
pub use crate::project::ProjectContext;
use crate::validate::{ParseError, parse_board_model};

/// Serializable effective-config preview payload (mirrors the LSP preview JSON).
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct EffectiveConfigPreviewPayload {
    /// Payload schema version; currently always `"1"`.
    pub schema_version: String,
    /// Timestamp the payload was generated (caller-supplied, ISO-8601 string).
    pub generated_at: String,
    /// Path to the source `board.yaml`.
    pub board_yaml_path: String,
    /// Resolved project context (workspace/SDK roots, west cwd, python binary).
    pub project_context: ProjectContext,
    /// Parsed and normalized board model — the effective configuration.
    pub effective_config: BoardModel,
}

/// Create an effective-config preview payload equivalent to TS
/// `createEffectiveConfigPreviewPayload`:
/// parse board.yaml, normalize it, and wrap with metadata.
pub fn create_effective_config_preview_payload(
    document_text: &str,
    board_yaml_path: &str,
    project_context: ProjectContext,
    generated_at: impl Into<String>,
) -> Result<EffectiveConfigPreviewPayload, ParseError> {
    let parsed = parse_board_model(document_text)?;
    let effective_config = normalize_board_model(parsed);

    Ok(EffectiveConfigPreviewPayload {
        schema_version: "1".to_string(),
        generated_at: generated_at.into(),
        board_yaml_path: board_yaml_path.to_string(),
        project_context,
        effective_config,
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn preview_payload_uses_normalized_model() {
        let text = "schema_version: 2\nos: zephyr\ncores:\n  m55_hp:\n    app: ./src\n";
        let payload = create_effective_config_preview_payload(
            text,
            "board.yaml",
            ProjectContext {
                workspace_root: Some("/ws".to_string()),
                sdk_root: Some("/sdk".to_string()),
                board_yaml_path: Some("/ws/board.yaml".to_string()),
                west_cwd: Some("/ws".to_string()),
                python_binary: "python3".to_string(),
            },
            "2026-01-01T00:00:00.000Z",
        )
        .unwrap();

        assert_eq!(payload.schema_version, "1");
        assert_eq!(payload.board_yaml_path, "board.yaml");
        assert!(payload.effective_config.os.is_none());
    }
}