silicon-accounts-cli 0.2.0

The `accounts` command line for Silicon Accounts: sign Carbons and Silicons in, manage accounts, Silicons and apps
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Docs bundled into the binary (`accounts docs [topic]`), so they always match the CLI.

/// (topic, one-line summary, content)
pub const TOPICS: &[(&str, &str, &str)] = &[
    (
        "getting-started",
        "Sign in, check who you are, and the first commands to run",
        include_str!("../docs/getting-started.md"),
    ),
    (
        "silicons",
        "How a Silicon gets an account, signs in, and signs into apps",
        include_str!("../docs/silicons.md"),
    ),
    (
        "custodians",
        "Being a Silicon's custodian: accept, rotate STKs, transfer, delete",
        include_str!("../docs/custodians.md"),
    ),
    (
        "apps",
        "Add sign-in to an app: hosted pages, iframe, snippet, tokens, user base",
        include_str!("../docs/apps.md"),
    ),
    (
        "proofs",
        "User verification and App verification proofs: issue, verify, refresh, revoke",
        include_str!("../docs/proofs.md"),
    ),
    (
        "webhooks",
        "App and Silicon webhooks: events, signatures, retries, replay",
        include_str!("../docs/webhooks.md"),
    ),
    (
        "imports",
        "Bring an app's existing users: columns, matching, outcomes",
        include_str!("../docs/imports.md"),
    ),
    (
        "ids",
        "uuid vs c:id / si:id, id rules, reservations, membership ids",
        include_str!("../docs/ids.md"),
    ),
    (
        "troubleshooting",
        "Exit codes, error codes and how to fix the common ones",
        include_str!("../docs/troubleshooting.md"),
    ),
    (
        "links",
        "GitHub repo, online docs, the Rust package",
        include_str!("../docs/links.md"),
    ),
];

/// The content of a topic (accepts a few aliases).
pub fn find(topic: &str) -> Option<(&'static str, &'static str)> {
    let wanted = topic.trim().to_ascii_lowercase().replace([' ', '_'], "-");
    let wanted = match wanted.as_str() {
        "start" | "getting" | "intro" | "login" | "quickstart" => "getting-started",
        "silicon" | "stk" => "silicons",
        "custodian" | "transfer" => "custodians",
        "app" | "sign-in" | "signin" | "oauth" | "tokens" => "apps",
        "proof" | "user_verification" | "app_verification" | "app-verification"
        | "user-verification" => "proofs",
        "webhook" | "events" => "webhooks",
        "import" => "imports",
        "id" | "uuid" | "identifiers" => "ids",
        "errors" | "exit-codes" | "help" => "troubleshooting",
        "link" | "repo" | "github" | "crate" => "links",
        other => other,
    };
    TOPICS
        .iter()
        .find(|(name, _, _)| *name == wanted)
        .map(|(name, _, content)| (*name, *content))
}

/// The topic list as text.
pub fn index() -> String {
    let width = TOPICS.iter().map(|(n, _, _)| n.len()).max().unwrap_or(0);
    let mut text = String::from("Bundled docs (accounts docs <topic>):\n\n");
    for (name, summary, _) in TOPICS {
        text.push_str(&format!("  {name:<width$}  {summary}\n"));
    }
    text.push_str("\nOnline: https://developers.teamofsilicons.com/docs/accounts\n");
    text
}

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

    #[test]
    fn every_topic_has_content_and_aliases_resolve() {
        for (name, summary, content) in TOPICS {
            assert!(!summary.is_empty());
            assert!(content.starts_with("# "), "{name} must start with a title");
            assert!(content.len() > 400, "{name} is too short");
            for banned in [
                "organisation",
                "organization",
                "frontend",
                "backend",
                " AI ",
                "human",
                "Human",
            ] {
                assert!(
                    !content.contains(banned),
                    "{name} uses banned vocabulary `{banned}`"
                );
            }
        }
        assert_eq!(find("silicon").map(|(n, _)| n), Some("silicons"));
        for alias in [
            "App verification",
            "User verification",
            "App verification",
            "User verification",
        ] {
            assert_eq!(find(alias).map(|(n, _)| n), Some("proofs"));
        }
        assert!(find("nope").is_none());
    }
}