Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 | 896x 896x 8x 888x 896x 896x 896x 896x 896x 896x 896x 888x 888x 220x 120x 60x 60x 132x 132x 68x 24x 24x 24x 249x 36x 36x 8x 8x 12x 12x 1872x 12x 1860x 756x 684x 48x 72x 20x 604x 604x 84x 121x 80x 80x 88x 888x 888x 492x 492x 492x 420x 420x 420x 420x 16x 16x 16x 4x 416x 3940x 8x 3932x 3932x 3700x 3940x 32x 32x 32x 4x 3696x 977x 4x 973x 973x 973x 973x 973x 1833x 224x 224x 224x 224x 224x 1609x 1609x 1609x 1609x 1833x 973x 600x 564x 973x 40x 933x 933x 5093x 5093x 5093x 8x 5085x 5409x 5333x 76x 76x 8x 76x 60x 120x | import type { Profiler } from "node:inspector";
import { dirname, resolve } from "node:path";
import { fileURLToPath } from "node:url";
import { type EncodedSourceMap, TraceMap } from "@jridgewell/trace-mapping";
import { type Node } from "estree";
import type { CoverageMapData } from "istanbul-lib-coverage";
import { type FunctionNodes, getFunctionName, getWalker } from "./ast";
import {
addBranch,
addFunction,
addStatement,
type Branch,
createCoverageMapData,
} from "./coverage-map";
import { getIgnoreHints } from "./ignore-hints";
import { createEmptySourceMap, getInlineSourceMap, Locator } from "./location";
import { getCount, normalize } from "./script-coverage";
export { convert };
/**
* Maps V8 `ScriptCoverage` to Istanbul's `CoverageMap`.
* Results are identical with `istanbul-lib-instrument`.
*/
export default async function convert<
T = Node,
Program = T & { type: "Program" },
>(options: {
/** Code of the executed runtime file, not the original source file */
code: string;
/** Length of the execution wrapper, e.g. wrapper used in node:vm */
wrapperLength?: number;
/** Source map for the current file */
sourceMap?: Omit<EncodedSourceMap, "version"> & { version: number };
/** ScriptCoverage for the current file */
coverage: Pick<Profiler.ScriptCoverage, "functions" | "url">;
/** AST for the transpiled file that matches the coverage results */
ast: Program | Promise<Program>;
/** Class method names to ignore for coverage, identical to https://github.com/istanbuljs/nyc?tab=readme-ov-file#ignoring-methods */
ignoreClassMethods?: string[];
/** Filter to ignore code based on AST nodes */
ignoreNode?: (
node: T,
type: "function" | "statement" | "branch",
) => boolean | "ignore-this-and-nested-nodes" | void;
/**
* Filter to ignore code based on source code
* - Note that this is slower than `ignoreNode` as exclusion happens after remapping
*/
ignoreSourceCode?: (
code: string,
type: "function" | "statement" | "branch",
location: Record<"start" | "end", { line: number; column: number }>,
) => boolean | void;
}): Promise<CoverageMapData> {
const ignoreHints = getIgnoreHints(options.code);
// File ignore contains always only 1 entry
if (ignoreHints.length === 1 && ignoreHints[0].type === "file") {
return {};
}
const wrapperLength = options.wrapperLength || 0;
const filename = fileURLToPath(options.coverage.url);
const directory = dirname(filename);
const map = new TraceMap(
(options.sourceMap as typeof options.sourceMap & { version: 3 }) ||
(await getInlineSourceMap(filename, options.code)) ||
createEmptySourceMap(filename, options.code),
);
const locator = new Locator(options.code, map, directory);
const coverageMapData = createCoverageMapData(filename, map);
const ranges = normalize(options.coverage);
const ast = await options.ast;
const walker = getWalker();
await walker.walk(ast, ignoreHints, options.ignoreClassMethods, {
// Functions
onFunctionDeclaration(node) {
onFunction(node, {
loc: node.body,
decl: node.id,
});
},
onFunctionExpression(node) {
if (isCovered(node)) {
return;
}
onFunction(node, {
loc: node.body,
decl: node.id || { ...node, end: node.start + 1 },
});
},
onArrowFunctionExpression(node) {
onFunction(node, {
loc: node.body,
decl: { ...node, end: node.start + 1 },
});
// Implicit return-statement of bodyless arrow function
if (node.body.type !== "BlockStatement") {
onStatement(node.body, node);
}
},
onMethodDefinition(node) {
Eif (node.value.type === "FunctionExpression") {
setCovered(node.value);
}
onFunction(node, {
loc: node.value.body,
decl: node.key,
});
},
onProperty(node) {
if (node.value.type === "FunctionExpression") {
setCovered(node.value);
onFunction(node, {
loc: node.value.body,
decl: node.key,
});
}
},
onClassMethod(babelNode) {
const node: Node = {
type: "FunctionExpression",
start: babelNode.start!,
end: babelNode.end!,
body: {
type: "BlockStatement",
start: babelNode.body.start!,
end: babelNode.body.end!,
body: [],
},
params: [],
};
onFunction(node, {
loc: node.body,
decl: {
start: babelNode.key.start!,
end: babelNode.key.end!,
},
});
},
onObjectMethod(babelNode) {
const node: Node = {
type: "FunctionExpression",
start: babelNode.start!,
end: babelNode.end!,
body: {
type: "BlockStatement",
start: babelNode.body.start!,
end: babelNode.body.end!,
body: [],
},
params: [],
};
onFunction(node, {
loc: node.body,
decl: {
start: babelNode.key.start!,
end: babelNode.key.end!,
},
});
},
// Statements
onBreakStatement: onStatement,
onContinueStatement: onStatement,
onDebuggerStatement: onStatement,
onReturnStatement: onStatement,
onThrowStatement: onStatement,
onTryStatement: onStatement,
onForStatement: onStatement,
onForInStatement: onStatement,
onForOfStatement: onStatement,
onWhileStatement: onStatement,
onDoWhileStatement: onStatement,
onWithStatement: onStatement,
onLabeledStatement: onStatement,
onExpressionStatement(node) {
if (
node.expression.type === "Literal" &&
node.expression.value === "use strict"
) {
return;
}
onStatement(node);
},
onVariableDeclarator(node) {
if (node.init) {
onStatement(node.init, node);
}
},
onClassBody(node) {
for (const child of node.body) {
if (
(child.type === "PropertyDefinition" ||
child.type === "ClassProperty" ||
child.type === "ClassPrivateProperty") &&
child.value
) {
onStatement(child.value as Node);
}
}
},
// Branches
onIfStatement(node, branches) {
onBranch("if", node, branches);
onStatement(node);
},
onConditionalExpression(node) {
onBranch("cond-expr", node, [node.consequent, node.alternate]);
},
onLogicalExpression(node, branches) {
onBranch("binary-expr", node, branches);
},
onSwitchStatement(node) {
onBranch("switch", node, node.cases);
onStatement(node);
},
onAssignmentPattern(node) {
onBranch("default-arg", node, [node.right]);
},
});
locator.reset();
return coverageMapData;
function onFunction(
node: FunctionNodes,
positions: {
loc: Pick<Node, "start" | "end">;
decl: Pick<Node, "start" | "end">;
},
) {
Iif (onIgnore(node, "function")) {
return;
}
const loc = locator.getLoc(positions.loc);
if (loc === null) return;
const decl = locator.getLoc(positions.decl);
Iif (decl === null) return;
const covered = getCount(
{
startOffset: node.start + wrapperLength,
endOffset: node.end + wrapperLength,
},
ranges,
);
if (options.ignoreSourceCode) {
const current = locator.getLoc(node) || loc;
const sources = locator.getSourceLines(
current,
getSourceFilename(current),
);
if (
sources != null &&
options.ignoreSourceCode(sources, "function", {
start: { line: current.start.line, column: current.start.column },
end: { line: current.end.line, column: current.end.column },
})
) {
return;
}
}
addFunction({
coverageMapData,
covered,
loc,
decl,
filename: getSourceFilename(loc),
name: getFunctionName(node),
});
}
function onStatement(node: Node, parent?: Node) {
if (onIgnore(parent || node, "statement")) {
return;
}
const loc = locator.getLoc(node);
if (loc === null) return;
const covered = getCount(
{
startOffset: (parent || node).start + wrapperLength,
endOffset: (parent || node).end + wrapperLength,
},
ranges,
);
if (options.ignoreSourceCode) {
const current = (parent && locator.getLoc(parent)) || loc;
const sources = locator.getSourceLines(
current,
getSourceFilename(current),
);
if (
sources != null &&
options.ignoreSourceCode(sources, "statement", {
start: { line: current.start.line, column: current.start.column },
end: { line: current.end.line, column: current.end.column },
})
) {
return;
}
}
addStatement({
coverageMapData,
loc,
covered,
filename: getSourceFilename(loc),
});
}
function onBranch(
type: Branch,
node: Node,
branches: (Node | null | undefined)[],
) {
if (onIgnore(node, "branch")) {
return;
}
const loc = locator.getLoc(node);
Iif (loc === null) return;
const locations = [];
const covered: number[] = [];
for (const branch of branches) {
if (!branch) {
locations.push({
start: { line: undefined, column: undefined },
end: { line: undefined, coolumn: undefined },
});
const count = getCount(
{
startOffset: node.start + wrapperLength,
endOffset: node.end + wrapperLength,
},
ranges,
);
const previous = covered.at(-1) || 0;
covered.push(count - previous);
continue;
}
const location = locator.getLoc(branch);
Eif (location !== null) {
locations.push(location);
}
const bias = branch.type === "BlockStatement" ? 1 : 0;
covered.push(
getCount(
{
startOffset: branch.start + bias + wrapperLength,
endOffset: branch.end - bias + wrapperLength,
},
ranges,
),
);
}
if (type === "if") {
if (locations.length > 0) {
locations[0] = loc;
}
}
if (locations.length === 0) {
return;
}
Iif (options.ignoreSourceCode) {
const sources = locator.getSourceLines(loc, getSourceFilename(loc));
if (
sources != null &&
options.ignoreSourceCode(sources, "branch", {
start: { line: loc.start.line, column: loc.start.column },
end: { line: loc.end.line, column: loc.end.column },
})
) {
return;
}
}
addBranch({
coverageMapData,
loc,
locations,
type,
covered,
filename: getSourceFilename(loc),
});
}
function getSourceFilename(position: {
start: { filename: string | null };
end: { filename: string | null };
}) {
const sourceFilename = position.start.filename || position.end.filename;
Iif (!sourceFilename) {
throw new Error(
`Missing original filename for ${JSON.stringify(position, null, 2)}`,
);
}
if (sourceFilename.startsWith("file://")) {
return fileURLToPath(sourceFilename);
}
return resolve(directory, sourceFilename);
}
function onIgnore(node: Node, type: "function" | "statement" | "branch") {
if (!options.ignoreNode) {
return false;
}
const scope = options.ignoreNode(node as T, type);
if (scope === "ignore-this-and-nested-nodes") {
walker.onIgnore(node);
}
return scope;
}
}
function setCovered(node: Node) {
// @ts-expect-error -- internal
node.__covered = true;
}
function isCovered(node: Node) {
// @ts-expect-error -- internal
return node.__covered === true;
}
|