vitest: Detect whether coverage is enabled in npm scripts (#378)

* vitest: Detect whether coverage is enabled in npm scripts * use regular expression for detecting coverage cli flag
webpro-nl · Dec 4, 2023 · 9fc7d1f · 9fc7d1f
1 parent 358250f
commit 9fc7d1f
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 6 deletions.
diff --git a/packages/knip/fixtures/plugins/vitest-npm-script/package.json b/packages/knip/fixtures/plugins/vitest-npm-script/package.json
@@ -0,0 +1,9 @@
+{
+  "name": "@fixtures/vitest-npm-script",
+  "scripts": {
+    "test:coverage": "vitest --coverage"
+  },
+  "devDependencies": {
+    "vitest": "^0.34.6"
+  }
+}
diff --git a/packages/knip/fixtures/plugins/vitest-npm-script/vitest.config.ts b/packages/knip/fixtures/plugins/vitest-npm-script/vitest.config.ts
@@ -0,0 +1,8 @@
+export default {
+  test: {
+    coverage: {
+      enabled: false,
+      provider: 'v8',
+    },
+  },
+};
diff --git a/packages/knip/src/plugins/vitest/index.ts b/packages/knip/src/plugins/vitest/index.ts
@@ -5,6 +5,7 @@ import { hasDependency, load, tryResolve } from '../../util/plugin.js';
 import { toEntryPattern } from '../../util/protocols.js';
 import { getEnvPackageName, getExternalReporters } from './helpers.js';
 import type { ViteConfigOrFn, VitestWorkspaceConfig, ViteConfig, MODE, COMMAND } from './types.js';
+import type { PackageJsonWithPlugins } from '../../types/package-json.js';
 import type {
   IsPluginEnabledCallback,
   GenericPluginCallback,
@@ -36,12 +37,20 @@ const resolveEntry = (containingFilePath: string, specifier: string) => {
   return specifier;
 };
 
+const enablesCoverageInScript = /vitest(.+)--coverage(?:\.enabled(?:=true)?)?/;
+
+const hasScriptWithCoverage = (scripts: Exclude<PackageJsonWithPlugins['scripts'], undefined>) => {
+  return Object.values(scripts).some(script => {
+    return enablesCoverageInScript.test(script);
+  });
+};
+
 const findConfigDependencies = (
   configFilePath: string,
   localConfig: ViteConfig,
   options: GenericPluginCallbackOptions
 ) => {
-  const { isProduction, config } = options;
+  const { isProduction, config, manifest } = options;
   const testConfig = localConfig.test;
 
   const entryPatterns = (config?.entry ?? testConfig?.include ?? ENTRY_FILE_PATTERNS).map(toEntryPattern);
@@ -50,10 +59,12 @@ const findConfigDependencies = (
 
   const environments = testConfig.environment ? [getEnvPackageName(testConfig.environment)] : [];
   const reporters = getExternalReporters(testConfig.reporters);
-  const coverage =
-    testConfig.coverage && testConfig.coverage.enabled !== false
-      ? [`@vitest/coverage-${testConfig.coverage.provider ?? 'v8'}`]
-      : [];
+
+  const hasCoverageEnabled =
+    (testConfig.coverage && testConfig.coverage.enabled !== false) ||
+    (manifest.scripts !== undefined && hasScriptWithCoverage(manifest.scripts));
+  const coverage = hasCoverageEnabled ? [`@vitest/coverage-${testConfig.coverage?.provider ?? 'v8'}`] : [];
+
   const setupFiles = [testConfig.setupFiles ?? []].flat().map(v => resolveEntry(configFilePath, v));
   const globalSetup = [testConfig.globalSetup ?? []].flat().map(v => resolveEntry(configFilePath, v));
   return [...entryPatterns, ...environments, ...reporters, ...coverage, ...setupFiles, ...globalSetup];

diff --git a/packages/knip/test/plugins/prettier.test.ts b/packages/knip/test/plugins/prettier.test.ts
@@ -15,6 +15,6 @@ test('Find dependencies in Prettier configuration (.prettierrc)', async () => {
 
 test('Find dependencies in Prettier configuration (package.json)', async () => {
   const configFilePath = join(cwd, 'package.json');
-  const dependencies = await prettier.findDependencies(configFilePath, {manifest});
+  const dependencies = await prettier.findDependencies(configFilePath, { manifest });
   assert.deepEqual(dependencies, ['@company/prettier-config']);
 });
diff --git a/packages/knip/test/plugins/vitest-npm-script.test.ts b/packages/knip/test/plugins/vitest-npm-script.test.ts
@@ -0,0 +1,14 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import * as vitest from '../../src/plugins/vitest/index.js';
+import { resolve, join } from '../../src/util/path.js';
+import { getManifest, pluginConfig as config } from '../helpers/index.js';
+
+const cwd = resolve('fixtures/plugins/vitest-npm-script');
+const manifest = getManifest(cwd);
+
+test('detects the coverage dependency when a npm script activates coverage', async () => {
+  const configFilePath = join(cwd, 'vitest.config.ts');
+  const dependencies = await vitest.findDependencies(configFilePath, { cwd, manifest, config });
+  assert.deepEqual(dependencies, ['entry:**/*.{test,spec}.?(c|m)[jt]s?(x)', '@vitest/coverage-v8']);
+});