luau-syntax 0.732.0

Luau lexer, parser, AST, CST, and source utilities
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

use luau_syntax::allocator::AstArena;
use luau_syntax::ast_names::AstNameTable;
use luau_syntax::location::Position;
use luau_syntax::parser::{self, ParseOptions, ParseResult};

fn with_parse<R>(
    source: &str,
    options: ParseOptions,
    f: impl for<'ast> FnOnce(ParseResult<'ast>) -> R,
) -> R {
    let arena = AstArena::new();
    let mut names = AstNameTable::new(&arena);
    let result = parser::parse(source, &arena, &mut names, options).unwrap();
    f(result)
}
fn with_comments<R>(source: &str, f: impl for<'ast> FnOnce(ParseResult<'ast>) -> R) -> R {
    with_parse(
        source,
        ParseOptions::default().with_comment_capture(true),
        f,
    )
}

fn module_source() -> &'static str {
    r#"
        --!strict
        local foo = {}
        function foo:bar() end

        --[[
            foo:
        ]] foo:bar()

        --[[]]--[[]] -- Two distinct comments that have zero characters of space between them.
    "#
}

// Module.test.cpp: is_within_comment
#[test]
fn source_module_is_within_comment() {
    with_comments(module_source(), |result| {
        assert_eq!(result.metadata.comment_locations.len(), 5);

        assert!(result.is_within_comment(Position::new(1, 15)));
        assert!(result.is_within_comment(Position::new(6, 16)));
        assert!(result.is_within_comment(Position::new(9, 13)));
        assert!(result.is_within_comment(Position::new(9, 14)));

        assert!(!result.is_within_comment(Position::new(2, 15)));
        assert!(!result.is_within_comment(Position::new(7, 10)));
        assert!(!result.is_within_comment(Position::new(7, 11)));
    });
}

// Module.test.cpp: is_within_comment_parse_result
#[test]
fn is_within_comment_parse_result() {
    with_comments(module_source(), |result| {
        assert_eq!(result.metadata.comment_locations.len(), 5);

        assert!(result.is_within_comment(Position::new(1, 15)));
        assert!(result.is_within_comment(Position::new(6, 16)));
        assert!(result.is_within_comment(Position::new(9, 13)));
        assert!(result.is_within_comment(Position::new(9, 14)));

        assert!(!result.is_within_comment(Position::new(2, 15)));
        assert!(!result.is_within_comment(Position::new(7, 10)));
        assert!(!result.is_within_comment(Position::new(7, 11)));
    });
}