fix(coverage): istanbul to support import attributes (#6006)

Gravitonic · web-flow · commit 2898a525d358 · 2024-07-01T09:07:58.000+03:00
diff --git a/packages/coverage-istanbul/package.json b/packages/coverage-istanbul/package.json
@@ -44,9 +44,10 @@
     "vitest": "workspace:*"
   },
   "dependencies": {
+    "@istanbuljs/schema": "^0.1.3",
     "debug": "^4.3.5",
     "istanbul-lib-coverage": "^3.2.2",
-    "istanbul-lib-instrument": "^6.0.2",
+    "istanbul-lib-instrument": "^6.0.3",
     "istanbul-lib-report": "^3.0.1",
     "istanbul-lib-source-maps": "^5.0.4",
     "istanbul-reports": "^3.1.7",
diff --git a/packages/coverage-istanbul/src/provider.ts b/packages/coverage-istanbul/src/provider.ts
@@ -28,6 +28,8 @@ import type { CoverageMap } from 'istanbul-lib-coverage'
 import libCoverage from 'istanbul-lib-coverage'
 import libSourceMaps from 'istanbul-lib-source-maps'
 import { type Instrumenter, createInstrumenter } from 'istanbul-lib-instrument'
+// @ts-expect-error @istanbuljs/schema has no type definitions
+import { defaults as istanbulDefaults } from '@istanbuljs/schema'
 
 // @ts-expect-error missing types
 import _TestExclude from 'test-exclude'
@@ -116,6 +118,13 @@ export class IstanbulCoverageProvider
       coverageGlobalScope: 'globalThis',
       coverageGlobalScopeFunc: false,
       ignoreClassMethods: this.options.ignoreClassMethods,
+      parserPlugins: [
+        ...istanbulDefaults.instrumenter.parserPlugins,
+        ['importAttributes', { deprecatedAssertSyntax: true }],
+      ],
+      generatorOpts: {
+        importAttributesKeyword: 'with',
+      },
     })
 
     this.testExclude = new _TestExclude({
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/coverage-test/fixtures/src/json-data-import.ts b/test/coverage-test/fixtures/src/json-data-import.ts
@@ -0,0 +1,5 @@
+import data from "./json-data.json" with { "type": "json" };
+
+export function getJSON() {
+  return data
+};
diff --git a/test/coverage-test/fixtures/src/json-data.json b/test/coverage-test/fixtures/src/json-data.json
@@ -0,0 +1,4 @@
+{
+  "foo": false,
+  "bar": "baz"
+}
diff --git a/test/coverage-test/fixtures/test/import-attributes-fixture.test.ts b/test/coverage-test/fixtures/test/import-attributes-fixture.test.ts
@@ -0,0 +1,7 @@
+import { expect, test } from "vitest";
+import {getJSON} from "../src/json-data-import";
+import json from "../src/json-data.json";
+
+test("JSON data", () => {
+  expect(getJSON()).toEqual(json);
+});
diff --git a/test/coverage-test/test/import-attributes.test.ts b/test/coverage-test/test/import-attributes.test.ts
@@ -0,0 +1,18 @@
+import { expect } from 'vitest'
+import { readCoverageMap, runVitest, test } from '../utils'
+
+test('import attributes work', async () => {
+  await runVitest({
+    include: ['fixtures/test/import-attributes-fixture.test.ts'],
+    coverage: { reporter: 'json', all: false },
+  })
+
+  const coverageMap = await readCoverageMap()
+  const files = coverageMap.files()
+
+  expect(files).toMatchInlineSnapshot(`
+    [
+      "<process-cwd>/fixtures/src/json-data-import.ts",
+    ]
+  `)
+})
diff --git a/test/coverage-test/vitest.workspace.custom.ts b/test/coverage-test/vitest.workspace.custom.ts
@@ -67,6 +67,7 @@ export default defineWorkspace([
 
         // Other non-provider-specific tests that should be run on browser mode as well
         '**/ignore-hints.test.ts',
+        '**/import-attributes.test.ts',
         '**/multi-suite.test.ts',
         '**/setup-files.test.ts',
         '**/results-snapshot.test.ts',

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "foo": false,
 +  "bar": "baz"
 +}