cha-core 1.8.0

Core analysis engine for Cha — pluggable code smell detection
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

use std::path::PathBuf;

use cha_core::plugins::*;
use cha_core::*;

pub fn make_file() -> SourceFile {
    SourceFile::new(PathBuf::from("test.rs"), String::new())
}

pub fn make_model(
    functions: Vec<FunctionInfo>,
    classes: Vec<ClassInfo>,
    imports: Vec<ImportInfo>,
    total_lines: usize,
) -> SourceModel {
    SourceModel {
        language: "rust".into(),
        total_lines,
        functions,
        classes,
        imports,
        comments: Vec::new(),
        type_aliases: Vec::new(),
    }
}

pub fn func(name: &str, lines: usize, complexity: usize, exported: bool) -> FunctionInfo {
    FunctionInfo {
        name: name.into(),
        start_line: 1,
        end_line: lines,
        line_count: lines,
        complexity,
        body_hash: Some(lines as u64),
        is_exported: exported,
        ..Default::default()
    }
}

pub fn func_with_hash(name: &str, lines: usize, hash: u64) -> FunctionInfo {
    FunctionInfo {
        name: name.into(),
        start_line: 1,
        end_line: lines,
        line_count: lines,
        complexity: 1,
        body_hash: Some(hash),
        ..Default::default()
    }
}

pub fn class(name: &str, methods: usize, lines: usize, exported: bool) -> ClassInfo {
    ClassInfo {
        name: name.into(),
        start_line: 1,
        end_line: lines,
        method_count: methods,
        line_count: lines,
        is_exported: exported,
        ..Default::default()
    }
}

pub fn import(source: &str, line: usize) -> ImportInfo {
    ImportInfo {
        source: source.into(),
        line,
        ..Default::default()
    }
}

/// Shorthand: TypeRef carrying `name`, raw same as name, origin Unknown.
pub fn tref(name: &str) -> TypeRef {
    TypeRef {
        name: name.into(),
        raw: name.into(),
        origin: TypeOrigin::Unknown,
    }
}

/// TypeRef for a known primitive.
pub fn tref_prim(name: &str) -> TypeRef {
    TypeRef {
        name: name.into(),
        raw: name.into(),
        origin: TypeOrigin::Primitive,
    }
}

/// TypeRef for an external module type.
pub fn tref_ext(name: &str, module: &str) -> TypeRef {
    TypeRef {
        name: name.into(),
        raw: format!("{module}::{name}"),
        origin: TypeOrigin::External(module.into()),
    }
}

pub fn analyze(plugin: &dyn Plugin, model: &SourceModel) -> Vec<Finding> {
    let file = make_file();
    let ctx = AnalysisContext { file: &file, model };
    plugin.analyze(&ctx)
}