fallow-engine 3.24.1

Typed analysis engine facade for fallow consumers
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
use super::*;

#[test]
fn tokenize_variable_declaration() {
    let tokens = tokenize("const x = 42;");
    assert!(!tokens.is_empty());
    assert!(matches!(
        tokens[0].kind,
        TokenKind::Keyword(KeywordType::Const)
    ));
}

#[test]
fn tokenize_function_declaration() {
    let tokens = tokenize("function foo() { return 1; }");
    assert!(!tokens.is_empty());
    assert!(matches!(
        tokens[0].kind,
        TokenKind::Keyword(KeywordType::Function)
    ));
}

#[test]
fn tokenize_arrow_function() {
    let tokens = tokenize("const f = (a, b) => a + b;");
    assert!(!tokens.is_empty());
    let has_arrow = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Operator(OperatorType::Arrow)));
    assert!(has_arrow, "Should contain arrow operator");
}

#[test]
fn records_all_function_like_spans_and_nested_functions() {
    let source = r"
function declared() {
  const expression = function () { return 1; };
  const arrow = () => 2;
  const object = { method() { return 3; } };
  class Example { method() { return 4; } }
}
";
    let file = tokenize_file(&PathBuf::from("test.ts"), source, false);
    let fragments = file
        .function_spans
        .iter()
        .map(|span| &source[span.start as usize..span.end as usize])
        .collect::<Vec<_>>();

    assert!(
        fragments
            .iter()
            .any(|fragment| fragment.starts_with("function declared"))
    );
    assert!(
        fragments
            .iter()
            .any(|fragment| fragment.starts_with("function ()"))
    );
    assert!(
        fragments
            .iter()
            .any(|fragment| fragment.starts_with("() => 2"))
    );
    assert!(
        fragments
            .iter()
            .filter(|fragment| fragment.contains("return 3") || fragment.contains("return 4"))
            .count()
            >= 2
    );
}

#[test]
fn offsets_function_spans_in_embedded_script_sections() {
    let sfc_source = "<template><div /></template>\n<script>\nconst nested = () => 1;\n</script>";
    let sfc = tokenize_file(&PathBuf::from("component.vue"), sfc_source, false);
    assert_eq!(sfc.function_spans.len(), 1);
    let span = sfc.function_spans[0];
    assert_eq!(
        &sfc_source[span.start as usize..span.end as usize],
        "() => 1"
    );

    let astro_source = "---\nconst nested = () => 2;\n---\n<div />";
    let astro = tokenize_file(&PathBuf::from("component.astro"), astro_source, false);
    assert_eq!(astro.function_spans.len(), 1);
    let span = astro.function_spans[0];
    assert_eq!(
        &astro_source[span.start as usize..span.end as usize],
        "() => 2"
    );

    let mdx_source = "# Title\n\nexport const render = () => 1\n";
    let mdx = tokenize_file(&PathBuf::from("page.mdx"), mdx_source, false);
    assert_eq!(mdx.function_spans.len(), 1);
    let span = mdx.function_spans[0];
    assert_eq!(
        &mdx_source[span.start as usize..span.end as usize],
        "() => 1"
    );
}

#[test]
fn tokenize_if_else() {
    let tokens = tokenize("if (x) { y; } else { z; }");
    assert!(!tokens.is_empty());
    assert!(matches!(
        tokens[0].kind,
        TokenKind::Keyword(KeywordType::If)
    ));
    let has_else = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Else)));
    assert!(has_else, "Should contain else keyword");
}

#[test]
fn tokenize_class() {
    let tokens = tokenize("class Foo extends Bar { }");
    assert!(!tokens.is_empty());
    assert!(matches!(
        tokens[0].kind,
        TokenKind::Keyword(KeywordType::Class)
    ));
    let has_extends = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Extends)));
    assert!(has_extends, "Should contain extends keyword");
}

#[test]
fn tokenize_string_literal() {
    let tokens = tokenize("const s = \"hello\";");
    let has_string = tokens
        .iter()
        .any(|t| matches!(&t.kind, TokenKind::StringLiteral(s) if s == "hello"));
    assert!(has_string, "Should contain string literal");
}

#[test]
fn tokenize_boolean_literal() {
    let tokens = tokenize("const b = true;");
    let has_bool = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::BooleanLiteral(true)));
    assert!(has_bool, "Should contain boolean literal");
}

#[test]
fn tokenize_null_literal() {
    let tokens = tokenize("const n = null;");
    let has_null = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::NullLiteral));
    assert!(has_null, "Should contain null literal");
}

#[test]
fn tokenize_empty_file() {
    let tokens = tokenize("");
    assert!(tokens.is_empty());
}

#[test]
fn tokenize_ts_interface() {
    let tokens = tokenize("interface Foo { bar: string; baz: number; }");
    let has_interface = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Interface)));
    assert!(has_interface, "Should contain interface keyword");
    let has_bar = tokens
        .iter()
        .any(|t| matches!(&t.kind, TokenKind::Identifier(name) if name == "bar"));
    assert!(has_bar, "Should contain property name 'bar'");
    let has_string = tokens
        .iter()
        .any(|t| matches!(&t.kind, TokenKind::Identifier(name) if name == "string"));
    assert!(has_string, "Should contain type 'string'");
    assert!(
        tokens.len() >= 10,
        "Interface should produce sufficient tokens, got {}",
        tokens.len()
    );
}

#[test]
fn tokenize_ts_type_alias() {
    let tokens = tokenize("type Result = { ok: boolean; error: string; }");
    let has_type = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Type)));
    assert!(has_type, "Should contain type keyword");
}

#[test]
fn tokenize_ts_enum() {
    let tokens = tokenize("enum Color { Red, Green, Blue }");
    let has_enum = tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Enum)));
    assert!(has_enum, "Should contain enum keyword");
    let has_red = tokens
        .iter()
        .any(|t| matches!(&t.kind, TokenKind::Identifier(name) if name == "Red"));
    assert!(has_red, "Should contain enum member 'Red'");
}

#[test]
fn tokenize_jsx_element() {
    let tokens =
        tokenize_tsx("const x = <div className=\"foo\"><Button onClick={handler} /></div>;");
    let has_div = tokens
        .iter()
        .any(|t| matches!(&t.kind, TokenKind::Identifier(name) if name == "div"));
    assert!(has_div, "Should contain JSX element name 'div'");
    let has_classname = tokens
        .iter()
        .any(|t| matches!(&t.kind, TokenKind::Identifier(name) if name == "className"));
    assert!(has_classname, "Should contain JSX attribute 'className'");
    let brackets = tokens
        .iter()
        .filter(|t| {
            matches!(
                t.kind,
                TokenKind::Punctuation(
                    PunctuationType::OpenBracket | PunctuationType::CloseBracket,
                )
            )
        })
        .count();
    assert!(
        brackets >= 4,
        "Should contain JSX angle brackets, got {brackets}"
    );
}

#[test]
fn tokenize_vue_sfc_extracts_script_block() {
    let vue_source = r#"<template><div>Hello</div></template>
<script lang="ts">
import { ref } from 'vue';
const count = ref(0);
</script>"#;
    let path = PathBuf::from("Component.vue");
    let result = tokenize_file(&path, vue_source, false);
    assert!(!result.tokens.is_empty(), "Vue SFC should produce tokens");
    let has_import = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Import)));
    assert!(has_import, "Should tokenize import in <script> block");
    let has_const = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Const)));
    assert!(has_const, "Should tokenize const in <script> block");
    assert!(
        has_identifier(&result.tokens, "template") && has_identifier(&result.tokens, "div"),
        "Should tokenize template markup"
    );
}

#[test]
fn tokenize_svelte_sfc_extracts_script_block() {
    let svelte_source = r"<script>
let count = 0;
function increment() { count += 1; }
</script>
<button on:click={increment}>{count}</button>";
    let path = PathBuf::from("Component.svelte");
    let result = tokenize_file(&path, svelte_source, false);
    assert!(
        !result.tokens.is_empty(),
        "Svelte SFC should produce tokens"
    );
    let has_let = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Let)));
    assert!(has_let, "Should tokenize let in <script> block");
    let has_function = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Function)));
    assert!(has_function, "Should tokenize function in <script> block");
    assert!(
        has_identifier(&result.tokens, "button") && has_identifier(&result.tokens, "on"),
        "Should tokenize Svelte markup"
    );
}

#[test]
fn tokenize_vue_sfc_adjusts_span_offsets() {
    let vue_source = "<template><div/></template>\n<script>\nconst x = 1;\n</script>";
    let path = PathBuf::from("Test.vue");
    let result = tokenize_file(&path, vue_source, false);
    for token in &result.tokens {
        if matches!(token.kind, TokenKind::Boundary(_)) {
            continue;
        }
        assert!(
            token.span.end as usize <= vue_source.len(),
            "Token span end ({}) should stay inside the full SFC source",
            token.span.end
        );
        let text = &vue_source[token.span.start as usize..token.span.end as usize];
        assert!(
            !text.is_empty(),
            "Token span should recover non-empty text from full SFC source"
        );
    }
}

#[test]
fn tokenize_astro_extracts_frontmatter() {
    let astro_source = "---\nimport { Layout } from '../layouts/Layout.astro';\nconst title = 'Home';\n---\n<Layout title={title}><h1>Hello</h1></Layout>";
    let path = PathBuf::from("page.astro");
    let result = tokenize_file(&path, astro_source, false);
    assert!(
        !result.tokens.is_empty(),
        "Astro frontmatter should produce tokens"
    );
    let has_import = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Import)));
    assert!(has_import, "Should tokenize import in frontmatter");
    assert!(
        has_identifier(&result.tokens, "layout") && has_identifier(&result.tokens, "h1"),
        "Should tokenize Astro template markup"
    );
}

#[test]
fn tokenize_astro_without_frontmatter_tokenizes_template() {
    let astro_source = "<html><body>Hello</body></html>";
    let path = PathBuf::from("page.astro");
    let result = tokenize_file(&path, astro_source, false);
    assert!(
        has_identifier(&result.tokens, "html") && has_identifier(&result.tokens, "body"),
        "Astro without frontmatter should tokenize template markup"
    );
}

#[test]
fn tokenize_astro_adjusts_span_offsets() {
    let astro_source = "---\nconst x = 1;\n---\n<div/>";
    let path = PathBuf::from("page.astro");
    let result = tokenize_file(&path, astro_source, false);
    assert!(!result.tokens.is_empty());
    for token in &result.tokens {
        assert!(
            token.span.start >= 4,
            "Token span start ({}) should be offset into the full astro source",
            token.span.start
        );
    }
}

#[test]
fn tokenize_mdx_extracts_imports_and_exports() {
    let mdx_source = "import { Button } from './Button';\nexport const meta = { title: 'Hello' };\n\n# Hello World\n\n<Button>Click me</Button>";
    let path = PathBuf::from("page.mdx");
    let result = tokenize_file(&path, mdx_source, false);
    assert!(
        !result.tokens.is_empty(),
        "MDX should produce tokens from imports/exports"
    );
    let has_import = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Import)));
    assert!(has_import, "Should tokenize import in MDX");
    let has_export = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Keyword(KeywordType::Export)));
    assert!(has_export, "Should tokenize export in MDX");
}

#[test]
fn tokenize_mdx_without_statements_returns_empty() {
    let mdx_source = "# Just Markdown\n\nNo imports or exports here.";
    let path = PathBuf::from("page.mdx");
    let result = tokenize_file(&path, mdx_source, false);
    assert!(
        result.tokens.is_empty(),
        "MDX without imports/exports should produce no tokens"
    );
}

#[test]
fn tokenize_mdx_recovers_rejected_blocks_and_maps_source_spans() {
    let source = "# Title\n\nimport data from './the-api' before you begin.\n\nexport const meta = {\n  title: 'Mapped',\n  enabled: true,\n};\n";
    let result = tokenize_file(&PathBuf::from("page.mdx"), source, false);

    assert!(
        !result.tokens.is_empty(),
        "the valid export should tokenize"
    );
    let export_offset = u32::try_from(source.find("export const").unwrap()).unwrap();
    assert!(
        result
            .tokens
            .iter()
            .all(|token| token.span.start >= export_offset),
        "every token should map to the original export block"
    );
    assert!(
        result
            .function_spans
            .iter()
            .all(|span| span.start >= export_offset),
        "function spans should use original MDX offsets"
    );
}

#[test]
fn tokenize_css_returns_tokens() {
    let css_source = ".foo { color: red; }\n.bar { font-size: 16px; }";
    let path = PathBuf::from("styles.css");
    let result = tokenize_file(&path, css_source, false);
    assert!(
        has_identifier(&result.tokens, "foo")
            && has_identifier(&result.tokens, "color")
            && has_identifier(&result.tokens, "font-size"),
        "CSS files should produce selector and declaration tokens"
    );
    assert!(result.line_count >= 1);
}

#[test]
fn tokenize_scss_returns_tokens() {
    let scss_source = "$color: red;\n.foo { color: $color; }";
    let path = PathBuf::from("styles.scss");
    let result = tokenize_file(&path, scss_source, false);
    assert!(
        has_identifier(&result.tokens, "$color") && has_identifier(&result.tokens, "foo"),
        "SCSS files should produce variable and selector tokens"
    );
}

#[test]
fn tokenize_less_and_sass_return_tokens() {
    let less = tokenize_file(
        &PathBuf::from("styles.less"),
        "@color: red;\n.foo { color: @color; }",
        false,
    );
    assert!(has_identifier(&less.tokens, "@color"));

    let sass = tokenize_file(
        &PathBuf::from("styles.sass"),
        "$color: red\n.foo\n  color: $color",
        false,
    );
    assert!(has_identifier(&sass.tokens, "$color"));
}

#[test]
fn tokenize_sfc_ignores_commented_out_template_blocks() {
    let source =
        "<!-- <template><IgnoredThing /></template> -->\n<template><UsedThing /></template>";
    let result = tokenize_file(&PathBuf::from("Component.vue"), source, false);
    assert!(!has_identifier(&result.tokens, "ignoredthing"));
    assert!(has_identifier(&result.tokens, "usedthing"));
}

#[test]
fn tokenize_sfc_style_src_does_not_tokenize_external_reference_as_style_body() {
    let source = r#"<template><div /></template><style src="./theme.css"></style>"#;
    let result = tokenize_file(&PathBuf::from("Component.vue"), source, false);
    assert!(!has_identifier(&result.tokens, "theme"));
}

fn has_identifier(tokens: &[SourceToken], name: &str) -> bool {
    tokens
        .iter()
        .any(|token| matches!(&token.kind, TokenKind::Identifier(value) if value == name))
}

#[test]
fn file_tokens_line_count_matches_source() {
    let source = "const x = 1;\nconst y = 2;\nconst z = 3;";
    let path = PathBuf::from("test.ts");
    let result = tokenize_file(&path, source, false);
    assert_eq!(result.line_count, 3);
    assert_eq!(result.source, source);
}

#[test]
fn file_tokens_line_count_minimum_is_one() {
    let path = PathBuf::from("test.ts");
    let result = tokenize_file(&path, "", false);
    assert_eq!(result.line_count, 1, "Empty file should have line_count 1");
}

#[test]
fn js_file_with_jsx_retries_as_jsx() {
    let jsx_code = r#"
function App() {
return (
    <div className="app">
        <h1>Hello World</h1>
        <p>Welcome to the app</p>
    </div>
);
}
"#;
    let path = PathBuf::from("app.js");
    let result = tokenize_file(&path, jsx_code, false);
    let has_brackets = result
        .tokens
        .iter()
        .any(|t| matches!(t.kind, TokenKind::Punctuation(PunctuationType::OpenBracket)));
    assert!(
        has_brackets,
        "JSX fallback retry should produce JSX tokens from .js file"
    );
}

#[test]
fn tokenize_no_extension_uses_default_source_type() {
    let path = PathBuf::from("Makefile");
    let result = tokenize_file(&path, "const x = 1;", false);
    assert!(result.line_count >= 1);
}