test_runner: Add option to exclude empty lines from coverage report
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- javascript, node.js, typescript
- Área
- cli, testing-qa
Línea de trabajo
Comienza con el reportero de cobertura del ejecutor de pruebas de Node.js y revisa los issues relacionados #54753, #55228 y #55339, incluido el enfoque revertido. Reproduce el informe de líneas vacías usando los comandos del issue y, después, define pruebas que demuestren que la nueva opción de CLI excluye las líneas no ejecutables sin reducir la precisión de la cobertura.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Feature Request: Add --test-coverage-exclude-empty-lines option to test runner
Summary
The Node.js test runner's coverage reporter (--experimental-test-coverage) reports empty lines and certain non-executable lines as "uncovered", leading to inaccurate coverage percentages. Other V8-based coverage tools like Vitest have solved this with an ignoreEmptyLines / excludeEmptyLines option.
Problem
When running tests with coverage using the native test runner:
node --test --experimental-test-coverage tests/**/*.test.ts
Empty lines between statements are reported as uncovered:
# file | line % | branch % | funcs % | uncovered lines
# parse.ts | 99.18 | 78.49 | 100.00 | 118 183-184
Looking at line 118:
116: // Find the element declaration for this root
117: const elementEntry = findElementByName(schema, rootLocalName);
118:
119: if (!elementEntry) {
Line 118 is empty - it contains no executable code, yet it's reported as uncovered.
Expected Behavior
Empty lines, comments, and TypeScript type-only lines should be excluded from coverage calculations, or there should be an option to exclude them.
How Other Tools Solve This
Vitest (@vitest/coverage-v8)
Vitest uses v8-to-istanbul with the excludeEmptyLines option:
- Issue: https://github.com/vitest-dev/vitest/issues/5423
- Implementation uses
@jridgewell/trace-mappingto determine which lines contain runtime code
v8-to-istanbul
PR implementing this feature: https://github.com/istanbuljs/v8-to-istanbul/pull/244
The approach:
When source maps are available, use
@jridgewell/trace-mappingto figure out which lines contain runtime code. If a line is not present in source maps, consider it as empty line. This will exclude TypeScript typings, comments, empty lines and any other special syntax that transpiled languages exclude from source maps.
c8
c8 also uses v8-to-istanbul and can leverage the same excludeEmptyLines option.
Previous Attempts
- PR #55228 attempted to add "ignore unmapped lines for coverage"
- PR #55339 reverted it due to test accuracy issues
- Issue #54753 tracks this feature request
Proposed Solution
Add a CLI flag --test-coverage-exclude-empty-lines (or similar) that:
- Uses source map information to identify non-executable lines
- Excludes empty lines from coverage calculations
- Optionally excludes comments (when source maps indicate they're not runtime code)
This could be implemented by:
- Integrating
v8-to-istanbul'sexcludeEmptyLineslogic - Or using
@jridgewell/trace-mappingdirectly to filter coverage data
Reproduction
# Create a simple TypeScript file with empty lines
cat > test.ts << 'EOF'
export function add(a: number, b: number): number {
const result = a + b;
return result;
}
EOF
cat > test.test.ts << 'EOF'
import { describe, it } from 'node:test';
import assert from 'node:assert';
import { add } from './test.ts';
describe('add', () => {
it('should add numbers', () => {
assert.equal(add(1, 2), 3);
});
});
EOF
# Run with coverage (using tsx for TypeScript)
npx tsx --test --experimental-test-coverage test.test.ts
The empty line (line 3) will show as uncovered despite 100% of executable code being tested.
Environment
- Node.js: v24.10.0
- OS: Linux
Related Issues
- #54753 - Original feature request
- #55228 - Previous implementation attempt
- #55339 - Revert of #55228
- Lenguaje dominante
- JavaScript
- Estrellas
- 122k
- Forks
- 37.4k
- Merge medio
- 4 d 3 h
- PR fusionados (30 d)
- 272
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de nodejs/node
-
doc
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
build
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
feature request
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Todos los issues de nodejs/node
Issues similares
-
code-quality refactoring
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
langchain-ai/deepagents#6450 ·
-
optimization optimization:agents-md-curator
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
githubnext/gh-aw-cao#13143 ·
-
status: needs triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100