fallow_types/
lib.rs

1//! Shared types for fallow codebase intelligence.
2//!
3//! This crate contains type definitions used across multiple fallow crates
4//! (core, CLI, LSP). It has no analysis logic, only data structures.
5
6#![warn(missing_docs)]
7#![cfg_attr(
8    test,
9    allow(
10        clippy::unwrap_used,
11        clippy::expect_used,
12        reason = "tests use unwrap and expect to keep fixture setup concise"
13    )
14)]
15
16/// File discovery types: discovered files, file IDs, and entry points.
17pub mod discover;
18/// JSON-output envelope and utility types: `SchemaVersion`, `ToolVersion`,
19/// `ElapsedMs`, `AuditIntroduced`, plus the shared `Meta`, `BaselineDeltas`,
20/// `BaselineMatch`, `RegressionResult`, `EntryPoints`, and `CheckSummary`
21/// shapes referenced by every per-command envelope. The structs are always
22/// compiled (the JSON emission layer constructs them at runtime); the
23/// `schemars::JsonSchema` derive is gated per-struct on the `schema` feature.
24pub mod envelope;
25/// Module extraction types: exports, imports, re-exports, and member info.
26pub mod extract;
27/// JSON-output augmentation types: `IssueAction` enum + variants.
28/// Schema-side counterpart of the augmentations the JSON layer adds to each
29/// dead-code finding. The structs are always compiled (typed dead-code
30/// wrappers in [`output_dead_code`] consume them at runtime); the
31/// `schemars::JsonSchema` derive is gated per-struct on the `schema`
32/// feature.
33pub mod output;
34/// Typed envelope wrappers for the simple 1:1 dead-code findings
35/// (`UnusedFile`, `PrivateTypeLeak`, `UnresolvedImport`, `CircularDependency`,
36/// `BoundaryViolation`). Each wrapper flattens the bare finding via
37/// `#[serde(flatten)]` and carries a typed `actions` array populated at
38/// construction time, replacing the per-finding post-pass injection that
39/// previously grafted `actions[]` and `introduced` onto the schema. The
40/// `introduced` field is set by the audit pass via JSON map insertion and
41/// is `None` when serialized directly from Rust. The `schemars::JsonSchema`
42/// derive is gated per-struct on the `schema` feature.
43pub mod output_dead_code;
44/// Per-action types attached to health findings, hotspots, refactoring
45/// targets, and coverage-gap entries. Separated from the generic
46/// `IssueAction` tree in the `output` module so the health-specific
47/// variants live in a dedicated module. The structs are always compiled
48/// (the JSON emission layer constructs them through typed wrappers such as
49/// [`output_health::UntestedFileAction`]); the `schemars::JsonSchema`
50/// derive is gated per-struct on the `schema` feature.
51pub mod output_health;
52/// Cross-platform path classification helpers.
53pub mod path_util;
54/// Analysis result types: unused files, exports, dependencies, and members.
55pub mod results;
56/// Custom serde serializers for cross-platform path output.
57pub mod serde_path;
58/// Inline suppression comment types and issue kind definitions.
59pub mod suppress;
fallow_types/lib.rs

fallow_types/
lib.rs
