holochain_scaffolding_cli 0.4000.4

CLI to easily generate and modify holochain apps
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
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

use std::collections::HashSet;

use crate::error::{ScaffoldError, ScaffoldResult};

/// Returns an error if the given string is invalid due to it being a reserved word
pub fn check_for_reserved_keywords(string_to_check: &str) -> ScaffoldResult<()> {
    let reserved_holochain_words_set = HashSet::from(HOLOCHAIN_RESERVED_KEYWORDS);
    let reserved_rust_words_set = HashSet::from(RUST_RESERVED_KEYWORDS);
    let reserved_javascript_words_set = HashSet::from(JAVASCRIPT_RESERVED_KEYWORDS);

    if reserved_holochain_words_set.contains(string_to_check.to_ascii_lowercase().as_str()) {
        return Err(ScaffoldError::InvalidReservedWord {
            context: "holochain".to_string(),
            word: string_to_check.to_string(),
        });
    }

    if reserved_rust_words_set.contains(string_to_check.to_ascii_lowercase().as_str()) {
        return Err(ScaffoldError::InvalidReservedWord {
            context: "rust".to_string(),
            word: string_to_check.to_string(),
        });
    }

    if reserved_javascript_words_set.contains(string_to_check.to_ascii_lowercase().as_str()) {
        return Err(ScaffoldError::InvalidReservedWord {
            context: "javascript".to_string(),
            word: string_to_check.to_string(),
        });
    }

    Ok(())
}

const HOLOCHAIN_RESERVED_KEYWORDS: [&str; 16] = [
    "role",
    "hdi",
    "hdk",
    "action",
    "entry",
    "record",
    "zome",
    "dna",
    "entrytype",
    "entryhash",
    "actionhash",
    "agentpubkey",
    "anylinkablehash",
    "holohash",
    "externalhash",
    "call",
];

// <https://doc.rust-lang.org/reference/keywords.html>
const RUST_RESERVED_KEYWORDS: [&str; 50] = [
    "as", "break", "const", "continue", "crate", "else", "enum", "extern", "false", "fn", "for",
    "if", "impl", "in", "let", "loop", "match", "mod", "move", "mut", "pub", "ref", "return",
    "self", "Self", "static", "struct", "super", "trait", "true", "type", "unsafe", "use", "where",
    "while", "abstract", "async", "await", "become", "box", "do", "final", "macro", "override",
    "priv", "try", "typeof", "unsized", "virtual", "yield",
];

// <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#reserved_words>
const JAVASCRIPT_RESERVED_KEYWORDS: [&str; 35] = [
    "break",
    "case",
    "catch",
    "class",
    "const",
    "continue",
    "debugger",
    "default",
    "delete",
    "do",
    "else",
    "export",
    "extends",
    "false",
    "finally",
    "for",
    "function",
    "if",
    "import",
    "in",
    "instanceof",
    "new",
    "null",
    "return",
    "super",
    "switch",
    "this",
    "throw",
    "true",
    "try",
    "typeof",
    "var",
    "void",
    "while",
    "with",
];

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

    #[test]
    fn check_for_reserved_keywords_works() {
        let valid = check_for_reserved_keywords("Value");
        assert!(valid.is_ok());

        let invalid = check_for_reserved_keywords("static");
        assert!(invalid.is_err());

        let invalid = check_for_reserved_keywords("EntryType");
        assert!(invalid.is_err());

        let invalid = check_for_reserved_keywords("new");
        assert!(invalid.is_err());
    }
}