episteme 0.3.1

Knowledge graph for software engineering — design patterns, refactorings, and laws for AI agents
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

use serde::{Deserialize, Serialize};

/// Estimated effort level for a refactoring.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum EffortLevel {
    Small,
    Medium,
    Large,
}

impl std::fmt::Display for EffortLevel {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            EffortLevel::Small => write!(f, "small"),
            EffortLevel::Medium => write!(f, "medium"),
            EffortLevel::Large => write!(f, "large"),
        }
    }
}

/// A refactoring suggestion ranked by composite priority score.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RefactoringSuggestion {
    pub refactoring_id: String,
    pub title: String,
    pub priority_score: f64,
    pub effort: EffortLevel,
    pub principles_enforced: Vec<String>,
    pub description: String,
    pub metadata: SuggestionMetadata,
}

/// Breakdown of the composite score components.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SuggestionMetadata {
    pub severity_score: f64,
    pub effort_score: f64,
    pub principle_score: f64,
    pub usage_score: f64,
}

/// A smell detection paired with its ranked refactoring suggestions.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SmellAnalysis {
    pub smell: serde_json::Value,
    pub suggestions: Vec<RefactoringSuggestion>,
}