How ytetsuro/sabik works
Project type and purpose
• Sabik is a Node.js-based CLI tool that analyzes source code to compute various complexity metrics (Cyclomatic, Cognitive, Halstead, LOC, Maintainability) and emits an HTML or JSON report.
• It is purely modular, with no external servers or databases; it reads files from the local filesystem and writes static outputs.
File structure
Top-level src folders:
• src/Sabik – Core orchestration: CLI entry, DI container, file finder, main Sabik class
• src/Analyzer – Pipeline to generate ASTs and compute metrics; uses Adapter pattern for AST generation and multiple CodeMetricsCalculator submodules
• src/Language – Language-specific AST generators and converter classes for PHP and TypeScript
• src/Reporter – Two reporting branches:
– HTML: FileBuilder, ScriptBuilder, and in-browser front-end (Components, Entities, Infrastructure/Event)
– JSON: Converter + JSON FileBuilder
• bin – CLI shim scripts (run/run.cmd)
README insights
• CLI usage: npx sabik <target>
• Options: output path, HTML/JSON, include/exclude globs
• Supports JavaScript/TypeScript/PHP
• Metrics: Cyclomatic, Cognitive, Halstead, LOC, Maintainability
Main components & relationships
A. CLI Layer
– Bin scripts call src/index.ts → initializes DIContainer → instantiates Sabik class
B. Core Orchestrator (Sabik)
– Uses FileFinder to discover target files
– Delegates each file to Analyzer
C. Analyzer
1. AST Extraction
• Adapter → Language-specific ASTGenerator (TS/PHP) → yields ASTNodes
2. Metrics Calculation
• For each metric type (Cyclomatic, Cognitive, Halstead, LOC, Maintainability)
• Uses CodeMetricsCalculator modules (Calculator + Adapter + MetricsValue classes)
3. Aggregation
• FromASTNode and FromOtherMetrics modules combine results into unified Metrics objects
D. Reporter
1. JSON Reporter
• Converter (MetricsList, Summaries) → JSON FileBuilder → writes .json
2. HTML Reporter
• FileBuilder → emits static HTML, CSS
• ScriptBuilder → bundles front-end code
• Front-end SPA
– Components (Pages, Parts)
– Entities (domain models for Metrics, FileMetrics, etc.)
– Infrastructure/Event (Flux-style EventStore, Actions)
– Repository & ResourceLoader (fetch or load embedded JSON)
E. Filesystem I/O
– Input: source files
– Output: report files (HTML directory or JSON file)
Architectural patterns & principles
• Modular layering: CLI → Core → Analyzer → Language Adapters → Metrics Calculators → Reporter
• Adapter pattern: separates AST generation and metric extraction from core logic
• Dependency Injection: DIContainer resolves components (Sabik, Analyzer, Reporter)
• Front-end MVC/Flux: EventStore + Components + Entities + Repository
• Single Responsibility & Open-Closed: each metric, language, or report format implemented as a separate plugin/module