Support Vitest projects configuration for dynamic project discovery (#1171)

Author: yyxi

packages/knip/fixtures/plugins/vitest9/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@fixtures/vitest9",
+  "workspaces": ["packages/*"],
+  "devDependencies": {
+    "vitest": "*"
+  }
+}

packages/knip/fixtures/plugins/vitest9/packages/client/e2e-setup.ts

@@ -0,0 +1,3 @@
+export function setup() {
+  // E2E test setup
+}

packages/knip/fixtures/plugins/vitest9/packages/client/e2e/client.test.ts

@@ -0,0 +1,5 @@
+import { test, expect } from 'vitest';
+
+test('client e2e test', () => {
+  expect(true).toBe(true);
+});

packages/knip/fixtures/plugins/vitest9/packages/client/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@fixtures/vitest9-client",
+  "devDependencies": {
+    "vitest": "*"
+  }
+}

packages/knip/fixtures/plugins/vitest9/packages/client/vitest.config.e2e.ts

@@ -0,0 +1,8 @@
+export default {
+  test: {
+    name: 'client-e2e',
+    include: ['e2e/**/*.test.ts'],
+    setupFiles: ['./e2e-setup.ts'],
+    environment: 'happy-dom',
+  },
+};

packages/knip/fixtures/plugins/vitest9/src/example.test.ts

@@ -0,0 +1,8 @@
+// Unit test file
+import { describe, it, expect } from 'vitest';
+
+describe('example unit test', () => {
+  it('should work', () => {
+    expect(1 + 1).toBe(2);
+  });
+});

packages/knip/fixtures/plugins/vitest9/src/unit.setup.ts

@@ -0,0 +1,3 @@
+export function setup() {
+  // Unit test setup
+}

packages/knip/fixtures/plugins/vitest9/vitest.config.ts

@@ -0,0 +1,18 @@
+export default {
+  test: {
+    projects: [
+      {
+        name: 'unit',
+        test: {
+          include: ['src/**/*.test.ts'],
+          setupFiles: ['./src/unit.setup.ts'],
+          environment: 'jsdom',
+        },
+      },
+      'packages/*/vitest.config.e2e.ts',
+    ],
+    coverage: {
+      enabled: false,
+    },
+  },
+};

packages/knip/src/plugins/vitest/index.ts

@@ -1,7 +1,8 @@
 import { DEFAULT_EXTENSIONS } from '../../constants.js';
 import type { IsPluginEnabled, Plugin, PluginOptions, ResolveConfig } from '../../types/config.js';
 import type { PackageJson } from '../../types/package-json.js';
-import { type Input, toAlias, toDeferResolve, toDependency, toEntry } from '../../util/input.js';
+import { _glob } from '../../util/glob.js';
+import { type Input, toAlias, toConfig, toDeferResolve, toDependency, toEntry } from '../../util/input.js';
 import { join, toPosix } from '../../util/path.js';
 import { hasDependency } from '../../util/plugin.js';
 import { getEnvPackageName, getExternalReporters } from './helpers.js';
@@ -50,11 +51,21 @@ const findConfigDependencies = (localConfig: ViteConfig, options: PluginOptions)
     }
   }
 
+  const projectsDependencies: Input[] = [];
+  if (testConfig.projects !== undefined) {
+    for (const projectConfig of testConfig.projects) {
+      if (typeof projectConfig !== 'string') {
+        projectsDependencies.push(...findConfigDependencies(projectConfig, options));
+      }
+    }
+  }
+
   return [
     ...[...environments, ...reporters, ...coverage].map(id => toDependency(id)),
     ...setupFiles,
     ...globalSetup,
     ...workspaceDependencies,
+    ...projectsDependencies,
   ];
 };
 
@@ -67,10 +78,24 @@ const getConfigs = async (localConfig: ViteConfigOrFn | VitestWorkspaceConfig) =
           for (const mode of ['development', 'production'] as MODE[]) {
             const cfg = await config({ command, mode, ssrBuild: undefined });
             configs.push(cfg);
+            if (cfg.test?.projects) {
+              for (const project of cfg.test.projects) {
+                if (typeof project !== 'string') {
+                  configs.push(project);
+                }
+              }
+            }
           }
         }
       } else {
         configs.push(config);
+        if (config.test?.projects) {
+          for (const project of config.test.projects) {
+            if (typeof project !== 'string') {
+              configs.push(project);
+            }
+          }
+        }
       }
     }
   }
@@ -84,6 +109,23 @@ export const resolveConfig: ResolveConfig<ViteConfigOrFn | VitestWorkspaceConfig
 
   const configs = await getConfigs(localConfig);
 
+  for (const cfg of configs) {
+    if (cfg.test?.projects) {
+      for (const project of cfg.test.projects) {
+        if (typeof project === 'string') {
+          const projectFiles = await _glob({
+            cwd: options.cwd,
+            patterns: [project],
+            gitignore: false,
+          });
+          for (const projectFile of projectFiles) {
+            inputs.add(toConfig('vitest', projectFile, { containingFilePath: options.configFilePath }));
+          }
+        }
+      }
+    }
+  }
+
   const addStar = (value: string) => (value.endsWith('*') ? value : join(value, '*').replace(/\/\*\*$/, '/*'));
   const addAliases = (aliasOptions: AliasOptions) => {
     for (const [alias, value] of Object.entries(aliasOptions)) {

packages/knip/src/plugins/vitest/types.ts

@@ -19,6 +19,7 @@ interface VitestConfig {
     reporters?: (string | [string, unknown] | unknown)[];
     setupFiles?: string | string[];
     workspace?: (ViteConfig & { test: VitestConfig['test'] & { workspace: never } })[];
+    projects?: (string | (ViteConfig & { test: VitestConfig['test'] & { projects: never } }))[];
     alias?: AliasOptions;
   };
 }