only-syntax 0.3.0

Syntax parsing and CST construction for the only task language.
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
121
122
123
124
125
126
127
128
129
130
131
132
133

use only_syntax::{format_range, format_source};
use text_size::{TextRange, TextSize};

#[test]
fn formatting_is_idempotent() {
    let source = "!version   0.3\n\n\n!var target=\"release\"\n\nbuild(\n\tprofile = \"release\",\n)\n    ?   @has( \"cargo\" )\n    & ( check,test )\n:\n\t|echo one\n\t|\n\t|  echo two\n";
    let formatted = format_source(source).expect("valid source should format");

    assert_eq!(
        formatted,
        format_source(&formatted).expect("formatted source should parse")
    );
    assert_eq!(
        formatted,
        "!version 0.3\n!var target = \"release\"\n\nbuild(profile = \"release\") ? @has(\"cargo\") & (check, test):\n    | echo one\n    |\n    |  echo two\n"
    );
}

#[test]
fn wraps_long_task_headers() {
    let source = concat!(
        "release(channel=\"nightly-build-with-a-long-channel-name\", ",
        "destination=\"production-artifact-storage-with-a-long-name\") ",
        "? @has(\"cargo\") & (sign, package) & upload shell~=bash:\n",
        "    echo unchanged  $HOME\n",
    );

    assert_eq!(
        format_source(source).expect("valid source should format"),
        concat!(
            "release(channel = \"nightly-build-with-a-long-channel-name\", destination = ",
            "\"production-artifact-storage-with-a-long-name\")\n",
            "    ? @has(\"cargo\")\n",
            "    & (sign, package)\n",
            "    & upload\n",
            "    shell~=bash\n",
            ":\n",
            "    echo unchanged  $HOME\n",
        )
    );
}

#[test]
fn wraps_headers_with_three_clauses() {
    let source = "install() ? @os(\"windows\") & _release_build shell~=pwsh:\n    echo ok\n";

    assert_eq!(
        format_source(source).expect("valid source should format"),
        "install()\n    ? @os(\"windows\")\n    & _release_build\n    shell~=pwsh\n:\n    echo ok\n"
    );
}

#[test]
fn preserves_comments_and_namespace_boundaries() {
    let source = concat!(
        "!version 0.3\n",
        "# Build tools.\n",
        "[ tools ] {\n",
        "// Keep this comment.  \n",
        "build():\n",
        "    cargo build  \n",
        "}\n",
        "root():\n",
        "    true\n",
    );

    assert_eq!(
        format_source(source).expect("valid source should format"),
        concat!(
            "!version 0.3\n",
            "\n",
            "# Build tools.\n",
            "[tools] {\n",
            "    // Keep this comment.\n",
            "    build():\n",
            "        cargo build  \n",
            "}\n",
            "\n",
            "root():\n",
            "    true\n",
        )
    );
}

#[test]
fn formats_namespace_indentation() {
    let source = "!version 0.3\n[dev] {\nrun():\n    true\n    }\n";

    assert_eq!(
        format_source(source).expect("valid source should format"),
        "!version 0.3\n\n[dev] {\n    run():\n        true\n}\n"
    );
}

#[test]
fn range_formats_one_declaration() {
    let source = "first():\n    true\nsecond( value=\"x\" ):\n\t|echo ok\n";
    let start = TextSize::from(source.find("second").expect("task should exist") as u32);
    let selection = TextRange::empty(start);

    let (range, formatted) = format_range(source, selection)
        .expect("valid source should format")
        .expect("selection should touch a task");

    assert_eq!(
        &source[usize::from(range.start())..usize::from(range.end())],
        "second( value=\"x\" ):\n\t|echo ok\n"
    );
    assert_eq!(formatted, "second(value = \"x\"):\n    | echo ok\n");
}

#[test]
fn range_formats_namespaced_task_indentation() {
    let source = "!version 0.3\n[dev] {\n    build( value=\"x\" ):\n        echo ok\n}\n";
    let start = TextSize::from(source.find("build").expect("task should exist") as u32);

    let (range, formatted) = format_range(source, TextRange::empty(start))
        .expect("valid source should format")
        .expect("selection should touch a task");

    assert_eq!(
        &source[usize::from(range.start())..usize::from(range.end())],
        "    build( value=\"x\" ):\n        echo ok\n"
    );
    assert_eq!(formatted, "    build(value = \"x\"):\n        echo ok\n");
}

#[test]
fn formatting_rejects_invalid_source() {
    assert!(format_source("broken(\n").is_err());
    assert!(format_source("build(): cargo build\n").is_err());
    assert!(format_source("build():").is_err());
}