@vitest/coverage-istanbul 3.2.0-beta.2 → 3.2.0-beta.3

package/dist/index.js

@@ -2,10 +2,13 @@ import { C as COVERAGE_STORE_KEY } from './constants-BCJfMgEg.js';
 
 const mod = {
 	takeCoverage() {
+		// @ts-expect-error -- untyped global
 		return globalThis[COVERAGE_STORE_KEY];
 	},
 	startCoverage() {
+		// @ts-expect-error -- untyped global
 		const coverageMap = globalThis[COVERAGE_STORE_KEY];
+		// When isolated, there are no previous results
 		if (!coverageMap) {
 			return;
 		}
@@ -23,6 +26,7 @@ const mod = {
 		}
 	},
 	async getProvider() {
+		// to not bundle the provider
 		const providerPath = "./provider.js";
 		const { IstanbulCoverageProvider } = await import(
 			/* @vite-ignore */

package/dist/provider.js

@@ -107,7 +107,7 @@ const isAbsolute = function(p) {
   return _IS_ABSOLUTE_RE.test(p);
 };
 
-var version = "3.2.0-beta.2";
+var version = "3.2.0-beta.3";
 
 const debug = createDebug("vitest:coverage");
 class IstanbulCoverageProvider extends BaseCoverageProvider {
@@ -139,6 +139,9 @@ class IstanbulCoverageProvider extends BaseCoverageProvider {
 		});
 	}
 	onFileTransform(sourceCode, id, pluginCtx) {
+		// Istanbul/babel cannot instrument CSS - e.g. Vue imports end up here.
+		// File extension itself is .vue, but it contains CSS.
+		// e.g. "Example.vue?vue&type=style&index=0&scoped=f7f04e08&lang.css"
 		if (id.endsWith(".css")) {
 			return;
 		}
@@ -147,6 +150,7 @@ class IstanbulCoverageProvider extends BaseCoverageProvider {
 		}
 		const sourceMap = pluginCtx.getCombinedSourcemap();
 		sourceMap.sources = sourceMap.sources.map(removeQueryParameters);
+		// Exclude SWC's decorators that are left in source maps
 		sourceCode = sourceCode.replaceAll("_ts_decorate", "/* istanbul ignore next */_ts_decorate");
 		const code = this.instrumenter.instrumentSync(sourceCode, id, sourceMap);
 		const map = this.instrumenter.lastSourceMap();
@@ -167,12 +171,16 @@ class IstanbulCoverageProvider extends BaseCoverageProvider {
 				coverageMapByTransformMode.merge(coverage);
 			},
 			onFinished: async () => {
+				// Source maps can change based on projectName and transform mode.
+				// Coverage transform re-uses source maps so we need to separate transforms from each other.
 				const transformedCoverage = await transformCoverage(coverageMapByTransformMode);
 				coverageMap.merge(transformedCoverage);
 				coverageMapByTransformMode = this.createCoverageMap();
 			},
 			onDebug: debug
 		});
+		// Include untested files when all tests were run (not a single file re-run)
+		// or if previous results are preserved by "cleanOnRerun: false"
 		if (this.options.all && (allTestsRun || !this.options.cleanOnRerun)) {
 			const coveredFiles = coverageMap.files();
 			const uncoveredCoverage = await this.getCoverageMapForUncoveredFiles(coveredFiles);
@@ -196,6 +204,7 @@ class IstanbulCoverageProvider extends BaseCoverageProvider {
 			this.ctx.logger.log(c.blue(" % ") + c.dim("Coverage report from ") + c.yellow(this.name));
 		}
 		for (const reporter of this.options.reporter) {
+			// Type assertion required for custom reporters
 			reports.create(reporter[0], {
 				skipFull: this.options.skipFull,
 				projectRoot: this.ctx.config.root,
@@ -219,6 +228,8 @@ class IstanbulCoverageProvider extends BaseCoverageProvider {
 		const cacheKey = new Date().getTime();
 		const coverageMap = this.createCoverageMap();
 		const transform = this.createUncoveredFileTransformer(this.ctx);
+		// Note that these cannot be run parallel as synchronous instrumenter.lastFileCoverage
+		// returns the coverage of the last transformed file
 		for (const [index, filename] of uncoveredFiles.entries()) {
 			let timeout;
 			let start;
@@ -227,6 +238,7 @@ class IstanbulCoverageProvider extends BaseCoverageProvider {
 				timeout = setTimeout(() => debug(c.bgRed(`File "${filename}" is taking longer than 3s`)), 3e3);
 				debug("Uncovered file %d/%d", index, uncoveredFiles.length);
 			}
+			// Make sure file is not served from cache so that instrumenter loads up requested file coverage
 			await transform(`${filename}?cache=${cacheKey}`);
 			const lastCoverage = this.instrumenter.lastFileCoverage();
 			coverageMap.addFileCoverage(lastCoverage);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/coverage-istanbul",
   "type": "module",
-  "version": "3.2.0-beta.2",
+  "version": "3.2.0-beta.3",
   "description": "Istanbul coverage provider for Vitest",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -37,11 +37,11 @@
     "dist"
   ],
   "peerDependencies": {
-    "vitest": "3.2.0-beta.2"
+    "vitest": "3.2.0-beta.3"
   },
   "dependencies": {
     "@istanbuljs/schema": "^0.1.3",
-    "debug": "^4.4.0",
+    "debug": "^4.4.1",
     "istanbul-lib-coverage": "^3.2.2",
     "istanbul-lib-instrument": "^6.0.3",
     "istanbul-lib-report": "^3.0.1",
@@ -60,7 +60,7 @@
     "@types/istanbul-reports": "^3.0.4",
     "@types/test-exclude": "^6.0.2",
     "pathe": "^2.0.3",
-    "vitest": "3.2.0-beta.2"
+    "vitest": "3.2.0-beta.3"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",