usage-lib 6.0.0

Library for working with usage specs
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

use std::fmt::Display;

use kdl::{KdlEntry, KdlNode};
use serde::Serialize;

use crate::error::Result;
use crate::spec::context::ParsingContext;
use crate::spec::helpers::{string_entry, NodeHelper};

#[derive(Debug, Default, Clone, Serialize)]
#[non_exhaustive]
pub struct SpecMount {
    pub run: String,
    /// Whether a discovered command may take precedence over
    /// [`Spec::default_subcommand`](crate::Spec::default_subcommand).
    ///
    /// Off by default, because resolving a mount runs a process: with a default
    /// subcommand declared, every word that is not a known command would otherwise
    /// pay for discovery before falling back — for a task runner, that is a
    /// subprocess per task invocation. Turn it on when a discovered command should
    /// win, and accept the cost.
    pub overrides_default: bool,
}

impl SpecMount {
    /// A mount that runs `run` to produce a spec for the subcommands here.
    pub fn new(run: impl Into<String>) -> Self {
        Self {
            run: run.into(),
            overrides_default: false,
        }
    }

    /// The same, but a discovered command outranks the default subcommand.
    pub fn overriding_default(run: impl Into<String>) -> Self {
        Self {
            run: run.into(),
            overrides_default: true,
        }
    }
}

impl SpecMount {
    pub(crate) fn parse(ctx: &ParsingContext, node: &NodeHelper) -> Result<Self> {
        let mut mount = SpecMount::default();
        for (k, v) in node.props() {
            match k {
                "run" => mount.run = v.ensure_string()?,
                "overrides_default" => mount.overrides_default = v.ensure_bool()?,
                k => bail_parse!(ctx, v.entry.span(), "unsupported mount key {k}"),
            }
        }
        for child in node.children() {
            match child.name() {
                "run" => mount.run = child.arg(0)?.ensure_string()?,
                "overrides_default" => mount.overrides_default = child.arg(0)?.ensure_bool()?,
                k => bail_parse!(
                    ctx,
                    child.node.name().span(),
                    "unsupported mount value key {k}"
                ),
            }
        }
        if mount.run.is_empty() {
            bail_parse!(ctx, node.span(), "mount run is required")
        }
        Ok(mount)
    }
    pub fn usage(&self) -> String {
        format!("mount:{}", self.run)
    }
}

impl From<&SpecMount> for KdlNode {
    fn from(mount: &SpecMount) -> KdlNode {
        let mut node = KdlNode::new("mount");
        node.push(string_entry(Some("run"), &mount.run));
        if mount.overrides_default {
            node.push(KdlEntry::new_prop("overrides_default", true));
        }
        node
    }
}

impl Display for SpecMount {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.usage())
    }
}