fta 3.0.1

Fast TypeScript Analyzer
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

#[cfg(test)]
mod tests {
    use crate::parse::parse_module;

    #[test]
    fn test_parse_module() {
        let ts_code = r#"
            function add(a: number, b: number): number {
                return a + b;
            }

            const myResult = add(23, 56);
            console.log(myResult); // 79
        "#;

        let (parsed_module, line_count) = parse_module(ts_code, true, false);

        assert!(parsed_module.is_ok(), "Failed to parse TypeScript code");
        assert_eq!(line_count, 5, "Incorrect line count");
    }

    #[test]
    fn it_ignores_comments() {
        let ts_code = r#"
            /*
            Block comment with multiple lines.
            */
            function add(a: number, b: number): number {
                return a + b;
            }
            
            // line comment
            const myResult = add(23, 56);
            /* block comment with single line */
            console.log(myResult); // Trailing comments don't count towards the comment count.
        "#;

        let (parsed_module, line_count) = parse_module(ts_code, true, false);

        assert!(parsed_module.is_ok(), "Failed to parse TypeScript code");
        assert_eq!(line_count, 5, "Incorrect line count");
    }

    #[test]
    fn it_can_be_configured_to_include_comments_in_the_line_count() {
        /*
           The below code includes 10 lines of code, but 12 lines in total due to a leading \n and the \n on like 7.
           These are filtered regardless of the include_comments flag.
        */
        let ts_code = r#"
            /*
            Block comment with multiple lines.
            */
            function add(a: number, b: number): number {
                return a + b;
            }

            // line comment
            const myResult = add(23, 56);
            /* block comment with single line */
            console.log(myResult); // Trailing comments don't count towards the comment count.
        "#;

        let (parsed_module, line_count) = parse_module(ts_code, true, true);

        assert!(parsed_module.is_ok(), "Failed to parse TypeScript code");
        assert_eq!(line_count, 10, "Incorrect line count");
    }

    #[test]
    fn it_parses_decorators() {
        let ts_code = r#"
            import { IsNumber, IsOptional } from 'class-validator';

            export class RulesReward {
                @IsNumber()
                @IsOptional()
                points?: number;
            }
        "#;

        let (parsed_module, _line_count) = parse_module(ts_code, true, false);
        assert!(parsed_module.is_ok(), "Failed to parse decorators");
    }

    #[test]
    fn it_parses_import_attributes() {
        let ts_code = r#"
            import data from './data.json' with { type: 'json' };
            import styles from './styles.css' with { type: 'css' };

            console.log(data);
        "#;

        let (parsed_module, line_count) = parse_module(ts_code, true, false);

        assert!(
            parsed_module.is_ok(),
            "Failed to parse import attributes (import with syntax): {:?}",
            parsed_module.err()
        );
        assert_eq!(line_count, 3, "Incorrect line count");
    }

    #[test]
    fn it_parses_various_import_attribute_forms() {
        let ts_code = r#"
            import data from './data.json' with { type: 'json' };
            import config from './config.json' with { type: 'json', assert: true };
            import { default as content } from './content.json' with { type: 'json' };
            import * as allData from './all-data.json' with { type: 'json' };
            const result = { data, config, content, allData };
        "#;

        let (parsed_module, line_count) = parse_module(ts_code, true, false);

        assert!(
            parsed_module.is_ok(),
            "Failed to parse various import attribute forms: {:?}",
            parsed_module.err()
        );
        assert_eq!(line_count, 5, "Incorrect line count");
    }
}