refactor(testing): remove Vitest reference comments from configuration files

Szymon.Poltorak · Szymon.Poltorak · commit 2772f2b617da · 2025-11-05T09:56:41.000+01:00
diff --git a/e2e/ci-e2e/vitest.e2e.config.ts b/e2e/ci-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('ci-e2e', {
diff --git a/e2e/cli-e2e/vitest.e2e.config.ts b/e2e/cli-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('cli-e2e', {
diff --git a/e2e/create-cli-e2e/vitest.e2e.config.ts b/e2e/create-cli-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('create-cli-e2e', {
diff --git a/e2e/nx-plugin-e2e/vitest.e2e.config.ts b/e2e/nx-plugin-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('nx-plugin-e2e', {
diff --git a/e2e/plugin-coverage-e2e/vitest.e2e.config.ts b/e2e/plugin-coverage-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('plugin-coverage-e2e', {
diff --git a/e2e/plugin-eslint-e2e/vitest.e2e.config.ts b/e2e/plugin-eslint-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('plugin-eslint-e2e', {
diff --git a/e2e/plugin-js-packages-e2e/vitest.e2e.config.ts b/e2e/plugin-js-packages-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('plugin-js-packages-e2e', {
diff --git a/e2e/plugin-jsdocs-e2e/vitest.e2e.config.ts b/e2e/plugin-jsdocs-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('plugin-jsdocs-e2e', {
diff --git a/e2e/plugin-lighthouse-e2e/vitest.e2e.config.ts b/e2e/plugin-lighthouse-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('plugin-lighthouse-e2e', {
diff --git a/e2e/plugin-typescript-e2e/vitest.e2e.config.ts b/e2e/plugin-typescript-e2e/vitest.e2e.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createE2ETestConfig('plugin-typescript-e2e', {
diff --git a/examples/plugins/vitest.int.config.ts b/examples/plugins/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('examples-plugins');
diff --git a/examples/plugins/vitest.unit.config.ts b/examples/plugins/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('examples-plugins');
diff --git a/packages/ci/vitest.int.config.ts b/packages/ci/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 let config = createIntTestConfig('ci');
diff --git a/packages/ci/vitest.unit.config.ts b/packages/ci/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 let config = createUnitTestConfig('ci');
diff --git a/packages/cli/vitest.int.config.ts b/packages/cli/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('cli');
diff --git a/packages/cli/vitest.unit.config.ts b/packages/cli/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('cli');
diff --git a/packages/core/vitest.int.config.ts b/packages/core/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('core');
diff --git a/packages/core/vitest.unit.config.ts b/packages/core/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('core');
diff --git a/packages/create-cli/vitest.unit.config.ts b/packages/create-cli/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('create-cli');
diff --git a/packages/models/vitest.unit.config.ts b/packages/models/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('models');
diff --git a/packages/nx-plugin/vitest.int.config.ts b/packages/nx-plugin/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('nx-plugin');
diff --git a/packages/nx-plugin/vitest.unit.config.ts b/packages/nx-plugin/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('nx-plugin');
diff --git a/packages/plugin-coverage/vitest.int.config.ts b/packages/plugin-coverage/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('plugin-coverage');
diff --git a/packages/plugin-coverage/vitest.unit.config.ts b/packages/plugin-coverage/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('plugin-coverage');
diff --git a/packages/plugin-eslint/mocks/fixtures/nx-monorepo/package-lock.json b/packages/plugin-eslint/mocks/fixtures/nx-monorepo/package-lock.json
diff --git a/packages/plugin-eslint/vitest.int.config.ts b/packages/plugin-eslint/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('plugin-eslint');
diff --git a/packages/plugin-eslint/vitest.unit.config.ts b/packages/plugin-eslint/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('plugin-eslint');
diff --git a/packages/plugin-js-packages/vitest.int.config.ts b/packages/plugin-js-packages/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('plugin-js-packages');
diff --git a/packages/plugin-js-packages/vitest.unit.config.ts b/packages/plugin-js-packages/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('plugin-js-packages');
diff --git a/packages/plugin-jsdocs/vitest.int.config.ts b/packages/plugin-jsdocs/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('plugin-jsdocs');
diff --git a/packages/plugin-jsdocs/vitest.unit.config.ts b/packages/plugin-jsdocs/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('plugin-jsdocs');
diff --git a/packages/plugin-lighthouse/vitest.unit.config.ts b/packages/plugin-lighthouse/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('plugin-lighthouse');
diff --git a/packages/plugin-typescript/vitest.int.config.ts b/packages/plugin-typescript/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('plugin-typescript');
diff --git a/packages/plugin-typescript/vitest.unit.config.ts b/packages/plugin-typescript/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('plugin-typescript');
diff --git a/packages/utils/vitest.int.config.ts b/packages/utils/vitest.int.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createIntTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createIntTestConfig('utils');
diff --git a/packages/utils/vitest.unit.config.ts b/packages/utils/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('utils');
diff --git a/testing/test-nx-utils/vitest.unit.config.ts b/testing/test-nx-utils/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('test-nx-utils');
diff --git a/testing/test-setup-config/src/lib/vitest-config-factory.ts b/testing/test-setup-config/src/lib/vitest-config-factory.ts
@@ -1,5 +1,5 @@
 import type { CoverageOptions } from 'vitest';
-import { type UserConfig as ViteUserConfig, defineConfig } from 'vitest/config';
+import { type UserConfig as ViteUserConfig } from 'vitest/config';
 import { getSetupFiles } from './vitest-setup-files.js';
 import { tsconfigPathAliases } from './vitest-tsconfig-path-aliases.js';
 
@@ -48,7 +48,7 @@ export function createVitestConfig(
 ): ViteUserConfig {
   const coverage = buildCoverageConfig(projectKey, kind);
 
-  const config: ViteUserConfig = {
+  return {
     cacheDir: `../../node_modules/.vite/${projectKey}`,
     test: {
       reporters: ['basic'],
@@ -70,6 +70,4 @@ export function createVitestConfig(
         : {}),
     },
   };
-
-  return defineConfig(config);
 }
diff --git a/testing/test-setup-config/src/lib/vitest-config-factory.unit.test.ts b/testing/test-setup-config/src/lib/vitest-config-factory.unit.test.ts
@@ -1,16 +1,7 @@
 import { describe, expect, it, vi } from 'vitest';
-import { defineConfig } from 'vitest/config';
 import type { E2ETestOptions, TestKind } from './vitest-config-factory.js';
 import { createVitestConfig } from './vitest-config-factory.js';
 
-vi.mock('vitest/config', async importOriginal => {
-  const actual = await importOriginal<typeof import('vitest/config')>();
-  return {
-    ...actual,
-    defineConfig: vi.fn(config => config),
-  };
-});
-
 vi.mock('./vitest-tsconfig-path-aliases.js', () => ({
   tsconfigPathAliases: vi
     .fn()
@@ -50,7 +41,6 @@ describe('createVitestConfig', () => {
           typecheck: { include: ['**/*.type.test.ts'] },
         }),
       });
-      expect(defineConfig).toHaveBeenCalledWith(config);
     });
 
     it('should include all required setup files for unit tests', () => {
@@ -75,6 +65,9 @@ describe('createVitestConfig', () => {
       expect(setupFiles).toContain(
         '../../testing/test-setup/src/lib/portal-client.mock.ts',
       );
+      expect(setupFiles).toContain(
+        '../../testing/test-setup/src/lib/logger.mock.ts',
+      );
       expect(setupFiles).toContain(
         '../../testing/test-setup/src/lib/extend/ui-logger.matcher.ts',
       );
@@ -137,6 +130,9 @@ describe('createVitestConfig', () => {
       expect(setupFiles).toContain(
         '../../testing/test-setup/src/lib/console.mock.ts',
       );
+      expect(setupFiles).toContain(
+        '../../testing/test-setup/src/lib/logger.mock.ts',
+      );
       expect(setupFiles).not.toContain(
         '../../testing/test-setup/src/lib/fs.mock.ts',
       );
diff --git a/testing/test-setup-config/src/lib/vitest-setup-files.ts b/testing/test-setup-config/src/lib/vitest-setup-files.ts
@@ -26,6 +26,7 @@ const UNIT_TEST_SETUP_FILES = [
   '../../testing/test-setup/src/lib/cliui.mock.ts',
   '../../testing/test-setup/src/lib/git.mock.ts',
   '../../testing/test-setup/src/lib/portal-client.mock.ts',
+  '../../testing/test-setup/src/lib/logger.mock.ts',
   ...CUSTOM_MATCHERS,
 ] as const;
 
@@ -40,6 +41,7 @@ const INT_TEST_SETUP_FILES = [
   '../../testing/test-setup/src/lib/console.mock.ts',
   '../../testing/test-setup/src/lib/reset.mocks.ts',
   '../../testing/test-setup/src/lib/chrome-path.mock.ts',
+  '../../testing/test-setup/src/lib/logger.mock.ts',
   ...CUSTOM_MATCHERS,
 ] as const;
 
diff --git a/testing/test-setup-config/src/lib/vitest-setup-files.unit.test.ts b/testing/test-setup-config/src/lib/vitest-setup-files.unit.test.ts
@@ -7,7 +7,7 @@ describe('vitest-setup-files', () => {
       it('should return all required setup files for unit tests', () => {
         const setupFiles = getSetupFiles('unit');
 
-        expect(setupFiles).toHaveLength(10);
+        expect(setupFiles).toHaveLength(11);
         expect(setupFiles).toContain(
           '../../testing/test-setup/src/lib/console.mock.ts',
         );
@@ -26,6 +26,9 @@ describe('vitest-setup-files', () => {
         expect(setupFiles).toContain(
           '../../testing/test-setup/src/lib/portal-client.mock.ts',
         );
+        expect(setupFiles).toContain(
+          '../../testing/test-setup/src/lib/logger.mock.ts',
+        );
         expect(setupFiles).toContain(
           '../../testing/test-setup/src/lib/extend/ui-logger.matcher.ts',
         );
@@ -42,10 +45,10 @@ describe('vitest-setup-files', () => {
     });
 
     describe('integration test setup files', () => {
-      it('should return exactly 7 setup files with essential mocks and custom matchers', () => {
+      it('should return exactly 8 setup files with essential mocks and custom matchers', () => {
         const setupFiles = getSetupFiles('int');
 
-        expect(setupFiles).toHaveLength(7);
+        expect(setupFiles).toHaveLength(8);
         expect(setupFiles).toContain(
           '../../testing/test-setup/src/lib/console.mock.ts',
         );
@@ -55,6 +58,9 @@ describe('vitest-setup-files', () => {
         expect(setupFiles).toContain(
           '../../testing/test-setup/src/lib/chrome-path.mock.ts',
         );
+        expect(setupFiles).toContain(
+          '../../testing/test-setup/src/lib/logger.mock.ts',
+        );
       });
 
       it('should include custom matchers for integration tests', () => {
diff --git a/testing/test-setup-config/vitest.unit.config.ts b/testing/test-setup-config/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from './src/index.js';
 
 export default createUnitTestConfig('test-setup-config');
diff --git a/testing/test-setup/src/lib/logger.mock.ts b/testing/test-setup/src/lib/logger.mock.ts
@@ -1,9 +1,11 @@
 import { type MockInstance, afterAll, beforeAll, vi } from 'vitest';
-import { logger } from '@code-pushup/utils';
 
 const loggerSpies: MockInstance[] = [];
 
-beforeAll(() => {
+beforeAll(async () => {
+  const { logger }: typeof import('@code-pushup/utils') =
+    await vi.importActual('@code-pushup/utils');
+
   // TODO: use vi.mockObject after Vitest update: https://vitest.dev/api/vi.html#vi-mockobject-3-2-0
   if (process.env['NX_VERBOSE_LOGGING'] === 'true') {
     // only track calls, but preserve original implementation so logs are printed
diff --git a/testing/test-setup/vitest.unit.config.ts b/testing/test-setup/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('test-setup');
diff --git a/testing/test-utils/vitest.unit.config.ts b/testing/test-utils/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('test-utils');
diff --git a/tools/eslint-formatter-multi/vitest.unit.config.ts b/tools/eslint-formatter-multi/vitest.unit.config.ts
@@ -1,4 +1,3 @@
-/// <reference types="vitest" />
 import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
 
 export default createUnitTestConfig('eslint-formatter-multi');

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-/// <reference types="vitest" />`
`2`	`1`	`import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';`
`3`	`2`
`4`	`3`	`export default createE2ETestConfig('ci-e2e', {`