refactor(testing): improve vitest config factory and test coverage

Author: Szymon.Poltorak

testing/test-setup-config/README.md

@@ -5,33 +5,7 @@ Utilities to centralize and standardize Vitest configuration across the monorepo
 - `vitest-config-factory.ts`: builds typed Vitest configs with sensible defaults
 - `vitest-setup-presets.ts`: provides create functions and exportable setup file groups
 
-The create functions (`createUnitConfig`, `createIntConfig`, `createE2eConfig`) automatically include appropriate setup files for each test type.
-
-### Defaults
-
-**Common**: `reporters: ['basic']`, `globals: true`, `environment: 'node'`, `pool: 'threads'` with `singleThread: true`, alias from tsconfig paths
-
-**Coverage**: Unit/Int enabled (reports to `<projectRoot>/packages/<project>/.coverage`), E2E disabled. Excludes `['mocks/**', '**/types.ts']`
-
-**Global setup**: Unit/Int use `['<projectRoot>/global-setup.ts']`, E2E none by default
-
-**Include patterns**: Unit `src/**/*.unit.test.*`, Int `src/**/*.int.test.*`, E2E `tests/**/*.e2e.test.*`
-
-### Setup files
-
-**Automatic inclusion**: Unit (console mocking, cleanup, UI/filesystem mocks, basic matchers), Int (console mocking, cleanup), E2E (cleanup only)
-
-**Custom setup files**: ⚠️ Specifying `setupFiles` in overrides will completely replace the defaults. To extend the default list, manually combine them with `setupPresets`:
-
-- `setupPresets.unit.{base, git, portalClient, matchersCore, matcherPath}`
-- `setupPresets.int.{base, cliui, fs, git, portalClient, matcherPath, chromePath}`
-- `setupPresets.e2e.{base}`
-
-### Parameters
-
-- `projectKey`: Used for cache and coverage directory naming
-- `projectRoot`: Required path/URL to the project root for resolving all paths
-- Standard Vitest configuration options can be provided in the overrides parameter
+The create functions (`createUnitConfig`, `createIntConfig`, `createE2eConfig`) automatically include appropriate setup files for each test type. See the unit tests for detailed documentation of defaults, coverage settings, and setup file presets.
 
 ### Examples
 

testing/test-setup-config/src/lib/vitest-config-factory.ts

@@ -11,9 +11,21 @@ import { tsconfigPathAliases } from './vitest-tsconfig-path-aliases.js';
 export type TestKind = 'unit' | 'int' | 'e2e';
 
 export type VitestConfigFactoryOptions = {
+  /**
+   * Used for cache and coverage directory naming
+   */
   projectKey: string;
+  /**
+   * Required path/URL to the project root for resolving all paths
+   */
   kind: TestKind;
+  /**
+   * The root directory of the project
+   */
   projectRoot: string | URL;
+  /**
+   * Optional test cache directory name
+   */
   cacheKey?: string;
 };
 
@@ -35,7 +47,7 @@ export function createVitestConfig(
             : `${options.projectRoot}/`,
         )
       : options.projectRoot;
-  const cacheDirName = options.cacheKey ?? options.projectKey;
+  const cacheDirName = options.cacheKey ?? `cache-${options.projectKey}`;
 
   const coverageEnabled =
     overrides.test?.coverage?.enabled ?? options.kind !== 'e2e';

testing/test-setup-config/src/lib/vitest-config-factory.unit.test.ts

@@ -69,7 +69,7 @@ describe('createVitestConfig', () => {
 
       expect(config).toEqual(
         expect.objectContaining({
-          cacheDir: mockPath('node_modules', '.vite', 'test-package'),
+          cacheDir: mockPath('node_modules', '.vite', 'cache-test-package'),
           test: expect.objectContaining({
             reporters: ['basic'],
             globals: true,
@@ -115,7 +115,7 @@ describe('createVitestConfig', () => {
             MOCK_PROJECT_ROOT_URL,
             'node_modules',
             '.vite',
-            'test-package',
+            'cache-test-package',
           ),
           test: expect.objectContaining({
             include: EXPECTED_INCLUDES.unit,
@@ -254,7 +254,7 @@ describe('createVitestConfig', () => {
       );
     });
 
-    it('should fallback to projectKey when cacheKey is not provided', () => {
+    it('should fallback to cache-{projectKey} when cacheKey is not provided', () => {
       const options: VitestConfigFactoryOptions = {
         projectKey: 'test-package',
         kind: 'unit',
@@ -265,7 +265,7 @@ describe('createVitestConfig', () => {
 
       expect(config).toEqual(
         expect.objectContaining({
-          cacheDir: mockPath('node_modules', '.vite', 'test-package'),
+          cacheDir: mockPath('node_modules', '.vite', 'cache-test-package'),
         }),
       );
     });