tokmd-analysis

Analysis logic and enrichers for tokmd receipts.

Overview

This is a Tier 3 orchestration crate that computes derived metrics and optional enrichments from code inventories. It coordinates multiple analysis modules based on preset configuration.

Installation

[dependencies]
tokmd-analysis = "1.4"

# Enable optional features
[dependencies.tokmd-analysis]
version = "1.4"
features = ["git", "walk", "content", "fun", "topics", "archetype"]

Usage

use tokmd_analysis::{analyze, AnalysisRequest, AnalysisContext, AnalysisLimits, AnalysisPreset};

let request = AnalysisRequest {
    context: AnalysisContext {
        paths: vec![PathBuf::from(".")],
        export: export_data,
        base_receipt: None,
    },
    limits: AnalysisLimits::default(),
    preset: AnalysisPreset::Risk,
};

let receipt = analyze(request)?;

Analysis Presets

Preset	Includes
`Receipt`	Core derived metrics (density, distribution, COCOMO)
`Health`	+ TODO density
`Risk`	+ Git hotspots, coupling, freshness
`Supply`	+ Assets, dependency lockfiles
`Architecture`	+ Import graph
`Topics`	Semantic topic clouds (TF-IDF)
`Security`	License radar, entropy profiling
`Identity`	Archetype detection, corporate fingerprint
`Git`	Predictive churn, advanced git metrics
`Deep`	Everything (except fun)
`Fun`	Eco-label, novelty outputs

Analysis Modules

Module	Feature	Purpose
`archetype`	archetype	Project kind detection
`derived`	-	Core metrics
`topics`	topics	Semantic keyword extraction
`entropy`	content+walk	High-entropy file detection
`license`	content+walk	License radar scanning
`fingerprint`	git	Corporate domain analysis
`churn`	git	Git-based change prediction
`assets`	walk	Asset categorization
`git`	git	Hotspots, bus factor, freshness
`content`	content	TODOs, duplicates, imports

Feature Flags

[features]
git = ["tokmd-git"]       # Git history analysis
walk = ["tokmd-walk"]     # Asset discovery
content = ["tokmd-content"]  # Content scanning
topics = ["tokmd-analysis-topics"] # Topic-cloud extraction
archetype = ["tokmd-analysis-archetype"] # Archetype detection
fun = ["tokmd-analysis-fun"]  # Fun/novelty report enrichers

Key Types

pub struct AnalysisLimits {
    pub max_files: Option<usize>,
    pub max_bytes: Option<u64>,
    pub max_commits: Option<usize>,
    pub max_commit_files: Option<usize>,
    pub max_file_bytes: Option<u64>,
}

License

MIT OR Apache-2.0

tokmd-analysis 1.7.2