debtmap 0.21.0

Code complexity and technical debt 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

use std::path::PathBuf;

use crate::analyzers::solidity::effects::SolidityEffectSummary;
use crate::complexity::entropy_core::EntropyAnalysis;
use crate::core::ast::ClassDef;

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SolidityFunctionKind {
    Function,
    Modifier,
    Constructor,
    Fallback,
    Receive,
}

#[derive(Debug, Clone)]
pub struct SolidityFunction {
    pub name: String,
    pub file: PathBuf,
    pub line: usize,
    pub length: usize,
    pub cyclomatic: u32,
    pub cognitive: u32,
    pub nesting: u32,
    pub kind: SolidityFunctionKind,
    pub is_test: bool,
    pub visibility: Option<String>,
    pub calls: Vec<String>,
    pub advisory_patterns: Vec<String>,
    pub contract_name: Option<String>,
    pub entropy_analysis: Option<EntropyAnalysis>,
    pub state_mutability: Option<String>,
    pub effects: SolidityEffectSummary,
}

#[derive(Debug, Clone, Default)]
pub struct ContractInfo {
    pub name: String,
    pub kind: ContractKind,
    pub base_classes: Vec<String>,
    pub state_variable_count: usize,
    pub function_count: usize,
    pub state_variables: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub enum ContractKind {
    #[default]
    Contract,
    Interface,
    Library,
}

#[derive(Debug, Clone, Default)]
pub struct SolidityAnalysis {
    pub contracts: Vec<ContractInfo>,
    pub functions: Vec<SolidityFunction>,
    pub is_test_file: bool,
    pub has_floating_pragma: bool,
}

impl ContractInfo {
    pub fn to_class_def(&self) -> ClassDef {
        ClassDef {
            name: self.name.clone(),
            base_classes: self.base_classes.clone(),
            methods: vec![],
            is_abstract: false,
            decorators: vec![],
            line: 0,
        }
    }
}