debtmap 0.20.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

use crate::analyzers::go::debt::detect_complexity_debt;
use crate::analyzers::go::dependencies::extract_dependencies;
use crate::analyzers::go::generated::is_generated_go;
use crate::analyzers::go::metrics::{build_file_metrics, to_function_metrics};
use crate::analyzers::go::visitor::analyze_ast;
use crate::config::GeneratedCodeMode;
use crate::core::FileMetrics;
use crate::core::ast::GoAst;

pub fn analyze_go_file(ast: &GoAst, threshold: u32) -> FileMetrics {
    analyze_go_file_with_mode(ast, threshold, GeneratedCodeMode::SuppressDebt)
}

pub fn analyze_go_file_with_mode(
    ast: &GoAst,
    threshold: u32,
    generated_mode: GeneratedCodeMode,
) -> FileMetrics {
    let analysis = analyze_ast(ast);
    let functions: Vec<_> = analysis.functions.iter().map(to_function_metrics).collect();
    let debt_items = if suppress_generated_debt(ast, generated_mode) {
        Vec::new()
    } else {
        detect_complexity_debt(&ast.path, threshold, &functions)
    };

    build_file_metrics(
        ast.path.clone(),
        functions,
        debt_items,
        extract_dependencies(ast),
        ast.source.lines().count(),
    )
}

fn suppress_generated_debt(ast: &GoAst, generated_mode: GeneratedCodeMode) -> bool {
    generated_mode == GeneratedCodeMode::SuppressDebt && is_generated_go(&ast.path, &ast.source)
}