feat(nx-ngrok): add 'serverTarget' rename migration

Author: domjtalbot

packages/nx-ngrok/.eslintrc.json

@@ -15,7 +15,12 @@
       "rules": {}
     },
     {
-      "files": ["./package.json", "./generators.json", "./executors.json"],
+      "files": [
+        "./package.json",
+        "./generators.json",
+        "./executors.json",
+        "./migrations.json"
+      ],
       "parser": "jsonc-eslint-parser",
       "rules": {
         "@nrwl/nx/nx-plugin-checks": "error"

packages/nx-ngrok/migrations.json

@@ -0,0 +1,10 @@
+{
+  "generators": {
+    "rename-servertarget-to-target": {
+      "version": "1.2.0",
+      "description": "Rename 'serverTarget' setting to 'target'",
+      "cli": "nx",
+      "implementation": "./src/migrations/1.2.0/rename-servertarget-to-target"
+    }
+  }
+}

packages/nx-ngrok/project.json

@@ -23,11 +23,14 @@
         "format": ["cjs"],
         "minify": true,
         "esbuildOptions": {
-          "outExtension": { ".js": ".js" }
+          "outExtension": {
+            ".js": ".js"
+          }
         },
         "sourcemap": true,
         "additionalEntryPoints": [
-          "packages/nx-ngrok/src/executors/tunnel/executor.ts"
+          "packages/nx-ngrok/src/executors/tunnel/executor.ts",
+          "packages/nx-ngrok/src/migrations/1.2.0/rename-servertarget-to-target"
         ],
         "external": ["@nrwl/devkit", "ngrok"],
         "assets": [
@@ -87,7 +90,8 @@
           "packages/nx-ngrok/**/*.ts",
           "packages/nx-ngrok/generators.json",
           "packages/nx-ngrok/executors.json",
-          "packages/nx-ngrok/package.json"
+          "packages/nx-ngrok/package.json",
+          "packages/nx-ngrok/migrations.json"
         ]
       },
       "configurations": {

packages/nx-ngrok/src/migrations/1.2.0/rename-servertarget-to-target/index.ts

@@ -0,0 +1 @@
+export * from './rename-servertarget-to-target';

packages/nx-ngrok/src/migrations/1.2.0/rename-servertarget-to-target/rename-servertarget-to-target.spec.ts

@@ -0,0 +1,72 @@
+import {
+  addProjectConfiguration,
+  readProjectConfiguration,
+} from '@nrwl/devkit';
+import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
+
+import update from './rename-servertarget-to-target';
+
+describe('Migration - rename-servertarget-to-target', () => {
+  it('should rename serverTarget to target', async () => {
+    const tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
+
+    addProjectConfiguration(
+      tree,
+      'example',
+      {
+        root: 'apps/example',
+        projectType: 'application',
+        targets: {
+          dev: {
+            executor: 'nx-ngrok:tunnel',
+            options: {
+              serverTarget: 'my-app:serve',
+            },
+          },
+        },
+      },
+      true
+    );
+
+    await update(tree);
+
+    const config = readProjectConfiguration(tree, 'example');
+
+    expect(config.targets?.dev.options).not.toHaveProperty('serverTarget');
+    expect(config.targets?.dev.options).toHaveProperty(
+      'target',
+      'my-app:serve'
+    );
+  });
+
+  it('should not add target to configurations without a serverTarget', async () => {
+    const tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
+
+    addProjectConfiguration(
+      tree,
+      'example',
+      {
+        root: 'apps/example',
+        projectType: 'application',
+        targets: {
+          dev: {
+            executor: 'nx-ngrok:tunnel',
+            options: {
+              port: 3000,
+            },
+          },
+        },
+      },
+      true
+    );
+
+    await update(tree);
+
+    const config = readProjectConfiguration(tree, 'example');
+
+    expect(config.targets?.dev.options).not.toHaveProperty('serverTarget');
+    expect(config.targets?.dev.options).not.toHaveProperty('target');
+
+    expect(config.targets?.dev.options).toHaveProperty('port', 3000);
+  });
+});

packages/nx-ngrok/src/migrations/1.2.0/rename-servertarget-to-target/rename-servertarget-to-target.ts

@@ -0,0 +1,38 @@
+import type { Tree } from '@nrwl/devkit';
+
+import {
+  formatFiles,
+  getProjects,
+  updateProjectConfiguration,
+} from '@nrwl/devkit';
+
+export async function update(tree: Tree) {
+  const projects = getProjects(tree);
+
+  projects.forEach((config, name) => {
+    let shouldUpdate = false;
+
+    Object.entries(config.targets ?? {})?.forEach(([targetName, target]) => {
+      if (target.executor === 'nx-ngrok:tunnel') {
+        if (
+          Object.prototype.hasOwnProperty.call(target.options, 'serverTarget')
+        ) {
+          const value = target.options['serverTarget'];
+
+          if (config.targets?.[targetName].options['serverTarget']) {
+            shouldUpdate = true;
+
+            delete config.targets[targetName].options['serverTarget'];
+            config.targets[targetName].options['target'] = value;
+          }
+        }
+      }
+    });
+
+    if (shouldUpdate) updateProjectConfiguration(tree, name, config);
+  });
+
+  await formatFiles(tree);
+}
+
+export default update;