@nx/detox 19.5.7 → 19.6.0-beta.1

package/generators.json

@@ -15,6 +15,11 @@
       "aliases": ["app"],
       "x-type": "application",
       "description": "Create a Detox application."
+    },
+    "convert-to-inferred": {
+      "factory": "./src/generators/convert-to-inferred/convert-to-inferred",
+      "schema": "./src/generators/convert-to-inferred/schema.json",
+      "description": "Convert existing Detox project(s) using `@nx/detox:*` executors to use `@nx/detox/plugin`. Defaults to migrating all projects. Pass '--project' to migrate only one target."
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/detox",
-  "version": "19.5.7",
+  "version": "19.6.0-beta.1",
   "private": false,
   "description": "The Nx Plugin for Detox contains executors and generators for allowing your workspace to use the powerful Detox integration testing capabilities.",
   "keywords": [
@@ -27,13 +27,13 @@
   "main": "./index",
   "types": "index.d.ts",
   "dependencies": {
-    "@nx/devkit": "19.5.7",
-    "@nx/jest": "19.5.7",
-    "@nx/js": "19.5.7",
-    "@nx/eslint": "19.5.7",
-    "@nx/react": "19.5.7",
+    "@nx/devkit": "19.6.0-beta.1",
+    "@nx/jest": "19.6.0-beta.1",
+    "@nx/js": "19.6.0-beta.1",
+    "@nx/eslint": "19.6.0-beta.1",
+    "@nx/react": "19.6.0-beta.1",
     "tslib": "^2.3.0",
-    "@nrwl/detox": "19.5.7"
+    "@nrwl/detox": "19.6.0-beta.1"
   },
   "peerDependencies": {
     "detox": "^20.9.0"

package/src/generators/application/files/app/.detoxrc.json.template

@@ -11,12 +11,12 @@
   "apps": {
     "ios.debug": {
       "type": "ios.app",
-      "build": "cd <%= offsetFromRoot %><%= appRoot %>/ios && xcodebuild -workspace <%= appClassName %>.xcworkspace -scheme <%= appClassName %> -configuration Debug -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 14' -derivedDataPath ./build -quiet",
+      "build": "cd <%= offsetFromRoot %><%= appRoot %>/ios && xcodebuild -workspace <%= appClassName %>.xcworkspace -scheme <%= appClassName %> -configuration Debug -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 15 Plus' -derivedDataPath ./build -quiet",
       "binaryPath": "<%= offsetFromRoot %><%= appRoot %>/ios/build/Build/Products/Debug-iphonesimulator/<%= appClassName %>.app"
     },
     "ios.release": {
       "type": "ios.app",
-      "build": "cd <%= offsetFromRoot %><%= appRoot %>/ios && xcodebuild -workspace <%= appClassName %>.xcworkspace -scheme <%= appClassName %> -configuration Release -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 14' -derivedDataPath ./build -quiet",
+      "build": "cd <%= offsetFromRoot %><%= appRoot %>/ios && xcodebuild -workspace <%= appClassName %>.xcworkspace -scheme <%= appClassName %> -configuration Release -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone 15 Plus' -derivedDataPath ./build -quiet",
       "binaryPath": "<%= offsetFromRoot %><%= appRoot %>/ios/build/Build/Products/Release-iphonesimulator/<%= appClassName %>.app"
     },
 <% if (framework === 'expo') { %>
@@ -48,7 +48,7 @@
     "simulator": {
       "type": "ios.simulator",
       "device": {
-        "type": "iPhone 14"
+        "type": "iPhone 15 Plus"
       }
     },
     "emulator": {

package/src/generators/convert-to-inferred/convert-to-inferred.d.ts

@@ -0,0 +1,7 @@
+import { type Tree } from '@nx/devkit';
+interface Schema {
+    project?: string;
+    skipFormat?: boolean;
+}
+export declare function convertToInferred(tree: Tree, options: Schema): Promise<() => void>;
+export default convertToInferred;

package/src/generators/convert-to-inferred/convert-to-inferred.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToInferred = convertToInferred;
+const devkit_1 = require("@nx/devkit");
+const aggregate_log_util_1 = require("@nx/devkit/src/generators/plugin-migrations/aggregate-log-util");
+const executor_to_plugin_migrator_1 = require("@nx/devkit/src/generators/plugin-migrations/executor-to-plugin-migrator");
+const plugin_1 = require("../../plugins/plugin");
+const process_build_options_1 = require("./lib/process-build-options");
+const post_target_transformer_1 = require("./lib/post-target-transformer");
+const process_test_options_1 = require("./lib/process-test-options");
+async function convertToInferred(tree, options) {
+    const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
+    const migrationLogs = new aggregate_log_util_1.AggregatedLog();
+    const migratedProjects = await (0, executor_to_plugin_migrator_1.migrateProjectExecutorsToPluginV1)(tree, projectGraph, '@nx/detox/plugin', plugin_1.createNodes, {
+        buildTargetName: 'build',
+        startTargetName: 'start',
+        testTargetName: 'test',
+    }, [
+        {
+            executors: ['@nx/detox:build'],
+            postTargetTransformer: (0, post_target_transformer_1.postTargetTransformer)(migrationLogs, process_build_options_1.processBuildOptions),
+            targetPluginOptionMapper: (targetName) => ({
+                buildTargetName: targetName, // We should use "build" instead of "build-ios" or "build-android". We'll handle this later.
+            }),
+        },
+        {
+            executors: ['@nx/detox:test'],
+            postTargetTransformer: (0, post_target_transformer_1.postTargetTransformer)(migrationLogs, process_test_options_1.processTestOptions),
+            targetPluginOptionMapper: (targetName) => ({
+                testTargetName: targetName, // We should use "test" instead of "test-ios" or "test-android". We'll handle this later.
+            }),
+        },
+    ], options.project);
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const detoxPlugins = nxJson.plugins?.filter((p) => typeof p !== 'string' && p.plugin === '@nx/detox/plugin');
+    // These were either `build-ios`, `test-ios`, etc., and we need to set them back to their generic names.
+    // The per-project targets will call these with additional `--args` passed to maintain the same
+    // behavior as previous executor-based targets.
+    for (const p of detoxPlugins) {
+        if (typeof p === 'string')
+            continue;
+        p.options['buildTargetName'] = 'build';
+        p.options['testTargetName'] = 'test';
+    }
+    // Inform the users that the inferred targets are platform-agnostic, and they can remove the old targets if unnecessary.
+    for (const [project] of migratedProjects) {
+        migrationLogs.addLog({
+            project,
+            executorName: '@nx/detox:build',
+            log: `The "build-android" target was migrated to use "nx run ${project}:build", which is platform-agnostic. If you no longer need this target, you can remove it.`,
+        });
+        migrationLogs.addLog({
+            project,
+            executorName: '@nx/detox:test',
+            log: `The "test-android" target was migrated to use "nx run ${project}:test", which is platform-agnostic. If you no longer need this target, you can remove it.`,
+        });
+        migrationLogs.addLog({
+            project,
+            executorName: '@nx/detox:build',
+            log: `The "build-ios" target was migrated to use "nx run ${project}:build", which is platform-agnostic. If you no longer need this target, you can remove it.`,
+        });
+        migrationLogs.addLog({
+            project,
+            executorName: '@nx/detox:test',
+            log: `The "test-ios" target was migrated to use "nx run ${project}:test", which is platform-agnostic. If you no longer need this target, you can remove it.`,
+        });
+    }
+    (0, devkit_1.updateNxJson)(tree, nxJson);
+    if (migratedProjects.size === 0) {
+        throw new Error('Could not find any targets to migrate.');
+    }
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+    return () => {
+        migrationLogs.flushLogs();
+    };
+}
+exports.default = convertToInferred;

package/src/generators/convert-to-inferred/lib/post-target-transformer.d.ts

@@ -0,0 +1,6 @@
+import type { TargetConfiguration, Tree } from '@nx/devkit';
+import type { AggregatedLog } from '@nx/devkit/src/generators/plugin-migrations/aggregate-log-util';
+export declare function postTargetTransformer(migrationLogs: AggregatedLog, processOptions: (tree: Tree, options: any, projectName: string, projectRoot: string, target: TargetConfiguration | undefined, migrationLogs: AggregatedLog) => void): (target: TargetConfiguration, tree: Tree, projectDetails: {
+    projectName: string;
+    root: string;
+}, inferredTargetConfiguration: TargetConfiguration) => TargetConfiguration<any>;

package/src/generators/convert-to-inferred/lib/post-target-transformer.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postTargetTransformer = postTargetTransformer;
+const plugin_migration_utils_1 = require("@nx/devkit/src/generators/plugin-migrations/plugin-migration-utils");
+function postTargetTransformer(migrationLogs, processOptions) {
+    return (target, tree, projectDetails, inferredTargetConfiguration) => {
+        if (target.options) {
+            processOptions(tree, target.options, projectDetails.projectName, projectDetails.root, target, migrationLogs);
+        }
+        if (target.configurations) {
+            for (const configurationName in target.configurations) {
+                const configuration = target.configurations[configurationName];
+                processOptions(tree, configuration, projectDetails.projectName, projectDetails.root, undefined, migrationLogs);
+            }
+            if (Object.keys(target.configurations).length === 0) {
+                if ('defaultConfiguration' in target) {
+                    delete target.defaultConfiguration;
+                }
+                delete target.configurations;
+            }
+            if ('defaultConfiguration' in target &&
+                !target.configurations[target.defaultConfiguration]) {
+                delete target.defaultConfiguration;
+            }
+        }
+        if (target.outputs) {
+            (0, plugin_migration_utils_1.processTargetOutputs)(target, [], inferredTargetConfiguration, {
+                projectName: projectDetails.projectName,
+                projectRoot: projectDetails.root,
+            });
+        }
+        return target;
+    };
+}

package/src/generators/convert-to-inferred/lib/process-build-options.d.ts

@@ -0,0 +1,3 @@
+import { type TargetConfiguration, type Tree } from '@nx/devkit';
+import type { AggregatedLog } from '@nx/devkit/src/generators/plugin-migrations/aggregate-log-util';
+export declare function processBuildOptions(_tree: Tree, options: any, projectName: string, _projectRoot: string, target: TargetConfiguration | undefined, _migrationLogs: AggregatedLog): void;

package/src/generators/convert-to-inferred/lib/process-build-options.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processBuildOptions = processBuildOptions;
+const devkit_1 = require("@nx/devkit");
+function processBuildOptions(_tree, options, projectName, _projectRoot, target, _migrationLogs) {
+    const args = [];
+    if ('detoxConfiguration' in options) {
+        // Need to wrap in --args since --configuration/-c is swallowed by Nx CLI.
+        args.push(`--args="-c ${options.detoxConfiguration}"`);
+        delete options.detoxConfiguration;
+    }
+    for (const key of Object.keys(options)) {
+        let value = options[key];
+        if (typeof value === 'boolean') {
+            if (value)
+                args.push(`--${(0, devkit_1.names)(key).fileName}`);
+        }
+        else {
+            args.push(`--${(0, devkit_1.names)(key).fileName}`, value);
+        }
+        delete options[key];
+    }
+    if (target) {
+        target.command = `nx run ${projectName}:build`;
+    }
+    options.args = args;
+}

package/src/generators/convert-to-inferred/lib/process-test-options.d.ts

@@ -0,0 +1,3 @@
+import { type TargetConfiguration, type Tree } from '@nx/devkit';
+import type { AggregatedLog } from '@nx/devkit/src/generators/plugin-migrations/aggregate-log-util';
+export declare function processTestOptions(_tree: Tree, options: any, projectName: string, _projectRoot: string, target: TargetConfiguration | undefined, migrationLogs: AggregatedLog): void;

package/src/generators/convert-to-inferred/lib/process-test-options.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processTestOptions = processTestOptions;
+const devkit_1 = require("@nx/devkit");
+function processTestOptions(_tree, options, projectName, _projectRoot, target, migrationLogs) {
+    const args = [];
+    if ('detoxConfiguration' in options) {
+        // Need to wrap in --args since --configuration/-c is swallowed by Nx CLI.
+        args.push(`--args="-c ${options.detoxConfiguration}"`);
+        delete options.detoxConfiguration;
+    }
+    if ('deviceBootArgs' in options) {
+        args.push(`--device-boot-args="${options.deviceBootArgs}"`); // the value must be specified after an equal sign (=) and inside quotes: https://wix.github.io/Detox/docs/cli/test
+        delete options.deviceBootArgs;
+    }
+    if ('appLaunchArgs' in options) {
+        args.push(`--app-launch-args="${options.appLaunchArgs}"`); // the value must be specified after an equal sign (=) and inside quotes: https://wix.github.io/Detox/docs/cli/test
+        delete options.appLaunchArgs;
+    }
+    if ('color' in options) {
+        // detox only accepts --no-color, not --color
+        if (!options.color)
+            args.push('--no-color');
+        delete options.color;
+    }
+    if ('buildTarget' in options) {
+        migrationLogs.addLog({
+            project: projectName,
+            executorName: '@nx/expo:test',
+            log: 'Unable to migrate `buildTarget` for Detox test. Use "nx run <project>:run-ios" or "nx run <project>:run-android", and pass "--reuse" option when running tests.',
+        });
+        delete options.buildTarget;
+    }
+    const deprecatedOptions = [
+        'runnerConfig',
+        'recordTimeline',
+        'workers',
+        'deviceLaunchArgs',
+    ];
+    for (const key of deprecatedOptions) {
+        if (!(key in options))
+            continue;
+        migrationLogs.addLog({
+            project: projectName,
+            executorName: '@nx/expo:test',
+            log: `Option "${key}" is not migrated since it was removed in Detox 20.`,
+        });
+        delete options[key];
+    }
+    for (const key of Object.keys(options)) {
+        let value = options[key];
+        if (typeof value === 'boolean') {
+            if (value)
+                args.push(`--${(0, devkit_1.names)(key).fileName}`);
+        }
+        else {
+            args.push(`--${(0, devkit_1.names)(key).fileName}`, value);
+        }
+        delete options[key];
+    }
+    if (target) {
+        target.command = `nx run ${projectName}:test`;
+    }
+    options.args = args;
+}

package/src/generators/convert-to-inferred/schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "NxDetoxConvertToInferred",
+  "description": "Convert existing Detox project(s) using `@nx/detox:*` executors to use `@nx/detox/plugin`. Defaults to migrating all projects. Pass '--project' to migrate only one target.",
+  "title": "Convert Detox project from executor to plugin",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The project to convert from using the `@nx/detox:*` executors to use `@nx/detox/plugin`.",
+      "x-priority": "important"
+    },
+    "skipFormat": {
+      "type": "boolean",
+      "description": "Whether to format files at the end of the migration.",
+      "default": false
+    }
+  }
+}