feat(qwik-nx): add "root" prop migration

Author: dmitry-stepanenko

packages/qwik-nx/migrations.json

@@ -1,17 +1,23 @@
 {
-  "generators": {},
+  "generators": {
+    "add-root-property-to-vite-config": {
+      "version": "3.0.0",
+      "description": "Migration for v3.0.0",
+      "implementation": "./src/migrations/add-root-property-to-vite-config"
+    }
+  },
   "packageJsonUpdates": {
     "3.0.0": {
-      "version": "2.3.0",
+      "version": "3.0.0",
       "packages": {
         "@builder.io/qwik": {
-          "version": "~1.10.0"
+          "version": "~1.12.0"
         },
         "@builder.io/qwik-city": {
-          "version": "~1.10.0"
+          "version": "~1.12.0"
         },
         "eslint-plugin-qwik": {
-          "version": "~1.10.0"
+          "version": "~1.12.0"
         },
         "vite": {
           "version": "~5.3.5"

packages/qwik-nx/src/migrations/__snapshots__/add-root-property-to-vite-config.spec.ts.snap

@@ -0,0 +1,24 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`add-root-property-to-vite-config migration should add/update the "root" property 1`] = `
+"import { qwikVite } from \\"@builder.io/qwik/optimizer\\";
+import { defineConfig } from \\"vite\\";
+import tsconfigPaths from \\"vite-tsconfig-paths\\";
+import { qwikNxVite } from \\"qwik-nx/plugins\\";
+export default defineConfig({
+    root: apps / myapp,
+    plugins: [
+        qwikNxVite(),
+        qwikVite({
+            client: {
+                outDir: \\"../../dist/apps/myapp/client\\",
+            },
+            ssr: {
+                outDir: \\"../../dist/apps/myapp/server\\",
+            },
+        }),
+        tsconfigPaths({ root: \\"../../\\" }),
+    ]
+});
+"
+`;

packages/qwik-nx/src/migrations/add-root-property-to-vite-config.spec.ts

@@ -0,0 +1,48 @@
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
+import { Tree } from '@nx/devkit';
+
+import appGenerator from '../generators/application/generator';
+import update from './add-root-property-to-vite-config';
+
+describe('add-root-property-to-vite-config migration', () => {
+  let tree: Tree;
+
+  beforeEach(async () => {
+    tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
+    await appGenerator(tree, { directory: 'apps/myapp' });
+  });
+
+  it('should add/update the "root" property', async () => {
+    const viteConfigPath = `apps/myapp/vite.config.ts`;
+    // just to ensure the file at that paths exists before updating it
+    expect(tree.exists(viteConfigPath)).toBeTruthy();
+
+    tree.write(viteConfigPath, getViteConfigSample());
+    update(tree);
+    expect(tree.read(viteConfigPath, 'utf-8')).toMatchSnapshot();
+  });
+});
+
+const getViteConfigSample = (
+  includeRootProp = false
+) => `import { qwikVite } from '@builder.io/qwik/optimizer';
+import { defineConfig } from 'vite';
+import tsconfigPaths from 'vite-tsconfig-paths';
+import { qwikNxVite } from 'qwik-nx/plugins';
+
+export default defineConfig({
+  ${includeRootProp ? '\nroot: "apps/myapp"' : ''}
+  plugins: [
+    qwikNxVite(),
+    qwikVite({
+      client: {
+        outDir: '../../dist/apps/myapp/client',
+      },
+      ssr: {
+        outDir: '../../dist/apps/myapp/server',
+      },
+    }),
+    tsconfigPaths({ root: '../../' }),
+  ],
+});
+`;

packages/qwik-nx/src/migrations/add-root-property-to-vite-config.ts

@@ -0,0 +1,29 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { getProjects, Tree } from '@nx/devkit';
+import { isQwikNxProject } from '../utils/migrations';
+import { normalizeViteConfigFilePathWithTree } from '@nx/vite';
+import { updateViteConfig } from '../utils/update-vite-config';
+
+export default function update(host: Tree) {
+  const projects = getProjects(host);
+
+  projects.forEach((config, name) => {
+    if (isQwikNxProject(config)) {
+      const viteConfigPath = normalizeViteConfigFilePathWithTree(
+        host,
+        config.root
+      );
+      if (!viteConfigPath) {
+        return;
+      }
+      const viteConfig = host.read(viteConfigPath)!.toString();
+
+      const updated = updateViteConfig(viteConfig, {
+        viteConfig: {
+          root: config.root,
+        },
+      });
+      host.write(viteConfigPath, updated);
+    }
+  });
+}