chore: migrate to v1 (#146)

dmitry-stepanenko · web-flow · commit 7c8148dbf7cc · 2023-05-03T16:08:16.000+03:00
diff --git a/README.md b/README.md
@@ -75,6 +75,7 @@ This plugin supports Nx migrations and provides necessary version and code updat
 
 | qwik-nx version    | Nx version |
 | ------------------ | ---------- |
+| ^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    |
@@ -83,6 +84,8 @@ This plugin supports Nx migrations and provides necessary version and code updat
 | ~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 nx@15.8 or higher, you can stick to qwik-nx@0.15.
+
 ## ROADMAP:
 
 - [ ] Complete `add-nx-to-qwik`
diff --git a/packages/qwik-nx/migrations.json b/packages/qwik-nx/migrations.json
@@ -11,6 +11,18 @@
       "description": "useClientEffect$ has been changed to useVisisbleTask$",
       "cli": "nx",
       "implementation": "./src/migrations/update-use-client-effect$-to-use-visisble-task$/update-use-client-effect$-to-use-visisble-task$"
+    },
+    "migrate-cloudflare-integration": {
+      "version": "1.0.0",
+      "description": "In your entry.cloudflare-pages.ts, export fetch instead of onRequest. This is required in order to use the advanced mode of Cloudflare! it will allow future perf improvements and new features.",
+      "cli": "nx",
+      "implementation": "./src/migrations/migrate-cloudflare-integration/migrate-cloudflare-integration"
+    },
+    "add-verbose-skip-type-check-option-for-the-build-executor": {
+      "version": "1.0.0",
+      "description": "Enabled type checking can be breaking. Adding a verbose option so that it is clear how to disable it",
+      "cli": "nx",
+      "implementation": "./src/migrations/add-verbose-skip-type-check-option-for-the-build-executor/add-verbose-skip-type-check-option-for-the-build-executor"
     }
   },
   "packageJsonUpdates": {
@@ -152,6 +164,50 @@
           "version": "^0.28.5"
         }
       }
+    },
+    "1.0.0": {
+      "version": "1.0.0",
+      "packages": {
+        "@builder.io/qwik": {
+          "version": "~1.0.0"
+        },
+        "@builder.io/qwik-city": {
+          "version": "~1.0.0"
+        },
+        "@types/eslint": {
+          "version": "~8.37.0"
+        },
+        "@types/node": {
+          "version": "^18.16.1"
+        },
+        "@typescript-eslint/eslint-plugin": {
+          "version": "^5.59.1"
+        },
+        "@typescript-eslint/parser": {
+          "version": "^5.59.1"
+        },
+        "eslint-plugin-qwik": {
+          "version": "~1.0.0"
+        },
+        "typescript": {
+          "version": "^5.0.4"
+        },
+        "undici": {
+          "version": "^5.22.0"
+        },
+        "vite": {
+          "version": "^4.3.3"
+        },
+        "vitest": {
+          "version": "^0.30.1"
+        },
+        "vite-tsconfig-paths": {
+          "version": "~4.2.0"
+        },
+        "storybook-framework-qwik": {
+          "version": "^0.2.0"
+        }
+      }
     }
   }
 }
diff --git a/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/files/functions/[[path]].ts.template b/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/files/functions/[[path]].ts.template
diff --git a/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/files/src/entry.cloudflare-pages.tsx.template b/packages/qwik-nx/src/generators/integrations/cloudflare-pages-integration/files/src/entry.cloudflare-pages.tsx.template
@@ -7,10 +7,17 @@
  * - https://qwik.builder.io/integrations/deployments/cloudflare-pages/
  *
  */
-import { createQwikCity } from '@builder.io/qwik-city/middleware/cloudflare-pages';
+import {
+  createQwikCity,
+  type PlatformCloudflarePages,
+} from '@builder.io/qwik-city/middleware/cloudflare-pages';
 import qwikCityPlan from '@qwik-city-plan';
 import render from './entry.ssr';
 
-const onRequest = createQwikCity({ render, qwikCityPlan });
+declare global {
+  interface QwikCityPlatform extends PlatformCloudflarePages {}
+}
 
-export { onRequest };
+const fetch = createQwikCity({ render, qwikCityPlan });
+
+export { fetch };
diff --git a/packages/qwik-nx/src/migrations/add-verbose-skip-type-check-option-for-the-build-executor/add-verbose-skip-type-check-option-for-the-build-executor.spec.ts b/packages/qwik-nx/src/migrations/add-verbose-skip-type-check-option-for-the-build-executor/add-verbose-skip-type-check-option-for-the-build-executor.spec.ts
@@ -0,0 +1,29 @@
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
+import { Tree, readProjectConfiguration } from '@nx/devkit';
+
+import update from './add-verbose-skip-type-check-option-for-the-build-executor';
+import appGenerator from '../../generators/application/generator';
+
+describe('add-verbose-skip-type-check-option-for-the-build-executor migration', () => {
+  let tree: Tree;
+
+  beforeEach(async () => {
+    tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
+    await appGenerator(tree, { name: 'myapp' });
+  });
+
+  it('should run successfully', async () => {
+    await update(tree);
+    expect(readProjectConfiguration(tree, 'myapp').targets?.['build']).toEqual({
+      executor: 'qwik-nx:build',
+      options: {
+        runSequence: ['myapp:build.client', 'myapp:build.ssr'],
+        outputPath: 'dist/apps/myapp',
+        skipTypeCheck: false,
+      },
+      configurations: {
+        preview: {},
+      },
+    });
+  });
+});
diff --git a/packages/qwik-nx/src/migrations/add-verbose-skip-type-check-option-for-the-build-executor/add-verbose-skip-type-check-option-for-the-build-executor.ts b/packages/qwik-nx/src/migrations/add-verbose-skip-type-check-option-for-the-build-executor/add-verbose-skip-type-check-option-for-the-build-executor.ts
@@ -0,0 +1,19 @@
+import { Tree, getProjects, updateProjectConfiguration } from '@nx/devkit';
+import { isQwikNxProject } from '../../utils/migrations';
+
+export default function update(host: Tree) {
+  const projects = getProjects(host);
+
+  projects.forEach((config, name) => {
+    if (isQwikNxProject(config)) {
+      const buildTarget = config.targets?.['build'];
+      if (buildTarget?.options) {
+        buildTarget.options = {
+          ...buildTarget.options,
+          skipTypeCheck: false,
+        };
+        updateProjectConfiguration(host, name, config);
+      }
+    }
+  });
+}
diff --git a/packages/qwik-nx/src/migrations/migrate-cloudflare-integration/__snapshots__/migrate-cloudflare-integration.spec.ts.snap b/packages/qwik-nx/src/migrations/migrate-cloudflare-integration/__snapshots__/migrate-cloudflare-integration.spec.ts.snap
@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`migrate-cloudflare-integration migration should run successfully: entry.cloudflare-pages.tsx 1`] = `
+"import { createQwikCity } from '@builder.io/qwik-city/middleware/cloudflare-pages';
+    import qwikCityPlan from '@qwik-city-plan';
+    import render from './entry.ssr';
+    
+    const fetch = createQwikCity({ render, qwikCityPlan });
+    
+    export { fetch };"
+`;
diff --git a/packages/qwik-nx/src/migrations/migrate-cloudflare-integration/migrate-cloudflare-integration.spec.ts b/packages/qwik-nx/src/migrations/migrate-cloudflare-integration/migrate-cloudflare-integration.spec.ts
@@ -0,0 +1,37 @@
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
+import { Tree } from '@nx/devkit';
+
+import update from './migrate-cloudflare-integration';
+import { appGenerator } from '../../generators/application/generator';
+
+describe('migrate-cloudflare-integration migration', () => {
+  let tree: Tree;
+
+  beforeEach(async () => {
+    tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
+    await appGenerator(tree, { name: 'myapp' });
+    tree.write('apps/myapp/functions/[[path]].ts', 'export default {}');
+    tree.write(
+      'apps/myapp/adapters/cloudflare-pages/vite.config.ts',
+      'export default {}'
+    );
+    tree.write(
+      'apps/myapp/src/entry.cloudflare-pages.tsx',
+      `import { createQwikCity } from '@builder.io/qwik-city/middleware/cloudflare-pages';
+    import qwikCityPlan from '@qwik-city-plan';
+    import render from './entry.ssr';
+    
+    const onRequest = createQwikCity({ render, qwikCityPlan });
+    
+    export { onRequest };`
+    );
+  });
+
+  it('should run successfully', async () => {
+    await update(tree);
+    expect(tree.exists('apps/myapp/functions/[[path]].ts')).toBe(false);
+    expect(
+      tree.read('apps/myapp/src/entry.cloudflare-pages.tsx', 'utf-8')
+    ).toMatchSnapshot('entry.cloudflare-pages.tsx');
+  });
+});
diff --git a/packages/qwik-nx/src/migrations/migrate-cloudflare-integration/migrate-cloudflare-integration.ts b/packages/qwik-nx/src/migrations/migrate-cloudflare-integration/migrate-cloudflare-integration.ts
@@ -0,0 +1,52 @@
+import {
+  ProjectConfiguration,
+  ensurePackage,
+  getProjects,
+  joinPathFragments,
+  Tree,
+} from '@nx/devkit';
+import {
+  hasCloudflareIntegration,
+  isQwikNxProject,
+} from '../../utils/migrations';
+import { tsMorphVersion } from '../../utils/versions';
+
+export default async function update(tree: Tree) {
+  const projects = getProjects(tree);
+
+  for (const [, config] of projects) {
+    if (isQwikNxProject(config) && hasCloudflareIntegration(tree, config)) {
+      // functions are no longer needed
+      tree.delete(joinPathFragments(config.root, 'functions/[[path]].ts'));
+      await updateCloudflarePagesEntry(tree, config);
+    }
+  }
+}
+
+async function updateCloudflarePagesEntry(
+  tree: Tree,
+  config: ProjectConfiguration
+) {
+  ensurePackage('ts-morph', tsMorphVersion);
+  const tsMorph = await import('ts-morph');
+  const filePath = joinPathFragments(
+    config.root,
+    'src/entry.cloudflare-pages.tsx'
+  );
+  const fileContent = tree.read(filePath)?.toString();
+  if (!fileContent) {
+    return;
+  }
+  const project = new tsMorph.Project();
+  const sourceFile = project.createSourceFile('temp.ts', fileContent);
+
+  sourceFile.getVariableDeclaration('onRequest')?.rename('fetch');
+
+  [...sourceFile.getExportDeclarations()]
+    .map((e) => e.getNamedExports())
+    .flat()
+    .find((n) => n.getName() === 'onRequest')
+    ?.setName('fetch');
+
+  tree.write(filePath, sourceFile.getFullText());
+}
diff --git a/packages/qwik-nx/src/migrations/update-use-client-effect$-to-use-visisble-task$/update-use-client-effect$-to-use-visisble-task$.ts b/packages/qwik-nx/src/migrations/update-use-client-effect$-to-use-visisble-task$/update-use-client-effect$-to-use-visisble-task$.ts
@@ -6,9 +6,10 @@ import {
 } from '@nx/devkit';
 import { extname } from 'path';
 import { SyntaxKind } from 'typescript';
+import { tsMorphVersion } from '../../utils/versions';
 
 export default async function update(tree: Tree) {
-  ensurePackage('ts-morph', '^17.0.0');
+  ensurePackage('ts-morph', tsMorphVersion);
   const tsMorph = await import('ts-morph');
   for (const [, definition] of getProjects(tree)) {
     visitNotIgnoredFiles(tree, definition.root, (file) => {
diff --git a/packages/qwik-nx/src/utils/migrations.ts b/packages/qwik-nx/src/utils/migrations.ts
@@ -0,0 +1,24 @@
+import { ProjectConfiguration, Tree, joinPathFragments } from '@nx/devkit';
+
+export function isQwikNxProject(config: ProjectConfiguration): boolean {
+  return config.targets?.['build']?.executor === 'qwik-nx:build';
+}
+
+export function hasCloudflareIntegration(
+  tree: Tree,
+  config: ProjectConfiguration
+) {
+  if (
+    !tree.exists(joinPathFragments(config.root, 'adapters/cloudflare-pages'))
+  ) {
+    return false;
+  }
+  if (
+    !tree.exists(
+      joinPathFragments(config.root, 'src/entry.cloudflare-pages.tsx')
+    )
+  ) {
+    return false;
+  }
+  return true;
+}
diff --git a/packages/qwik-nx/src/utils/versions.ts b/packages/qwik-nx/src/utils/versions.ts
@@ -1,17 +1,17 @@
 // qwik packages
-export const qwikVersion = '~0.100.0';
-export const qwikCityVersion = '~0.100.0';
-export const qwikEslintPluginVersion = '~0.100.0';
+export const qwikVersion = '~1.0.0';
+export const qwikCityVersion = '~1.0.0';
+export const qwikEslintPluginVersion = '~1.0.0';
 
 // css preprocessors
 export const sassVersion = '~1.56.1';
 export const lessVersion = '~4.1.3';
 export const stylusVersion = '~0.59.0';
 
-export const undiciVersion = '^5.21.0';
-export const viteVersion = '~4.2.1';
-export const viteTsconfigPathsVersion = '~4.0.7';
-export const vitestVersion = '^0.28.5';
+export const undiciVersion = '^5.22.0';
+export const viteVersion = '^4.3.3';
+export const viteTsconfigPathsVersion = '~4.2.0';
+export const vitestVersion = '^0.30.1';
 
 export const autoprefixerVersion = '~10.4.11';
 export const postcssVersion = '~8.4.16';
@@ -25,7 +25,7 @@ export const wranglerVersion = '^2.8.0';
 export const nxCloudflareWrangler = '^2.0.0';
 
 // storybook
-export const storybookFrameworkQwikVersion = '^0.0.8';
+export const storybookFrameworkQwikVersion = '^0.2.0';
 export const typesMdx = '^2.0.3';
 
 // react integartion
@@ -45,5 +45,6 @@ export const tsEslintVersion = '~5.43.0';
 export const prettierVersion = '~2.8.7';
 export const typescriptVersion = '~5.0.2';
 export const nodeFetchVersion = '~3.3.0';
-export const typesNodeVersion = '^18.15.9';
-export const typesEslint = '~8.21.3';
+export const typesNodeVersion = '^18.16.1';
+export const typesEslint = '~8.37.0';
+export const tsMorphVersion = '^17.0.0';
