oxc-coverage-instrument 0.2.14 → 0.2.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oxc-coverage-instrument",
-  "version": "0.2.14",
+  "version": "0.2.16",
   "description": "Istanbul-compatible JavaScript/TypeScript coverage instrumentation using the Oxc AST. 8-48x faster than istanbul-lib-instrument.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -61,12 +61,12 @@
     "test": "node test.mjs"
   },
   "optionalDependencies": {
-    "@oxc-coverage-instrument/binding-darwin-arm64": "0.2.14",
-    "@oxc-coverage-instrument/binding-darwin-x64": "0.2.14",
-    "@oxc-coverage-instrument/binding-linux-x64-gnu": "0.2.14",
-    "@oxc-coverage-instrument/binding-linux-arm64-gnu": "0.2.14",
-    "@oxc-coverage-instrument/binding-linux-x64-musl": "0.2.14",
-    "@oxc-coverage-instrument/binding-win32-x64-msvc": "0.2.14",
-    "@oxc-coverage-instrument/binding-win32-arm64-msvc": "0.2.14"
+    "@oxc-coverage-instrument/binding-darwin-arm64": "0.2.16",
+    "@oxc-coverage-instrument/binding-darwin-x64": "0.2.16",
+    "@oxc-coverage-instrument/binding-linux-x64-gnu": "0.2.16",
+    "@oxc-coverage-instrument/binding-linux-arm64-gnu": "0.2.16",
+    "@oxc-coverage-instrument/binding-linux-x64-musl": "0.2.16",
+    "@oxc-coverage-instrument/binding-win32-x64-msvc": "0.2.16",
+    "@oxc-coverage-instrument/binding-win32-arm64-msvc": "0.2.16"
   }
 }

package/vitest.d.ts

@@ -1,10 +1,23 @@
+/**
+ * Options for creating an Oxc-based coverage instrumenter.
+ *
+ * When used with Vitest's `coverage.instrumenter` option, the factory receives
+ * `InstrumenterOptions` with `coverageVariable` and `ignoreClassMethods`.
+ */
+export interface OxcInstrumenterOptions {
+  /** Global variable name for coverage data (Vitest passes `__VITEST_COVERAGE__`). */
+  coverageVariable?: string
+  /** Class method names to exclude from function coverage. */
+  ignoreClassMethods?: string[]
+  /** When true, adds truthy-value tracking (bT) for logical expressions. */
+  reportLogic?: boolean
+}
+
 /**
  * Creates an instrumenter that implements the istanbul-lib-instrument
  * Instrumenter interface, backed by oxc-coverage-instrument.
  *
- * Use with Vitest's `coverage.instrumenter` option (requires vitest with
- * custom instrumenter support):
- *
+ * @example
  * ```ts
  * import { defineConfig } from 'vitest/config'
  * import { createOxcInstrumenter } from 'oxc-coverage-instrument/vitest'
@@ -13,21 +26,16 @@
  *   test: {
  *     coverage: {
  *       provider: 'istanbul',
- *       instrumenter: () => createOxcInstrumenter(),
+ *       instrumenter: (options) => createOxcInstrumenter(options),
  *     }
  *   }
  * })
  * ```
  */
-export declare function createOxcInstrumenter(options?: {
-  /** Name of the global coverage variable (default: "__coverage__"). */
-  coverageVariable?: string
-  /** Class method names to exclude from function coverage. */
-  ignoreClassMethods?: string[]
-  /** When true, adds truthy-value tracking (bT) for logical expressions. */
-  reportLogic?: boolean
-}): {
+export declare function createOxcInstrumenter(options?: OxcInstrumenterOptions): {
   instrumentSync(code: string, filename: string, inputSourceMap?: any): string
   lastSourceMap(): any
   lastFileCoverage(): any
+  /** Property alias for compatibility with vite-plugin-istanbul. */
+  readonly fileCoverage: any
 }

package/vitest.js

@@ -12,7 +12,7 @@
 //     test: {
 //       coverage: {
 //         provider: 'istanbul',
-//         instrumenter: createOxcInstrumenter(),
+//         instrumenter: (options) => createOxcInstrumenter(options),
 //       }
 //     }
 //   })
@@ -23,13 +23,19 @@ const { instrument } = require('./index.js');
  * Creates an instrumenter that implements the istanbul-lib-instrument
  * Instrumenter interface, backed by oxc-coverage-instrument.
  *
+ * When used with Vitest's `coverage.instrumenter` option, the factory receives
+ * `InstrumenterOptions` with `coverageVariable` and `ignoreClassMethods`.
+ * These are forwarded to the native instrumenter automatically.
+ *
  * @param {object} [options]
- * @param {string} [options.coverageVariable='__coverage__']
- * @param {string[]} [options.ignoreClassMethods=[]]
- * @param {boolean} [options.reportLogic=false]
- * @returns {Instrumenter}
+ * @param {string} [options.coverageVariable] - Global variable for coverage data.
+ *   Vitest passes its internal `__VITEST_COVERAGE__`; defaults to `__coverage__`.
+ * @param {string[]} [options.ignoreClassMethods] - Class methods to skip.
+ * @param {boolean} [options.reportLogic] - Enable truthy-value tracking (bT).
+ * @returns {{ instrumentSync, lastSourceMap, lastFileCoverage }}
  */
-function createOxcInstrumenter(options = {}) {
+function createOxcInstrumenter(options) {
+  options = options || {};
   const coverageVariable = options.coverageVariable || '__coverage__';
   const ignoreClassMethods = options.ignoreClassMethods || [];
   const reportLogic = options.reportLogic || false;
@@ -38,13 +44,6 @@ function createOxcInstrumenter(options = {}) {
   let _lastFileCoverage = null;
 
   return {
-    /**
-     * Instrument source code synchronously.
-     * @param {string} code - Source code to instrument.
-     * @param {string} filename - File path for coverage map.
-     * @param {object} [inputSourceMap] - Input source map from prior transform.
-     * @returns {string} Instrumented source code.
-     */
     instrumentSync(code, filename, inputSourceMap) {
       const result = instrument(code, filename, {
         coverageVariable,
@@ -60,21 +59,18 @@ function createOxcInstrumenter(options = {}) {
       return result.code;
     },
 
-    /**
-     * Get the source map of the last instrumented file.
-     * @returns {object|null}
-     */
     lastSourceMap() {
       return _lastSourceMap;
     },
 
-    /**
-     * Get the coverage object of the last instrumented file.
-     * @returns {object}
-     */
     lastFileCoverage() {
       return _lastFileCoverage;
     },
+
+    // Property alias used by vite-plugin-istanbul (vs lastFileCoverage() method used by Vitest)
+    get fileCoverage() {
+      return _lastFileCoverage;
+    },
   };
 }