fallow-core 2.40.3

Core analysis engine for the fallow TypeScript/JavaScript codebase 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
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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
//! Cross-reference duplication findings with dead code analysis results.
//!
//! When code is both duplicated AND unused, it's a higher-priority finding:
//! the duplicate can be safely removed without any refactoring. This module
//! identifies such combined findings.

use rustc_hash::FxHashSet;
use std::path::PathBuf;

use serde::Serialize;

use crate::duplicates::types::{CloneInstance, DuplicationReport};
use crate::results::AnalysisResults;

/// A combined finding where a clone instance overlaps with a dead code issue.
#[derive(Debug, Clone, Serialize)]
pub struct CombinedFinding {
    /// The clone instance that is also unused.
    pub clone_instance: CloneInstance,
    /// What kind of dead code overlaps with this clone.
    pub dead_code_kind: DeadCodeKind,
    /// Clone group index (for associating with the parent group).
    pub group_index: usize,
}

/// The type of dead code that overlaps with a clone instance.
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
pub enum DeadCodeKind {
    /// The entire file containing the clone is unused.
    UnusedFile,
    /// A specific unused export overlaps with the clone's line range.
    UnusedExport { export_name: String },
    /// A specific unused type overlaps with the clone's line range.
    UnusedType { type_name: String },
}

/// Result of cross-referencing duplication with dead code analysis.
#[derive(Debug, Clone, Serialize)]
pub struct CrossReferenceResult {
    /// Clone instances that are also dead code (safe to delete).
    pub combined_findings: Vec<CombinedFinding>,
    /// Number of clone instances in unused files.
    pub clones_in_unused_files: usize,
    /// Number of clone instances overlapping unused exports.
    pub clones_with_unused_exports: usize,
}

/// Cross-reference duplication findings with dead code analysis results.
///
/// For each clone instance, checks whether:
/// 1. The file is entirely unused (in `unused_files`)
/// 2. An unused export/type at the same line range overlaps
///
/// Returns combined findings sorted by priority (unused files first, then exports).
#[must_use]
pub fn cross_reference(
    duplication: &DuplicationReport,
    dead_code: &AnalysisResults,
) -> CrossReferenceResult {
    // Build lookup sets for fast checking
    let unused_files: FxHashSet<&PathBuf> =
        dead_code.unused_files.iter().map(|f| &f.path).collect();

    let mut combined_findings = Vec::new();
    let mut clones_in_unused_files = 0usize;
    let mut clones_with_unused_exports = 0usize;

    for (group_idx, group) in duplication.clone_groups.iter().enumerate() {
        for instance in &group.instances {
            // Check 1: Is the file entirely unused?
            if unused_files.contains(&instance.file) {
                combined_findings.push(CombinedFinding {
                    clone_instance: instance.clone(),
                    dead_code_kind: DeadCodeKind::UnusedFile,
                    group_index: group_idx,
                });
                clones_in_unused_files += 1;
                continue; // No need to check exports if entire file is unused
            }

            // Check 2: Does an unused export/type overlap with this clone's line range?
            if let Some(finding) = find_overlapping_unused_export(instance, group_idx, dead_code) {
                clones_with_unused_exports += 1;
                combined_findings.push(finding);
            }
        }
    }

    CrossReferenceResult {
        combined_findings,
        clones_in_unused_files,
        clones_with_unused_exports,
    }
}

/// Check if any unused export/type overlaps with the clone instance's line range.
fn find_overlapping_unused_export(
    instance: &CloneInstance,
    group_index: usize,
    dead_code: &AnalysisResults,
) -> Option<CombinedFinding> {
    // Check unused exports
    for export in &dead_code.unused_exports {
        if export.path == instance.file
            && (export.line as usize) >= instance.start_line
            && (export.line as usize) <= instance.end_line
        {
            return Some(CombinedFinding {
                clone_instance: instance.clone(),
                dead_code_kind: DeadCodeKind::UnusedExport {
                    export_name: export.export_name.clone(),
                },
                group_index,
            });
        }
    }

    // Check unused types
    for type_export in &dead_code.unused_types {
        if type_export.path == instance.file
            && (type_export.line as usize) >= instance.start_line
            && (type_export.line as usize) <= instance.end_line
        {
            return Some(CombinedFinding {
                clone_instance: instance.clone(),
                dead_code_kind: DeadCodeKind::UnusedType {
                    type_name: type_export.export_name.clone(),
                },
                group_index,
            });
        }
    }

    None
}

/// Summary statistics for cross-referenced findings.
impl CrossReferenceResult {
    /// Total number of combined findings.
    #[must_use]
    pub const fn total(&self) -> usize {
        self.combined_findings.len()
    }

    /// Whether any combined findings exist.
    #[must_use]
    pub const fn has_findings(&self) -> bool {
        !self.combined_findings.is_empty()
    }

    /// Get clone groups that have at least one combined finding, with their indices.
    #[must_use]
    pub fn affected_group_indices(&self) -> FxHashSet<usize> {
        self.combined_findings
            .iter()
            .map(|f| f.group_index)
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::duplicates::CloneGroup;
    use crate::results::{UnusedExport, UnusedFile};

    fn make_instance(file: &str, start: usize, end: usize) -> CloneInstance {
        CloneInstance {
            file: PathBuf::from(file),
            start_line: start,
            end_line: end,
            start_col: 0,
            end_col: 0,
            fragment: String::new(),
        }
    }

    fn make_group(instances: Vec<CloneInstance>) -> CloneGroup {
        CloneGroup {
            instances,
            token_count: 50,
            line_count: 10,
        }
    }

    #[test]
    fn empty_inputs_produce_no_findings() {
        let duplication = DuplicationReport {
            clone_groups: vec![],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 0,
                files_with_clones: 0,
                total_lines: 0,
                duplicated_lines: 0,
                total_tokens: 0,
                duplicated_tokens: 0,
                clone_groups: 0,
                clone_instances: 0,
                duplication_percentage: 0.0,
            },
        };
        let dead_code = AnalysisResults::default();

        let result = cross_reference(&duplication, &dead_code);
        assert!(!result.has_findings());
        assert_eq!(result.total(), 0);
    }

    #[test]
    fn detects_clone_in_unused_file() {
        let duplication = DuplicationReport {
            clone_groups: vec![make_group(vec![
                make_instance("src/a.ts", 1, 10),
                make_instance("src/b.ts", 1, 10),
            ])],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 2,
                files_with_clones: 2,
                total_lines: 20,
                duplicated_lines: 10,
                total_tokens: 100,
                duplicated_tokens: 50,
                clone_groups: 1,
                clone_instances: 2,
                duplication_percentage: 50.0,
            },
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_files.push(UnusedFile {
            path: PathBuf::from("src/a.ts"),
        });

        let result = cross_reference(&duplication, &dead_code);
        assert!(result.has_findings());
        assert_eq!(result.clones_in_unused_files, 1);
        assert_eq!(
            result.combined_findings[0].dead_code_kind,
            DeadCodeKind::UnusedFile
        );
    }

    #[test]
    fn detects_clone_overlapping_unused_export() {
        let duplication = DuplicationReport {
            clone_groups: vec![make_group(vec![
                make_instance("src/a.ts", 5, 15),
                make_instance("src/b.ts", 5, 15),
            ])],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 2,
                files_with_clones: 2,
                total_lines: 20,
                duplicated_lines: 10,
                total_tokens: 100,
                duplicated_tokens: 50,
                clone_groups: 1,
                clone_instances: 2,
                duplication_percentage: 50.0,
            },
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_exports.push(UnusedExport {
            path: PathBuf::from("src/a.ts"),
            export_name: "processData".to_string(),
            is_type_only: false,
            line: 5,
            col: 0,
            span_start: 0,
            is_re_export: false,
        });

        let result = cross_reference(&duplication, &dead_code);
        assert!(result.has_findings());
        assert_eq!(result.clones_with_unused_exports, 1);
        assert!(matches!(
            &result.combined_findings[0].dead_code_kind,
            DeadCodeKind::UnusedExport { export_name } if export_name == "processData"
        ));
    }

    #[test]
    fn no_findings_when_no_overlap() {
        let duplication = DuplicationReport {
            clone_groups: vec![make_group(vec![
                make_instance("src/a.ts", 5, 15),
                make_instance("src/b.ts", 5, 15),
            ])],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 2,
                files_with_clones: 2,
                total_lines: 20,
                duplicated_lines: 10,
                total_tokens: 100,
                duplicated_tokens: 50,
                clone_groups: 1,
                clone_instances: 2,
                duplication_percentage: 50.0,
            },
        };
        let mut dead_code = AnalysisResults::default();
        // Unused export on a different line range
        dead_code.unused_exports.push(UnusedExport {
            path: PathBuf::from("src/a.ts"),
            export_name: "other".to_string(),
            is_type_only: false,
            line: 20, // outside clone range 5-15
            col: 0,
            span_start: 0,
            is_re_export: false,
        });

        let result = cross_reference(&duplication, &dead_code);
        assert!(!result.has_findings());
    }

    #[test]
    fn affected_group_indices() {
        let duplication = DuplicationReport {
            clone_groups: vec![
                make_group(vec![
                    make_instance("src/a.ts", 1, 10),
                    make_instance("src/b.ts", 1, 10),
                ]),
                make_group(vec![
                    make_instance("src/c.ts", 1, 10),
                    make_instance("src/d.ts", 1, 10),
                ]),
            ],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 4,
                files_with_clones: 4,
                total_lines: 40,
                duplicated_lines: 20,
                total_tokens: 200,
                duplicated_tokens: 100,
                clone_groups: 2,
                clone_instances: 4,
                duplication_percentage: 50.0,
            },
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_files.push(UnusedFile {
            path: PathBuf::from("src/c.ts"),
        });

        let result = cross_reference(&duplication, &dead_code);
        let affected = result.affected_group_indices();
        assert!(!affected.contains(&0)); // Group 0 not affected
        assert!(affected.contains(&1)); // Group 1 has clone in unused file
    }

    #[test]
    fn unused_file_takes_priority_over_export() {
        // If a file is unused AND has unused exports, we should only get the
        // UnusedFile finding (not both), because the continue skips export checks.
        let duplication = DuplicationReport {
            clone_groups: vec![make_group(vec![
                make_instance("src/a.ts", 5, 15),
                make_instance("src/b.ts", 5, 15),
            ])],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 2,
                files_with_clones: 2,
                total_lines: 20,
                duplicated_lines: 10,
                total_tokens: 100,
                duplicated_tokens: 50,
                clone_groups: 1,
                clone_instances: 2,
                duplication_percentage: 50.0,
            },
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_files.push(UnusedFile {
            path: PathBuf::from("src/a.ts"),
        });
        dead_code.unused_exports.push(UnusedExport {
            path: PathBuf::from("src/a.ts"),
            export_name: "foo".to_string(),
            is_type_only: false,
            line: 10,
            col: 0,
            span_start: 0,
            is_re_export: false,
        });

        let result = cross_reference(&duplication, &dead_code);
        // Only 1 finding for src/a.ts (the unused file), not 2
        let a_findings: Vec<_> = result
            .combined_findings
            .iter()
            .filter(|f| f.clone_instance.file == std::path::Path::new("src/a.ts"))
            .collect();
        assert_eq!(a_findings.len(), 1);
        assert_eq!(a_findings[0].dead_code_kind, DeadCodeKind::UnusedFile);
    }

    #[test]
    fn detects_clone_overlapping_unused_type() {
        let duplication = DuplicationReport {
            clone_groups: vec![make_group(vec![
                make_instance("src/types.ts", 1, 20),
                make_instance("src/other.ts", 1, 20),
            ])],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 2,
                files_with_clones: 2,
                total_lines: 40,
                duplicated_lines: 20,
                total_tokens: 100,
                duplicated_tokens: 50,
                clone_groups: 1,
                clone_instances: 2,
                duplication_percentage: 50.0,
            },
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_types.push(UnusedExport {
            path: PathBuf::from("src/types.ts"),
            export_name: "OldInterface".to_string(),
            is_type_only: true,
            line: 10,
            col: 0,
            span_start: 0,
            is_re_export: false,
        });

        let result = cross_reference(&duplication, &dead_code);
        assert!(result.has_findings());
        assert!(matches!(
            &result.combined_findings[0].dead_code_kind,
            DeadCodeKind::UnusedType { type_name } if type_name == "OldInterface"
        ));
    }

    #[test]
    fn empty_result_methods() {
        let result = CrossReferenceResult {
            combined_findings: vec![],
            clones_in_unused_files: 0,
            clones_with_unused_exports: 0,
        };
        assert_eq!(result.total(), 0);
        assert!(!result.has_findings());
        assert!(result.affected_group_indices().is_empty());
    }

    #[test]
    fn multiple_groups_with_findings() {
        let duplication = DuplicationReport {
            clone_groups: vec![
                make_group(vec![
                    make_instance("src/a.ts", 1, 10),
                    make_instance("src/b.ts", 1, 10),
                ]),
                make_group(vec![
                    make_instance("src/c.ts", 5, 15),
                    make_instance("src/d.ts", 5, 15),
                ]),
                make_group(vec![
                    make_instance("src/e.ts", 1, 10),
                    make_instance("src/f.ts", 1, 10),
                ]),
            ],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats {
                total_files: 6,
                files_with_clones: 6,
                total_lines: 60,
                duplicated_lines: 30,
                total_tokens: 300,
                duplicated_tokens: 150,
                clone_groups: 3,
                clone_instances: 6,
                duplication_percentage: 50.0,
            },
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_files.push(UnusedFile {
            path: PathBuf::from("src/a.ts"),
        });
        dead_code.unused_exports.push(UnusedExport {
            path: PathBuf::from("src/c.ts"),
            export_name: "helper".to_string(),
            is_type_only: false,
            line: 10,
            col: 0,
            span_start: 0,
            is_re_export: false,
        });

        let result = cross_reference(&duplication, &dead_code);
        assert_eq!(result.total(), 2);
        assert_eq!(result.clones_in_unused_files, 1);
        assert_eq!(result.clones_with_unused_exports, 1);

        let affected = result.affected_group_indices();
        assert!(affected.contains(&0)); // Group 0 has clone in unused file
        assert!(affected.contains(&1)); // Group 1 has clone overlapping unused export
        assert!(!affected.contains(&2)); // Group 2 unaffected
    }

    #[test]
    fn clone_instance_outside_export_line_range() {
        // Clone instance at lines 1-5, unused export at line 10
        // They don't overlap, so no finding
        let duplication = DuplicationReport {
            clone_groups: vec![make_group(vec![
                make_instance("src/a.ts", 1, 5),
                make_instance("src/b.ts", 1, 5),
            ])],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats::default(),
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_exports.push(UnusedExport {
            path: PathBuf::from("src/a.ts"),
            export_name: "fn".to_string(),
            is_type_only: false,
            line: 10,
            col: 0,
            span_start: 0,
            is_re_export: false,
        });

        let result = cross_reference(&duplication, &dead_code);
        assert!(!result.has_findings());
    }

    #[test]
    fn clone_in_different_file_than_unused_export() {
        // Clone is in src/a.ts, unused export is in src/x.ts
        let duplication = DuplicationReport {
            clone_groups: vec![make_group(vec![
                make_instance("src/a.ts", 5, 15),
                make_instance("src/b.ts", 5, 15),
            ])],
            clone_families: vec![],
            mirrored_directories: vec![],
            stats: crate::duplicates::types::DuplicationStats::default(),
        };
        let mut dead_code = AnalysisResults::default();
        dead_code.unused_exports.push(UnusedExport {
            path: PathBuf::from("src/x.ts"), // different file
            export_name: "fn".to_string(),
            is_type_only: false,
            line: 10,
            col: 0,
            span_start: 0,
            is_re_export: false,
        });

        let result = cross_reference(&duplication, &dead_code);
        assert!(!result.has_findings());
    }
}