gotwarlost/istanbulArchived
Istanbul
Istanbul is a JavaScript code coverage tool and instrumentation engine that measures the execution of statements, lines, functions, and branches. It functions as a test coverage analysis tool capable of monitoring code across unit, functional, and browser tests to identify untested areas of a codebase.
The project distinguishes itself through a transparent instrumentation engine that uses module loader hooks to inject tracking code without requiring manual source modifications. It supports distributed test reporting by aggregating fragmented coverage data from multiple concurrent processes into a single unified dataset.
The tool provides comprehensive coverage analysis, including the ability to enforce minimum coverage thresholds and exclude specific code blocks or files from metrics using source comments and filtering patterns. Execution data is exported through a multi-format report generation system that produces summaries in HTML, LCOV, JSON, and console output.
Features
- Code Coverage Analysis - Measures executed lines, functions, and branches of JavaScript code to identify untested areas.
- JavaScript AST Transformations - Implements instrumentation by performing structural transformations on the JavaScript abstract syntax tree.
- Runtime Loader Hooks - Utilizes runtime loader hooks to intercept and instrument files during the module loading process.
- Code Instrumentation Utilities - Adds tracking markers to source files or directory trees to enable coverage collection across different environments.
- JavaScript Instrumentation Engines - Injects tracking code into JavaScript files using module loader hooks to monitor execution without modifying source files.
- Execution Coordinate Mapping - Records execution counts for statements and branches in a structured map linked to original source coordinates.
- Wrapper-based Instrumentation - Uses V8-based load hooks to inject tracking code without modifying the original source files.
- Code Coverage Tools - Measures statement, line, function, and branch execution for JavaScript across unit and browser tests.
- Summary Reports - Generates human-readable coverage summaries in multiple formats including HTML, LCOV, and JSON.
- Code Coverage Reportings - Generates HTML, LCOV, and JSON reports to visualize executed parts of a JavaScript codebase.
- Test Coverage Metrics - Computes detailed execution metrics for statements, lines, functions, and branches across various test environments.
- Browser Coverage Instrumentation - Adds tracking logic to JavaScript files to measure code coverage when tests run inside a web browser.
- Threshold Enforcements - Enforces minimum coverage thresholds and triggers errors if requirements are not met.
- Distributed Coverage Aggregation - Combines fragmented coverage reports from multiple concurrent execution processes into a single unified dataset.
- Coverage Data Aggregators - Combines fragmented coverage data from multiple concurrent processes into a single unified dataset.
- File Filtering Utilities - Provides mechanisms to exclude specific files and directories from analysis using globs and path patterns.
- Coverage Exclusion Markers - Allows developers to exclude specific code blocks or paths from coverage calculations via source comments.
- Coverage Exclusions - Allows marking specific statements, branches, or blocks using source comments to remove them from coverage calculations.
- Data Exports - Provides a utility to export detailed execution counts for statements, branches, functions, and lines into JSON reports.
- Report Generators - Generates visual and text summaries of code coverage in HTML, LCOV, and console formats.
- Test Report Aggregators - Collects and merges coverage data from multiple separate processes into a unified report.
- Unit Testing Utilities - Tracks code execution and enforces minimum coverage thresholds during automated unit testing.
- Assertions and Coverage - Code coverage measurement tool.
- Test-Frameworks - Code coverage tool.
