istanbuljs/nyc
Nyc
nyc is a JavaScript code coverage tool and command-line interface that instruments source files to track the execution of lines, branches, and functions during test runs. It acts as a wrapper for Node.js test runners, intercepting the module loading process to collect coverage data.
The tool functions as a coverage data merger and build gating tool, allowing users to combine results from multiple independent test runs or child processes into a single unified report. It can automatically fail the build process if code coverage percentages fall below defined minimum thresholds.
The project supports modern JavaScript and TypeScript by using source maps to link coverage data from transpiled code back to the original source files. It provides a multi-format reporting pipeline that outputs results as HTML, LCOV, JSON, XML, and plain text. Additional capabilities include glob-pattern file filtering, disk-based caching of instrumented files, and integration with testing frameworks such as Jest, Mocha, AVA, and tap.
Features
- Code Coverage - Instruments JavaScript and TypeScript source files to track executed lines, branches, and functions during test runs.
- Threshold Enforcements - Fails the build process when code coverage percentages fall below minimum target thresholds for branches, lines, and functions.
- Coverage Data Aggregators - Combines raw coverage data from separate test suites or independent runs into a single consolidated report.
- Code Instrumentation Utilities - Instruments source files during execution to collect real-time code coverage statistics.
- Source Code Mapping - Maps coverage data from transpiled code back to the original source files using source maps.
- Transpilation Mapping - Maps coverage data from compiled TypeScript or ES2015+ code back to original source files using source maps.
- Source Map Resolution - Preserves source maps during code rewriting to map coverage data from transpiled TypeScript or ES2015+ back to original lines.
- Runtime Module Hooking - Instruments source files on-the-fly by intercepting the Node.js module loading process with a custom require hook.
- Build Gating Tools - Acts as a validator that fails the build process when code coverage percentages fall below defined minimum thresholds.
- Code Coverage Tools - Provides a command-line tool to instrument JavaScript source files and track the execution of lines, branches, and functions.
- Test Runner Wrappers - Functions as a wrapper for Node.js test runners, intercepting the module loading process to collect coverage data.
- Test Runner Integrations - Connects with common testing frameworks to collect unified coverage data automatically via the command line.
- HTML Visualizations - Produces a browsable HTML report showing per-file code coverage with visual highlighting.
- Pre-instrumentation - Instruments source files ahead of time to facilitate coverage tracking via source maps.
- Subprocess Instrumentation - Captures and merges code coverage data from multiple child processes spawned during tests.
- TypeScript Instrumentation - Transpiles TypeScript source files to ensure compatible instrumentation and coverage tracking.
- Glob Pattern Selectors - Allows selecting source files for instrumentation using include and exclude glob patterns.
- Modern JavaScript Instrumentation - Transpiles modern JavaScript syntax to ensure compatible instrumentation and coverage tracking.
- Coverage Summaries - Provides coverage summaries and file-level statistics directly to the command line in text or TeamCity formats.
- Analysis Report Serialization - Serializes coverage analysis results into multiple human-readable and machine-readable formats.
- Reporting Plugins - Uses a plugin-based architecture to output coverage results in multiple formats including HTML, LCOV, JSON, and XML.
- Coverage Exclusions - Provides mechanisms to ignore specific lines, blocks, or files from coverage metrics using inline hints and configuration.
- Report Generators - Transforms raw coverage data into diverse report formats such as HTML, LCOV, JSON, and XML.
- Detailed JSON Reporting - Produces detailed JSON reports containing per-file coverage data for statements, functions, and branches.
- Summary Reports - Outputs a concise JSON summary containing aggregate coverage percentages.
- Test Coverage Collections - Captures and merges coverage metrics from child processes spawned during the execution of tests.
- Testing and Quality Assurance - Command line interface for code coverage.
- 测试框架 - CLI for Istanbul coverage.
