tldr-core 0.1.4

Core analysis engine for TLDR code analysis tool
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
//! Per-language static surface extraction profiles.
//!
//! This module isolates repository-shape and entrypoint heuristics for static
//! API surface extraction. The profiles are intentionally separate from the
//! extractors themselves so each language can evolve its own surface policy
//! without cross-language coupling.

use std::path::{Component, Path};

use crate::types::Language;

#[path = "profiles/mod.rs"]
mod profiles;

/// Static surface policy for one language.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SurfaceLanguageProfile {
    /// Canonical language enum used by `surface`.
    pub language: Language,
    /// Exact directory names that should usually be ignored for API discovery.
    pub noise_dirs: &'static [&'static str],
    /// File suffixes that usually indicate tests, fixtures, or benchmarks.
    pub noise_file_suffixes: &'static [&'static str],
    /// Leading scaffolding segments to trim after prefix stripping.
    pub drop_segments: &'static [&'static str],
    /// Layout-specific multi-segment prefixes to trim from the start of a path.
    pub drop_prefixes: &'static [&'static [&'static str]],
    /// Preferred roots for package-facing API discovery.
    pub preferred_roots: &'static [&'static str],
    /// Files or roots that commonly define the package entrypoint.
    pub entrypoints: &'static [&'static str],
}

#[doc(hidden)]
pub trait SurfaceProfileLanguage {
    fn into_language(self) -> Option<Language>;
}

impl SurfaceProfileLanguage for Language {
    fn into_language(self) -> Option<Language> {
        Some(self)
    }
}

impl SurfaceProfileLanguage for &str {
    fn into_language(self) -> Option<Language> {
        match self {
            "c" => Some(Language::C),
            "cpp" => Some(Language::Cpp),
            "csharp" => Some(Language::CSharp),
            "elixir" => Some(Language::Elixir),
            "go" => Some(Language::Go),
            "java" => Some(Language::Java),
            "javascript" | "js" => Some(Language::JavaScript),
            "kotlin" => Some(Language::Kotlin),
            "lua" => Some(Language::Lua),
            "php" => Some(Language::Php),
            "python" => Some(Language::Python),
            "ruby" => Some(Language::Ruby),
            "rust" => Some(Language::Rust),
            "scala" => Some(Language::Scala),
            "swift" => Some(Language::Swift),
            "typescript" | "ts" => Some(Language::TypeScript),
            "luau" => Some(Language::Luau),
            "ocaml" => Some(Language::Ocaml),
            _ => None,
        }
    }
}

#[doc(hidden)]
pub trait IntoLayoutSegments {
    fn into_layout_segments(self) -> Vec<String>;
}

impl IntoLayoutSegments for &Path {
    fn into_layout_segments(self) -> Vec<String> {
        path_segments(self)
    }
}

impl IntoLayoutSegments for Vec<String> {
    fn into_layout_segments(self) -> Vec<String> {
        self
    }
}

/// Look up the static surface profile for one supported language.
#[must_use]
pub fn language_profile<L>(language: L) -> Option<&'static SurfaceLanguageProfile>
where
    L: SurfaceProfileLanguage,
{
    profiles::profile_for(language.into_language()?)
}

/// Return every language with a dedicated static surface profile.
#[must_use]
pub fn supported_surface_languages() -> &'static [Language] {
    profiles::SUPPORTED_SURFACE_LANGUAGES
}

/// Return `true` if a directory should usually be ignored for a language.
#[must_use]
pub fn is_noise_dir<L>(language: L, dir_name: &str) -> bool
where
    L: SurfaceProfileLanguage,
{
    let Some(profile) = language_profile(language) else {
        return false;
    };

    let candidate = dir_name.to_ascii_lowercase();
    profile.noise_dirs.iter().any(|entry| *entry == candidate)
}

/// Return `true` if a file name matches one of the language's noise suffixes.
#[must_use]
pub fn is_noise_file<L>(language: L, file_name: &str) -> bool
where
    L: SurfaceProfileLanguage,
{
    let Some(profile) = language_profile(language) else {
        return false;
    };

    let candidate = file_name.to_ascii_lowercase();
    profile
        .noise_file_suffixes
        .iter()
        .any(|suffix| candidate.ends_with(suffix))
}

/// Strip language-specific layout segments from a path.
///
/// This removes configured layout prefixes such as `src/main/java`,
/// `src/commonMain/kotlin`, or `Sources`, then trims any remaining leading
/// scaffolding segments like `src` or `lib`.
#[must_use]
pub fn strip_layout_segments<L, P>(language: L, path: P) -> Vec<String>
where
    L: SurfaceProfileLanguage,
    P: IntoLayoutSegments,
{
    let mut segments = path.into_layout_segments();
    let Some(profile) = language_profile(language) else {
        return segments;
    };
    if let Some((start, len)) = matching_prefix_len(&segments, profile.drop_prefixes) {
        segments.drain(start..start + len);
    }
    while segments
        .first()
        .is_some_and(|segment| contains_ignore_case(profile.drop_segments, segment))
    {
        segments.remove(0);
    }
    segments
}

/// Return the canonical entrypoint candidates for a language profile.
#[must_use]
pub fn entrypoint_candidates<L>(language: L) -> &'static [&'static str]
where
    L: SurfaceProfileLanguage,
{
    language_profile(language)
        .map(|profile| profile.entrypoints)
        .unwrap_or(&[])
}

/// Compute a static preference score for a relative path.
///
/// This is a small shared ranking scaffold for future extractor integration.
/// Higher scores indicate paths that look more package-facing according to the
/// language profile:
///
/// - entrypoints score highest
/// - preferred roots receive a smaller positive boost
/// - neutral paths stay at `0`
/// - paths containing known noise directories are demoted
#[must_use]
pub fn static_preference_score<L>(language: L, relative_path: &Path) -> i32
where
    L: SurfaceProfileLanguage,
{
    let Some(profile) = language_profile(language) else {
        return 0;
    };

    let segments = path_segments(relative_path);
    if segments.is_empty() {
        return 0;
    }

    if segments
        .iter()
        .any(|segment| contains_ignore_case(profile.noise_dirs, segment))
    {
        return -100;
    }

    let mut score = 0;

    if profile
        .entrypoints
        .iter()
        .any(|rule| path_matches_rule(&segments, rule))
    {
        score += 100;
    }

    if profile
        .preferred_roots
        .iter()
        .any(|rule| path_matches_rule(&segments, rule))
    {
        score += 25;
    }

    score
}

fn path_segments(path: &Path) -> Vec<String> {
    path.components()
        .filter_map(|component| match component {
            Component::Normal(segment) => Some(segment.to_string_lossy().into_owned()),
            _ => None,
        })
        .collect()
}

fn matching_prefix_len(
    segments: &[String],
    prefixes: &'static [&'static [&'static str]],
) -> Option<(usize, usize)> {
    let mut best: Option<(usize, usize)> = None; // (start, prefix_len)
    for prefix in prefixes {
        for start in 0..segments.len() {
            if starts_with_ignore_case(&segments[start..], prefix)
                && best.is_none_or(|(_, prev_len)| prefix.len() > prev_len) {
                    best = Some((start, prefix.len()));
}
}
}
best
}

fn starts_with_ignore_case(segments: &[String], prefix: &[&str]) -> bool {
    segments.len() >= prefix.len()
        && segments
            .iter()
            .take(prefix.len())
            .zip(prefix.iter())
            .all(|(segment, expected)| segment.eq_ignore_ascii_case(expected))
}

fn contains_ignore_case(values: &[&str], candidate: &str) -> bool {
    values
        .iter()
        .any(|value| candidate.eq_ignore_ascii_case(value))
}

fn path_matches_rule(segments: &[String], rule: &str) -> bool {
    if rule == "." {
        return true;
    }

    let rule_segments: Vec<&str> = rule
        .split('/')
        .filter(|segment| !segment.is_empty() && *segment != ".")
        .collect();

    if rule_segments.is_empty() {
        return false;
    }

    if starts_with_ignore_case(segments, &rule_segments) {
        return true;
    }

    rule_segments.len() == 1
        && segments
            .last()
            .is_some_and(|segment| segment.eq_ignore_ascii_case(rule_segments[0]))
}

#[cfg(test)]
mod tests {
    use std::path::Path;

    use crate::types::Language;

    use super::{
        entrypoint_candidates, is_noise_dir, is_noise_file, language_profile,
        static_preference_score,
        strip_layout_segments, supported_surface_languages,
    };

    #[test]
    fn profile_lookup_returns_supported_profile() {
        let profile = language_profile(Language::Rust).expect("rust profile should exist");

        assert_eq!(profile.language, Language::Rust);
        assert!(profile.preferred_roots.contains(&"src"));
    }

    #[test]
    fn profile_lookup_excludes_unsupported_languages() {
        assert!(language_profile(Language::Luau).is_none());
        assert!(language_profile(Language::Ocaml).is_none());
    }

    #[test]
    fn supported_languages_are_surface_scoped() {
        let supported = supported_surface_languages();

        assert!(supported.contains(&Language::Python));
        assert!(supported.contains(&Language::TypeScript));
        assert!(supported.contains(&Language::Swift));
        assert!(!supported.contains(&Language::Luau));
        assert!(!supported.contains(&Language::Ocaml));
        assert_eq!(supported.len(), 16);
    }

    #[test]
    fn helper_behavior_uses_profile_rules() {
        assert!(is_noise_dir(Language::Python, "docs_src"));
        assert!(is_noise_dir(Language::JavaScript, "__fixtures__"));
        assert!(is_noise_file(Language::JavaScript, "widget.spec.js"));
        assert!(is_noise_file(Language::TypeScript, "widget.benchmark.tsx"));
        assert!(!is_noise_file(Language::TypeScript, "index.d.ts"));
    }

    #[test]
    fn layout_stripping_removes_language_specific_prefixes() {
        let java_segments = strip_layout_segments(
            Language::Java,
            Path::new("src/main/java/com/example/api/Foo.java"),
        );
        let kotlin_segments = strip_layout_segments(
            Language::Kotlin,
            Path::new("src/commonMain/kotlin/com/example/api/Foo.kt"),
        );
        let swift_segments = strip_layout_segments(
            Language::Swift,
            Path::new("Sources/Networking/Client.swift"),
        );

        assert_eq!(java_segments, ["com", "example", "api", "Foo.java"]);
        assert_eq!(kotlin_segments, ["com", "example", "api", "Foo.kt"]);
        assert_eq!(swift_segments, ["Networking", "Client.swift"]);
    }

    #[test]
    fn layout_stripping_leaves_unsupported_languages_unchanged() {
        let segments = strip_layout_segments(Language::Luau, Path::new("src/pkg/init.luau"));

        assert_eq!(segments, ["src", "pkg", "init.luau"]);
    }

    #[test]
    fn entrypoint_candidates_come_from_profile_data() {
        let rust_entrypoints = entrypoint_candidates(Language::Rust);
        let python_entrypoints = entrypoint_candidates(Language::Python);

        assert!(rust_entrypoints.contains(&"src/lib.rs"));
        assert!(python_entrypoints.contains(&"pyproject.toml"));
        assert!(entrypoint_candidates(Language::Luau).is_empty());
    }

    #[test]
    fn static_preference_score_prioritizes_entrypoints_over_preferred_roots() {
        let entrypoint = static_preference_score(Language::TypeScript, Path::new("src/index.ts"));
        let preferred_root = static_preference_score(
            Language::TypeScript,
            Path::new("src/components/button.ts"),
        );

        assert!(entrypoint > preferred_root);
    }

    #[test]
    fn static_preference_score_prioritizes_preferred_roots_over_neutral_paths() {
        let preferred_root = static_preference_score(Language::Rust, Path::new("src/lib.rs"));
        let neutral = static_preference_score(Language::Rust, Path::new("internal/helpers/mod.rs"));

        assert!(preferred_root > neutral);
    }

    #[test]
    fn static_preference_score_demotes_noise_paths_below_neutral_paths() {
        let neutral = static_preference_score(Language::Rust, Path::new("internal/helpers/mod.rs"));
        let noise = static_preference_score(Language::Rust, Path::new("examples/demo/main.rs"));

        assert!(neutral > noise);
    }

    #[test]
    fn static_preference_score_orders_entrypoint_preferred_neutral_and_noise_paths() {
        let entrypoint = static_preference_score(Language::TypeScript, Path::new("src/index.ts"));
        let preferred_root = static_preference_score(
            Language::TypeScript,
            Path::new("src/components/button.ts"),
        );
        let neutral = static_preference_score(Language::TypeScript, Path::new("scripts/release.ts"));
        let noise = static_preference_score(Language::TypeScript, Path::new("examples/demo/index.ts"));

        assert!(entrypoint > preferred_root);
        assert!(preferred_root > neutral);
        assert!(neutral > noise);
    }
}