command-surface 0.4.0

Glyph-based command rendering and semantic metadata for the Koi 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

use crate::Glyph;
use std::hash::Hash;

pub trait Category: Copy + Eq + Hash + Glyph + 'static {
    fn label(&self) -> &'static str;
    fn order(&self) -> u8;

    /// CLI prefix for commands in this category (e.g. "certmesh ", "mdns ").
    /// Used by compact/stripped rendering to derive short command names.
    fn cli_prefix(&self) -> &'static str {
        ""
    }

    /// Short CLI name shown in overview mode (e.g. "certmesh", "mdns").
    fn cli_name(&self) -> &'static str {
        self.label()
    }

    /// One-line description of what this category does.
    fn description(&self) -> &'static str {
        ""
    }
}

pub trait Tag: Copy + Eq + Hash + Glyph + 'static {
    fn label(&self) -> &'static str;

    /// Whether this tag conveys *actionable* information worth showing
    /// prominently (destructive, elevated, streaming).  Non-highlight tags
    /// (mutating, read-only, admin) are hidden in compact/highlight modes.
    fn highlight(&self) -> bool {
        true
    }
}

pub trait Scope: Copy + Eq + Hash + Glyph + 'static {
    fn label(&self) -> &'static str;

    /// Whether this is the default/public scope.  Commands with the default
    /// scope are shown first in compact summaries.
    fn is_default(&self) -> bool {
        true
    }
}