45 lines
1.8 KiB
TypeScript
45 lines
1.8 KiB
TypeScript
|
import { EncodedSourceMap } from "@jridgewell/trace-mapping";
|
||
|
|
import { Node } from "estree";
|
||
|
|
import { CoverageMapData } from "istanbul-lib-coverage";
|
||
|
|
import { Profiler } from "node:inspector";
|
||
|
|
|
||
|
|
//#region src/types.d.ts
|
||
|
|
interface Options<T = Node, Program = T & {
|
||
|
|
type: "Program";
|
||
|
|
}> {
|
||
|
|
/** 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;
|
||
|
|
}
|
||
|
|
//#endregion
|
||
|
|
//#region src/index.d.ts
|
||
|
|
/**
|
||
|
|
* Maps V8 `ScriptCoverage` to Istanbul's `CoverageMap`.
|
||
|
|
* Results are identical with `istanbul-lib-instrument`.
|
||
|
|
*/
|
||
|
|
declare function convert<T = Node, Program = T & {
|
||
|
|
type: "Program";
|
||
|
|
}>(options: Options<T, Program>): Promise<CoverageMapData>;
|
||
|
|
//#endregion
|
||
|
|
export { Options, convert, convert as default };
|