fallow-core 3.35.0

Internal detector backend for fallow-engine and fallow-api
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
use super::common::{create_config, fixture_path};

#[test]
fn entry_exports_skipped_by_default() {
    let root = fixture_path("entry-export-validation");
    let config = create_config(root);
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let unused_export_names: Vec<&str> = results
        .unused_exports
        .iter()
        .map(|e| e.export.export_name.as_str())
        .collect();

    assert!(
        !unused_export_names.contains(&"meatdata"),
        "meatdata should not be flagged (entry exports skipped by default), found: {unused_export_names:?}"
    );
    assert!(
        !unused_export_names.contains(&"config"),
        "config should not be flagged (entry exports skipped by default), found: {unused_export_names:?}"
    );
}

#[test]
fn entry_exports_detected_when_include_entry_exports_enabled() {
    let root = fixture_path("entry-export-validation");
    let mut config = create_config(root);
    config.include_entry_exports = true;
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let unused_export_names: Vec<&str> = results
        .unused_exports
        .iter()
        .map(|e| e.export.export_name.as_str())
        .collect();

    assert!(
        unused_export_names.contains(&"meatdata"),
        "meatdata should be flagged with include_entry_exports, found: {unused_export_names:?}"
    );
    assert!(
        unused_export_names.contains(&"config"),
        "config should be flagged with include_entry_exports, found: {unused_export_names:?}"
    );

    assert!(
        !unused_export_names.contains(&"helper"),
        "helper should not be flagged (imported by consumer.ts), found: {unused_export_names:?}"
    );
}

#[test]
fn entry_exports_detected_via_config_file_include_entry_exports() {
    let root = fixture_path("entry-export-validation-config");
    let (loaded, _path) = fallow_config::FallowConfig::find_and_load(&root)
        .expect("config load")
        .expect("fixture has .fallowrc.json");
    assert!(loaded.include_entry_exports);
    let config = loaded.resolve(
        root,
        fallow_config::OutputFormat::Human,
        1,
        true,
        true,
        None,
    );
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let unused_export_names: Vec<&str> = results
        .unused_exports
        .iter()
        .map(|e| e.export.export_name.as_str())
        .collect();

    assert!(
        unused_export_names.contains(&"meatdata"),
        "meatdata should be flagged via config file, found: {unused_export_names:?}"
    );
    assert!(
        unused_export_names.contains(&"config"),
        "config should be flagged via config file, found: {unused_export_names:?}"
    );
    assert!(
        !unused_export_names.contains(&"helper"),
        "helper should not be flagged (imported by consumer.ts), found: {unused_export_names:?}"
    );
}

#[test]
fn vitest_config_default_export_is_framework_used_with_include_entry_exports() {
    let root = fixture_path("vitest-include-entry-exports-workspace");
    let mut config = create_config(root);
    config.include_entry_exports = true;
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let unused_exports: Vec<(String, String)> = results
        .unused_exports
        .iter()
        .map(|export| {
            (
                export
                    .export
                    .path
                    .strip_prefix(&config.root)
                    .unwrap_or(&export.export.path)
                    .to_string_lossy()
                    .replace('\\', "/"),
                export.export.export_name.clone(),
            )
        })
        .collect();

    assert!(
        !unused_exports.iter().any(|(path, export)| {
            path == "packages/web/charts/vitest.config.mts" && export == "default"
        }),
        "Vitest config default export should be framework-used, found: {unused_exports:?}"
    );
}

#[test]
fn vite_config_default_export_is_framework_used_with_include_entry_exports() {
    let root = fixture_path("vite-include-entry-exports-workspace");
    let mut config = create_config(root);
    config.include_entry_exports = true;
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let unused_exports: Vec<(String, String)> = results
        .unused_exports
        .iter()
        .map(|export| {
            (
                export
                    .export
                    .path
                    .strip_prefix(&config.root)
                    .unwrap_or(&export.export.path)
                    .to_string_lossy()
                    .replace('\\', "/"),
                export.export.export_name.clone(),
            )
        })
        .collect();

    assert!(
        !unused_exports.iter().any(|(path, export)| {
            path == "packages/web/charts/vite.config.mts" && export == "default"
        }),
        "Vite config default export should be framework-used, found: {unused_exports:?}"
    );
}

#[test]
fn postcss_config_default_export_is_framework_used_with_include_entry_exports() {
    // Issue #3691: PostCSS reads only the default export of postcss.config.*,
    // so under includeEntryExports it is used and a named export is not.
    let root = fixture_path("postcss-include-entry-exports");
    let mut config = create_config(root);
    config.include_entry_exports = true;
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let unused_exports: Vec<(String, String)> = results
        .unused_exports
        .iter()
        .map(|export| {
            (
                export
                    .export
                    .path
                    .strip_prefix(&config.root)
                    .unwrap_or(&export.export.path)
                    .to_string_lossy()
                    .replace('\\', "/"),
                export.export.export_name.clone(),
            )
        })
        .collect();

    assert!(
        !unused_exports
            .iter()
            .any(|(path, export)| path == "postcss.config.mjs" && export == "default"),
        "PostCSS config default export should be framework-used, found: {unused_exports:?}"
    );
    assert!(
        unused_exports
            .iter()
            .any(|(path, export)| path == "postcss.config.mjs" && export == "unusedHelper"),
        "a named export of postcss.config.mjs is not read by PostCSS, found: {unused_exports:?}"
    );
}

fn config_default_credit_findings(include_entry_exports: bool) -> Vec<(String, String)> {
    let root = fixture_path("config-default-export-credit");
    let mut config = create_config(root);
    config.include_entry_exports = include_entry_exports;
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let mut findings: Vec<(String, String)> = results
        .unused_exports
        .iter()
        .map(|export| {
            (
                export
                    .export
                    .path
                    .strip_prefix(&config.root)
                    .unwrap_or(&export.export.path)
                    .to_string_lossy()
                    .replace('\\', "/"),
                export.export.export_name.clone(),
            )
        })
        .collect();
    findings.sort();
    findings
}

fn config_file_exports_findings(include_entry_exports: bool) -> Vec<(String, String)> {
    let root = fixture_path("config-file-exports-credit");
    let mut config = create_config(root);
    config.include_entry_exports = include_entry_exports;
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let mut findings: Vec<(String, String)> = results
        .unused_exports
        .iter()
        .map(|export| {
            (
                export
                    .export
                    .path
                    .strip_prefix(&config.root)
                    .unwrap_or(&export.export.path)
                    .to_string_lossy()
                    .replace('\\', "/"),
                export.export.export_name.clone(),
            )
        })
        .collect();
    findings.sort();
    findings
}

fn finding(path: &str, export: &str) -> (String, String) {
    (path.to_owned(), export.to_owned())
}

#[test]
fn config_file_default_export_is_used_with_include_entry_exports() {
    // Issue #3691: a tool loads its config file and reads the default export.
    // Every form of the default export gets the credit: an object, a
    // defineConfig(...) call, an arrow function, an async function and
    // `export { config as default }`. A config file of a workspace package
    // gets the credit too. A named export of a config file stays reportable.
    let findings = config_default_credit_findings(true);

    for credited in [
        "tailwind.config.js",
        "playwright.config.js",
        "jest.config.js",
        "rollup.config.js",
        "typedoc.config.js",
        "graphql.config.js",
        "gatsby-config.js",
        "packages/web/uno.config.js",
    ] {
        assert!(
            !findings.contains(&finding(credited, "default")),
            "the default export of {credited} is read by its tool, found: {findings:?}"
        );
    }
    assert!(
        findings.contains(&finding("tailwind.config.js", "unusedHelper")),
        "a named export of a config file stays reportable, found: {findings:?}"
    );
}

#[test]
fn opted_out_config_patterns_keep_default_export_reportable() {
    // Gatsby reads named API exports from gatsby-node. `codegen*` also
    // matches source files such as src/codegenUtils.js. The Codegen,
    // Serverless and Vercel credit is anchored at the root, so only the root
    // config file gets it.
    let findings = config_default_credit_findings(true);

    for credited in ["codegen.js", "serverless.js", "vercel.js"] {
        assert!(
            !findings.contains(&finding(credited, "default")),
            "the root config file {credited} gets the anchored credit, found: {findings:?}"
        );
    }
    for reported in ["gatsby-node.js", "src/codegenUtils.js"] {
        assert!(
            findings.contains(&finding(reported, "default")),
            "the default export of {reported} gets no credit, found: {findings:?}"
        );
    }
}

#[test]
fn config_default_credit_does_not_change_default_mode() {
    // Without includeEntryExports a config file is an entry point, and fallow
    // skips its exports. The credit must not make fallow analyse the file, so
    // the unused named export of tailwind.config.js stays unreported.
    let findings = config_default_credit_findings(false);

    assert_eq!(
        findings,
        vec![finding("src/codegenUtils.js", "default")],
        "default-mode output must not change"
    );
}

#[test]
fn config_file_exports_are_used_with_include_entry_exports() {
    // These tools list their config file only as always-used, or read named
    // exports. Each config file gets the credit for the exports its tool reads.
    let findings = config_file_exports_findings(true);

    for credited in [
        "capacitor.config.ts",
        "sanity.config.ts",
        "sanity.cli.ts",
        "nitro.config.ts",
        "svgo.config.js",
        "svgr.config.js",
        ".svgrrc.js",
        "kysely.config.ts",
        "openapi-ts.config.ts",
        "remix.config.js",
        "i18next.config.ts",
        ".vitepress/config.ts",
        "cspell.config.js",
        "package.config.ts",
        "forge.config.js",
        "electron-builder.js",
        "codegen.ts",
        "serverless.ts",
        "cucumber.js",
    ] {
        assert!(
            !findings.contains(&finding(credited, "default")),
            "the default export of {credited} is read by its tool, found: {findings:?}"
        );
    }
    assert!(
        !findings.contains(&finding("cucumber.js", "ci")),
        "cucumber-js reads each named export as a profile, found: {findings:?}"
    );
    assert!(
        !findings.contains(&finding("vercel.ts", "config")),
        "@vercel/config reads the named exports of vercel.ts, found: {findings:?}"
    );
    assert!(
        findings.contains(&finding("capacitor.config.ts", "unusedHelper")),
        "a named export that the tool does not read stays reportable, found: {findings:?}"
    );
}

#[test]
fn app_source_and_helper_modules_keep_default_export_reportable() {
    // src/i18n.ts is application source, not a tool config file. The credit
    // is anchored, so a helper module in src/lib and a config copy in a
    // subdirectory get none.
    let findings = config_file_exports_findings(true);

    for reported in [
        "src/i18n.ts",
        "src/lib/serverless.ts",
        "config/svgo.config.js",
    ] {
        assert!(
            findings.contains(&finding(reported, "default")),
            "the default export of {reported} gets no credit, found: {findings:?}"
        );
    }
}

#[test]
fn config_file_exports_do_not_change_default_mode() {
    // Without includeEntryExports, config files are entry points and fallow
    // skips their exports. The credit must not make fallow analyse them.
    let findings = config_file_exports_findings(false);

    assert_eq!(
        findings,
        vec![
            finding("config/svgo.config.js", "default"),
            finding("src/lib/serverless.ts", "default"),
        ],
        "default-mode output must not change"
    );
}

#[test]
fn storybook_exports_are_framework_used_with_include_entry_exports() {
    let root = fixture_path("storybook-include-entry-exports");
    let mut config = create_config(root);
    config.include_entry_exports = true;
    let results = fallow_core::analyze(&config).expect("analysis should succeed");

    let unused_exports: Vec<(String, String)> = results
        .unused_exports
        .iter()
        .map(|export| {
            (
                export
                    .export
                    .path
                    .strip_prefix(&config.root)
                    .unwrap_or(&export.export.path)
                    .to_string_lossy()
                    .replace('\\', "/"),
                export.export.export_name.clone(),
            )
        })
        .collect();

    for (path, export) in [
        ("src/Button.stories.ts", "default"),
        ("src/Button.stories.ts", "Default"),
        ("src/Button.stories.ts", "Secondary"),
        (".storybook/preview.ts", "parameters"),
        (".storybook/preview.ts", "decorators"),
    ] {
        assert!(
            !unused_exports
                .iter()
                .any(|(unused_path, unused_export)| unused_path == path && unused_export == export),
            "{path}:{export} should be framework-used, found: {unused_exports:?}"
        );
    }
}