fix(vitest): add migration to prefix reportsDirectory with {projectRoot}

The reportsDirectory option is now resolved relative to the workspace root
instead of the project root. This migration prepends {projectRoot}/ to
existing reportsDirectory values so the resolved path remains the same.

Author: llwt

packages/vitest/migrations.json

@@ -17,6 +17,11 @@
       },
       "description": "Create AI Instructions to help migrate users workspaces past breaking changes for Vitest 4.",
       "implementation": "./src/migrations/update-22-1-0/create-ai-instructions-for-vitest-4"
+    },
+    "update-22-6-0-prefix-reports-directory": {
+      "version": "22.6.0-beta.0",
+      "description": "Prefix reportsDirectory with {projectRoot} to maintain correct resolution after workspace-root-relative behavior change.",
+      "implementation": "./src/migrations/update-22-6-0/prefix-reports-directory-with-project-root"
     }
   },
   "packageJsonUpdates": {

packages/vitest/src/migrations/update-22-6-0/prefix-reports-directory-with-project-root.md

@@ -0,0 +1,35 @@
+#### Prefix `reportsDirectory` with `{projectRoot}`
+
+The `reportsDirectory` option for `@nx/vitest:test` (and `@nx/vite:test`) is now resolved relative to the workspace root instead of the project root. This migration prepends `{projectRoot}/` to existing `reportsDirectory` values so the resolved path remains the same.
+
+#### Sample Code Changes
+
+##### Before
+
+```json title="project.json"
+{
+  "targets": {
+    "test": {
+      "executor": "@nx/vitest:test",
+      "options": {
+        "reportsDirectory": "coverage/libs/my-lib"
+      }
+    }
+  }
+}
+```
+
+##### After
+
+```json title="project.json" {6}
+{
+  "targets": {
+    "test": {
+      "executor": "@nx/vitest:test",
+      "options": {
+        "reportsDirectory": "{projectRoot}/coverage/libs/my-lib"
+      }
+    }
+  }
+}
+```

packages/vitest/src/migrations/update-22-6-0/prefix-reports-directory-with-project-root.spec.ts

@@ -0,0 +1,290 @@
+import {
+  addProjectConfiguration,
+  readNxJson,
+  readProjectConfiguration,
+  type Tree,
+  updateNxJson,
+} from '@nx/devkit';
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
+import prefixReportsDirectoryWithProjectRoot from './prefix-reports-directory-with-project-root';
+
+describe('prefix-reports-directory-with-project-root', () => {
+  let tree: Tree;
+
+  beforeEach(() => {
+    tree = createTreeWithEmptyWorkspace();
+  });
+
+  describe('project configuration migration', () => {
+    it('should prepend {projectRoot}/ to reportsDirectory for @nx/vitest:test', () => {
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'libs/my-lib',
+        targets: {
+          test: {
+            executor: '@nx/vitest:test',
+            options: {
+              reportsDirectory: 'coverage/libs/my-lib',
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const projectConfig = readProjectConfiguration(tree, 'my-lib');
+      expect(projectConfig.targets.test.options.reportsDirectory).toBe(
+        '{projectRoot}/coverage/libs/my-lib'
+      );
+    });
+
+    it('should prepend {projectRoot}/ to reportsDirectory for @nx/vite:test', () => {
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'libs/my-lib',
+        targets: {
+          test: {
+            executor: '@nx/vite:test',
+            options: {
+              reportsDirectory: 'coverage/libs/my-lib',
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const projectConfig = readProjectConfiguration(tree, 'my-lib');
+      expect(projectConfig.targets.test.options.reportsDirectory).toBe(
+        '{projectRoot}/coverage/libs/my-lib'
+      );
+    });
+
+    it('should migrate reportsDirectory in target configurations', () => {
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'libs/my-lib',
+        targets: {
+          test: {
+            executor: '@nx/vitest:test',
+            options: {
+              reportsDirectory: 'coverage/libs/my-lib',
+            },
+            configurations: {
+              ci: {
+                reportsDirectory: 'reports/ci/my-lib',
+              },
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const projectConfig = readProjectConfiguration(tree, 'my-lib');
+      expect(projectConfig.targets.test.options.reportsDirectory).toBe(
+        '{projectRoot}/coverage/libs/my-lib'
+      );
+      expect(
+        projectConfig.targets.test.configurations.ci.reportsDirectory
+      ).toBe('{projectRoot}/reports/ci/my-lib');
+    });
+
+    it('should not modify reportsDirectory that already has {projectRoot}', () => {
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'libs/my-lib',
+        targets: {
+          test: {
+            executor: '@nx/vitest:test',
+            options: {
+              reportsDirectory: '{projectRoot}/coverage',
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const projectConfig = readProjectConfiguration(tree, 'my-lib');
+      expect(projectConfig.targets.test.options.reportsDirectory).toBe(
+        '{projectRoot}/coverage'
+      );
+    });
+
+    it('should not modify absolute reportsDirectory paths', () => {
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'libs/my-lib',
+        targets: {
+          test: {
+            executor: '@nx/vitest:test',
+            options: {
+              reportsDirectory: '/absolute/path/to/coverage',
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const projectConfig = readProjectConfiguration(tree, 'my-lib');
+      expect(projectConfig.targets.test.options.reportsDirectory).toBe(
+        '/absolute/path/to/coverage'
+      );
+    });
+
+    it('should not modify projects without reportsDirectory', () => {
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'libs/my-lib',
+        targets: {
+          test: {
+            executor: '@nx/vitest:test',
+            options: {
+              configFile: 'libs/my-lib/vite.config.ts',
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const projectConfig = readProjectConfiguration(tree, 'my-lib');
+      expect(
+        projectConfig.targets.test.options.reportsDirectory
+      ).toBeUndefined();
+    });
+
+    it('should not modify other executors', () => {
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'libs/my-lib',
+        targets: {
+          test: {
+            executor: '@nx/jest:jest',
+            options: {
+              reportsDirectory: 'coverage/libs/my-lib',
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const projectConfig = readProjectConfiguration(tree, 'my-lib');
+      expect(projectConfig.targets.test.options.reportsDirectory).toBe(
+        'coverage/libs/my-lib'
+      );
+    });
+
+    it('should migrate multiple projects', () => {
+      addProjectConfiguration(tree, 'lib-a', {
+        root: 'libs/lib-a',
+        targets: {
+          test: {
+            executor: '@nx/vitest:test',
+            options: {
+              reportsDirectory: 'coverage/libs/lib-a',
+            },
+          },
+        },
+      });
+
+      addProjectConfiguration(tree, 'lib-b', {
+        root: 'libs/lib-b',
+        targets: {
+          test: {
+            executor: '@nx/vitest:test',
+            options: {
+              reportsDirectory: 'coverage/libs/lib-b',
+            },
+          },
+        },
+      });
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      expect(
+        readProjectConfiguration(tree, 'lib-a').targets.test.options
+          .reportsDirectory
+      ).toBe('{projectRoot}/coverage/libs/lib-a');
+      expect(
+        readProjectConfiguration(tree, 'lib-b').targets.test.options
+          .reportsDirectory
+      ).toBe('{projectRoot}/coverage/libs/lib-b');
+    });
+  });
+
+  describe('targetDefaults migration', () => {
+    it('should migrate reportsDirectory in executor-keyed targetDefaults', () => {
+      const nxJson = readNxJson(tree);
+      nxJson.targetDefaults = {
+        '@nx/vitest:test': {
+          options: {
+            reportsDirectory: 'coverage',
+          },
+        },
+      };
+      updateNxJson(tree, nxJson);
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const updatedNxJson = readNxJson(tree);
+      expect(
+        updatedNxJson.targetDefaults['@nx/vitest:test'].options.reportsDirectory
+      ).toBe('{projectRoot}/coverage');
+    });
+
+    it('should migrate reportsDirectory in target-name-keyed targetDefaults', () => {
+      const nxJson = readNxJson(tree);
+      nxJson.targetDefaults = {
+        test: {
+          executor: '@nx/vitest:test',
+          options: {
+            reportsDirectory: 'coverage',
+          },
+        },
+      };
+      updateNxJson(tree, nxJson);
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const updatedNxJson = readNxJson(tree);
+      expect(updatedNxJson.targetDefaults.test.options.reportsDirectory).toBe(
+        '{projectRoot}/coverage'
+      );
+    });
+
+    it('should not modify targetDefaults for unrelated executors', () => {
+      const nxJson = readNxJson(tree);
+      nxJson.targetDefaults = {
+        '@nx/jest:jest': {
+          options: {
+            reportsDirectory: 'coverage',
+          },
+        },
+      };
+      updateNxJson(tree, nxJson);
+
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const updatedNxJson = readNxJson(tree);
+      expect(
+        updatedNxJson.targetDefaults['@nx/jest:jest'].options.reportsDirectory
+      ).toBe('coverage');
+    });
+
+    it('should handle workspace without targetDefaults', () => {
+      const nxJson = readNxJson(tree);
+      delete nxJson.targetDefaults;
+      updateNxJson(tree, nxJson);
+
+      // Should not throw
+      prefixReportsDirectoryWithProjectRoot(tree);
+
+      const updatedNxJson = readNxJson(tree);
+      expect(updatedNxJson.targetDefaults).toBeUndefined();
+    });
+  });
+
+  describe('no-op scenarios', () => {
+    it('should handle empty workspace', () => {
+      // Should not throw
+      prefixReportsDirectoryWithProjectRoot(tree);
+    });
+  });
+});