tldr-core 0.1.2

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

use crate::types::Language;

use super::super::SurfaceLanguageProfile;

const NOISE_DIRS: &[&str] = &[
    "__fixtures__",
    "__tests__",
    "bench",
    "benches",
    "benchmark",
    "benchmarks",
    "doc",
    "docs",
    "example",
    "examples",
    "fixture",
    "fixtures",
    "spec",
    "specs",
    "test",
    "tests",
];
const NOISE_FILE_SUFFIXES: &[&str] = &[
    ".bench.cjs",
    ".bench.js",
    ".bench.mjs",
    ".benchmark.cjs",
    ".benchmark.js",
    ".benchmark.mjs",
    ".fixture.cjs",
    ".fixture.js",
    ".fixture.mjs",
    ".spec.cjs",
    ".spec.js",
    ".spec.mjs",
    ".test.cjs",
    ".test.js",
    ".test.mjs",
];
const DROP_SEGMENTS: &[&str] = &["cjs", "dist", "esm", "index", "lib", "src"];
const PREFIX_DIST: &[&str] = &["dist"];
const PREFIX_ESM: &[&str] = &["esm"];
const PREFIX_CJS: &[&str] = &["cjs"];
const PREFIX_LIB: &[&str] = &["lib"];
const PREFIX_SRC: &[&str] = &["src"];
const DROP_PREFIXES: &[&[&str]] = &[PREFIX_SRC, PREFIX_LIB, PREFIX_DIST, PREFIX_ESM, PREFIX_CJS];
const PREFERRED_ROOTS: &[&str] = &["src", "lib"];
const ENTRYPOINTS: &[&str] = &["package.json", "index.js", "index.mjs", "index.cjs"];

pub(super) const PROFILE: SurfaceLanguageProfile = SurfaceLanguageProfile {
    language: Language::JavaScript,
    noise_dirs: NOISE_DIRS,
    noise_file_suffixes: NOISE_FILE_SUFFIXES,
    drop_segments: DROP_SEGMENTS,
    drop_prefixes: DROP_PREFIXES,
    preferred_roots: PREFERRED_ROOTS,
    entrypoints: ENTRYPOINTS,
};