fix(qwik-nx): resolve nx versions manually (#223)

Author: dmitry-stepanenko

.github/workflows/test.yml

@@ -11,7 +11,6 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node_version: [16]
         os: [ubuntu-latest, windows-latest]
 
     steps:
@@ -24,7 +23,7 @@ jobs:
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          node_version: ${{ matrix.node_version }}
+          node_version: 18
 
       - name: Test
         uses: ./.github/actions/test

README.md

@@ -91,18 +91,18 @@ This plugin supports Nx migrations and provides necessary version and code updat
 
 ## qwik-nx & Nx Compatibility Chart
 
-| qwik-nx version    | Nx version           |
-| ------------------ | -------------------- |
-| ~2.0.0             | ~17.0.0 \|\| ~17.1.0 |
-| ^1.1.0             | ^16.8.0              |
-| ^1.0.0             | ^16.0.0              |
-| ^0.16.0            | ^16.0.0              |
-| >= 0.12.0 < 0.16.0 | ^15.8.0              |
-| ~0.10.0, ~0.11.0   | ~15.7.2              |
-| >= 0.6.0 < 0.10.0  | ~15.6.0              |
-| ~0.5.0             | ~15.5.0              |
-| ~0.4.0             | ~15.4.0              |
-| <=0.4.0            | ^15.0.0              |
+| qwik-nx version    | Nx version |
+| ------------------ | ---------- |
+| ^2.0.0             | ^17.0.0    |
+| ^1.1.0             | ^16.8.0    |
+| ^1.0.0             | ^16.0.0    |
+| ^0.16.0            | ^16.0.0    |
+| >= 0.12.0 < 0.16.0 | ^15.8.0    |
+| ~0.10.0, ~0.11.0   | ~15.7.2    |
+| >= 0.6.0 < 0.10.0  | ~15.6.0    |
+| ~0.5.0             | ~15.5.0    |
+| ~0.4.0             | ~15.4.0    |
+| <=0.4.0            | ^15.0.0    |
 
 We will provide support for Nx 15 with critical bug fixes and minor features for a while. If you're using [email protected] or higher, you can stick to [email protected].
 

e2e/qwik-nx-e2e/tests/application-basic-behavior.suite.ts

@@ -30,6 +30,7 @@ export function testApplicationBasicBehavior(generator: 'app' | 'preset') {
     let rootRoutePath: string;
     let libComponentName: string;
     let libComponentPath: string;
+    let appComponentSpecFilePath: string;
 
     beforeAll(async () => {
       await killPorts(devServerPort, previewServerPort);
@@ -40,6 +41,7 @@ export function testApplicationBasicBehavior(generator: 'app' | 'preset') {
       project = uniq('qwik-nx');
       libProject = uniq('qwik-nx');
       rootRoutePath = `${appPathPrefix}${project}/src/routes/index.tsx`;
+      appComponentSpecFilePath = `${appPathPrefix}${project}/src/components/my-test-component/my-test-component.spec.tsx`;
       libComponentPath = `${libPathPrefix}${libProject}/src/lib/${libProject}.tsx`;
       libComponentName = names(libProject).className;
 
@@ -168,8 +170,24 @@ export function testApplicationBasicBehavior(generator: 'app' | 'preset') {
         expect(result.stdout).toContain(
           `Successfully ran target test for project ${project}`
         );
-        expect(stripConsoleColors(result.stdout)).toContain(
-          `Test Files  1 passed`
+      },
+      DEFAULT_E2E_TIMEOUT
+    );
+
+    it(
+      'unit tests should fail (when we want it)',
+      async () => {
+        updateFile(appComponentSpecFilePath, (content) => {
+          return content.replace(
+            `toContain('MyTestComponent works!')`,
+            `toContain('Not existing string')`
+          );
+        });
+        const result = await runNxCommandAsync(`test ${project}`, {
+          silenceError: true,
+        });
+        expect(result.stdout).toContain(
+          `Running target test for project ${project} failed`
         );
       },
       DEFAULT_E2E_TIMEOUT

e2e/qwik-nx-e2e/tests/chore.spec.ts

@@ -20,12 +20,13 @@ describe('misc checks', () => {
     async () => {
       const packageJson = readJson('node_modules/qwik-nx/package.json');
 
-      expect(packageJson.peerDependencies).toBeUndefined();
-      expect(packageJson.dependencies).toEqual({
-        '@nx/devkit': '>=17.0.0 <17.2.0',
-        '@nx/js': '>=17.0.0 <17.2.0',
-        '@nx/eslint': '>=17.0.0 <17.2.0',
-        '@nx/vite': '>=17.0.0 <17.2.0',
+      expect(packageJson.dependencies).toBeUndefined();
+      expect(packageJson.devDependencies).toBeUndefined();
+      expect(packageJson.peerDependencies).toEqual({
+        '@nx/devkit': '^17.0.0',
+        '@nx/js': '^17.0.0',
+        '@nx/eslint': '^17.0.0',
+        '@nx/vite': '^17.0.0',
       });
     },
     DEFAULT_E2E_TIMEOUT

package.json

@@ -41,6 +41,7 @@
     "@types/fs-extra": "11.0.1",
     "@types/jest": "29.4.0",
     "@types/node": "16.11.7",
+    "@types/semver": "7.5.6",
     "@types/tcp-port-used": "1.0.1",
     "@types/yargs": "17.0.24",
     "@typescript-eslint/eslint-plugin": "5.62.0",
@@ -67,6 +68,7 @@
     "nx": "17.0.3",
     "prettier": "^2.8.0",
     "pretty-quick": "^3.1.3",
+    "semver": "7.6.0",
     "tcp-port-used": "1.0.2",
     "tree-kill": "1.2.2",
     "ts-jest": "29.1.0",

packages/qwik-nx/migrations.json

@@ -289,6 +289,26 @@
           "version": "~4.4.11"
         }
       }
+    },
+    "2.1.0": {
+      "version": "2.1.0",
+      "packages": {
+        "@builder.io/qwik": {
+          "version": "~1.4.4"
+        },
+        "@builder.io/qwik-city": {
+          "version": "~1.4.4"
+        },
+        "eslint-plugin-qwik": {
+          "version": "~1.4.4"
+        },
+        "vite": {
+          "version": "~5.0.0"
+        },
+        "vitest": {
+          "version": "^1.0.0"
+        }
+      }
     }
   }
 }

packages/qwik-nx/package.json

@@ -21,11 +21,11 @@
   },
   "generators": "./generators.json",
   "executors": "./executors.json",
-  "dependencies": {
-    "@nx/devkit": ">=17.0.0 <17.2.0",
-    "@nx/js": ">=17.0.0 <17.2.0",
-    "@nx/vite": ">=17.0.0 <17.2.0",
-    "@nx/eslint": ">=17.0.0 <17.2.0"
+  "peerDependencies": {
+    "@nx/devkit": "^17.0.0",
+    "@nx/js": "^17.0.0",
+    "@nx/vite": "^17.0.0",
+    "@nx/eslint": "^17.0.0"
   },
   "nx-migrations": {
     "migrations": "./migrations.json"

packages/qwik-nx/src/generators/application/generator-internal.ts

@@ -0,0 +1,109 @@
+import {
+  addProjectConfiguration,
+  formatFiles,
+  generateFiles,
+  GeneratorCallback,
+  joinPathFragments,
+  names,
+  TargetConfiguration,
+  Tree,
+  runTasksInSerial,
+} from '@nx/devkit';
+import { Linter } from '@nx/eslint';
+import { initGenerator } from '@nx/vite';
+import { initGenerator as jsInitGenerator } from '@nx/js';
+import { addCommonQwikDependencies } from '../../utils/add-common-qwik-dependencies';
+import { addStyledModuleDependencies } from '../../utils/add-styled-dependencies';
+import { configureEslint } from '../../utils/configure-eslint';
+import setupTailwindGenerator from '../setup-tailwind/setup-tailwind';
+import { SetupTailwindOptions } from './../setup-tailwind/schema.d';
+import { NormalizedSchema, QwikAppGeneratorSchema } from './schema';
+import { getQwikApplicationProjectTargets } from './utils/get-qwik-application-project-params';
+import { normalizeOptions } from './utils/normalize-options';
+import { addE2eProject } from './utils/add-e2e';
+
+function addFiles(tree: Tree, options: NormalizedSchema) {
+  const templateOptions = {
+    ...options,
+    ...names(options.name),
+    template: '',
+  };
+  generateFiles(
+    tree,
+    joinPathFragments(__dirname, 'files'),
+    options.projectRoot,
+    templateOptions
+  );
+}
+
+export async function appGeneratorInternal(
+  tree: Tree,
+  options: QwikAppGeneratorSchema
+) {
+  const tasks: GeneratorCallback[] = [];
+
+  const normalizedOptions = await normalizeOptions(tree, options);
+
+  const targets: Record<string, TargetConfiguration> =
+    getQwikApplicationProjectTargets(normalizedOptions);
+
+  if (!normalizedOptions.setupVitest) {
+    delete targets['test'];
+  }
+
+  await jsInitGenerator(tree, {
+    skipFormat: true,
+  });
+
+  addProjectConfiguration(tree, normalizedOptions.projectName, {
+    root: normalizedOptions.projectRoot,
+    name: normalizedOptions.projectName,
+    projectType: 'application',
+    sourceRoot: `${normalizedOptions.projectRoot}/src`,
+    targets,
+    tags: normalizedOptions.parsedTags,
+  });
+
+  addFiles(tree, normalizedOptions);
+
+  tasks.push(
+    await initGenerator(tree, {
+      includeLib: false,
+      uiFramework: 'none',
+      testEnvironment: 'node',
+    })
+  );
+
+  if (normalizedOptions.linter === Linter.EsLint) {
+    tasks.push(configureEslint(tree, normalizedOptions.projectName, true));
+  }
+
+  if (normalizedOptions.styleExtension) {
+    tasks.push(
+      addStyledModuleDependencies(tree, normalizedOptions.styleExtension)
+    );
+  }
+
+  tasks.push(addCommonQwikDependencies(tree));
+
+  if (
+    normalizedOptions.e2eTestRunner &&
+    normalizedOptions.e2eTestRunner !== 'none'
+  ) {
+    const e2eProjectTask = await addE2eProject(tree, normalizedOptions);
+    tasks.push(e2eProjectTask);
+  }
+
+  if (!options.skipFormat) {
+    await formatFiles(tree);
+  }
+
+  if (options.tailwind) {
+    const twOptions: SetupTailwindOptions = {
+      project: normalizedOptions.name,
+    };
+    tasks.push(await setupTailwindGenerator(tree, twOptions));
+  }
+
+  return runTasksInSerial(...tasks);
+}

packages/qwik-nx/src/generators/application/generator.spec.ts

@@ -4,13 +4,14 @@ import { Tree, joinPathFragments, readProjectConfiguration } from '@nx/devkit';
 import generator from './generator';
 import { QwikAppGeneratorSchema } from './schema';
 import { Linter } from '@nx/eslint';
-import { getFormattedListChanges } from './../../utils/testing-generators';
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const devkit = require('@nx/devkit');
-const getInstalledNxVersionModule = require('../../utils/get-installed-nx-version');
+import {
+  getFormattedListChanges,
+  mockEnsurePackage,
+} from './../../utils/testing-generators';
 
 describe('qwik-nx generator', () => {
+  mockEnsurePackage();
+
   let appTree: Tree;
   const defaultOptions: QwikAppGeneratorSchema = {
     name: 'myapp',
@@ -22,11 +23,6 @@ describe('qwik-nx generator', () => {
     e2eTestRunner: 'none',
   };
 
-  jest.spyOn(devkit, 'ensurePackage').mockReturnValue(Promise.resolve());
-  jest
-    .spyOn(getInstalledNxVersionModule, 'getInstalledNxVersion')
-    .mockReturnValue('15.6.0');
-
   beforeEach(() => {
     appTree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
   });