fallow-extract 3.32.0

AST extraction engine for fallow codebase intelligence (parser, complexity, SFC / Astro / MDX / CSS)
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

//! A top-level `declare module 'pkg' { ... }` in a module file augments the
//! package, so it records the package as a type-only reference. In a script
//! file the same syntax declares an ambient module and records nothing.

use crate::tests::parse_ts as parse_source;

fn type_package_references(source: &str) -> Vec<String> {
    parse_source(source).type_package_references.to_vec()
}

#[test]
fn augmentation_in_a_module_file_references_the_package() {
    let cases: &[(&str, &[&str])] = &[
        (
            "declare module '@x/slots' { interface Map { a: string } }\nexport const a = 1;\n",
            &["@x/slots"],
        ),
        (
            "import type {} from './local';\ndeclare module 'pkg/sub/path' { interface A {} }\n",
            &["pkg"],
        ),
        (
            "declare module 'pkg' { interface A {} }\nexport = {};\n",
            &["pkg"],
        ),
        (
            "import fs = require('fs');\ndeclare module 'pkg' { interface A {} }\n",
            &["pkg"],
        ),
    ];
    for (source, expected) in cases {
        assert_eq!(
            type_package_references(source),
            *expected,
            "source: {source}"
        );
    }
}

#[test]
fn ambient_declaration_or_non_package_name_references_nothing() {
    let cases: &[&str] = &[
        // Script file: an ambient module shim.
        "declare module 'untyped-lib' { export const x: number }\n",
        // `export as namespace` alone does not make a module file.
        "export as namespace Lib;\ndeclare module 'untyped-lib' { export const x: number }\n",
        // Wildcard pattern, relative path and shorthand form.
        "declare module '*.svg' { const s: string; export default s }\nexport {};\n",
        "declare module './local' { interface A {} }\nexport {};\n",
        "declare module 'pkg';\nexport {};\n",
    ];
    for source in cases {
        assert_eq!(
            type_package_references(source),
            Vec::<String>::new(),
            "source: {source}"
        );
    }
}