@nx/detox 17.0.3 → 17.0.4

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2023 Narwhal Technologies Inc.
+Copyright (c) 2017-2024 Narwhal Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -1,4 +1,9 @@
-<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx.png" width="600" alt="Nx - Smart, Fast and Extensible Build System"></p>
+<p style="text-align: center;">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
+    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+  </picture>
+</p>
 
 <div style="text-align: center;">
 
@@ -15,9 +20,9 @@
 
 <hr>
 
-# Nx: Smart, Fast and Extensible Build System
+# Nx: Smart Monorepos · Fast CI
 
-Nx is a next generation build system with first class monorepo support and powerful integrations.
+Nx is a build system with built-in tooling and advanced CI capabilities. It helps you maintain and scale monorepos, both locally and on CI.
 
 This package is a [Detox plugin for Nx](https://nx.dev/detox/overview).
 
@@ -59,5 +64,5 @@ npx nx@latest init
 - [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
 
 <p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
-width="100%" alt="Nx - Smart, Fast and Extensible Build System"></a></p>
+width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
 

package/generators.json

@@ -4,7 +4,7 @@
   "extends": ["@nx/workspace"],
   "generators": {
     "init": {
-      "factory": "./src/generators/init/init#detoxInitGenerator",
+      "factory": "./src/generators/init/init#detoxInitGeneratorInternal",
       "schema": "./src/generators/init/schema.json",
       "description": "Initialize the `@nrwl/detox` plugin.",
       "hidden": true

package/migrations.json

@@ -99,6 +99,32 @@
           "alwaysAddToPackageJson": false
         }
       }
+    },
+    "18.0.0": {
+      "version": "18.0.0-beta.0",
+      "packages": {
+        "detox": {
+          "version": "^20.16.0",
+          "alwaysAddToPackageJson": false
+        }
+      }
+    },
+    "18.1.0": {
+      "version": "18.1.0-beta.0",
+      "packages": {
+        "detox": {
+          "version": "~20.18.1",
+          "alwaysAddToPackageJson": false
+        },
+        "@config-plugins/detox": {
+          "version": "~7.0.0",
+          "alwaysAddToPackageJson": false
+        },
+        "@testing-library/jest-dom": {
+          "version": "~6.4.2",
+          "alwaysAddToPackageJson": false
+        }
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/detox",
-  "version": "17.0.3",
+  "version": "17.0.4",
   "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": [
@@ -25,13 +25,13 @@
   "main": "./index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "@nx/devkit": "17.0.3",
-    "@nx/jest": "17.0.3",
-    "@nx/js": "17.0.3",
-    "@nx/eslint": "17.0.3",
-    "@nx/react": "17.0.3",
+    "@nx/devkit": "17.0.4",
+    "@nx/jest": "17.0.4",
+    "@nx/js": "17.0.4",
+    "@nx/eslint": "17.0.4",
+    "@nx/react": "17.0.4",
     "tslib": "^2.3.0",
-    "@nrwl/detox": "17.0.3"
+    "@nrwl/detox": "17.0.4"
   },
   "peerDependencies": {
     "detox": "^20.9.0"

package/plugin.d.ts

@@ -0,0 +1 @@
+export { createNodes, createDependencies, DetoxPluginOptions, } from './src/plugins/plugin';

package/plugin.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDependencies = exports.createNodes = void 0;
+var plugin_1 = require("./src/plugins/plugin");
+Object.defineProperty(exports, "createNodes", { enumerable: true, get: function () { return plugin_1.createNodes; } });
+Object.defineProperty(exports, "createDependencies", { enumerable: true, get: function () { return plugin_1.createDependencies; } });

package/src/generators/application/application.js

@@ -8,8 +8,10 @@ const add_linting_1 = require("./lib/add-linting");
 const add_project_1 = require("./lib/add-project");
 const create_files_1 = require("./lib/create-files");
 const normalize_options_1 = require("./lib/normalize-options");
+const ensure_dependencies_1 = require("./lib/ensure-dependencies");
 async function detoxApplicationGenerator(host, schema) {
     return await detoxApplicationGeneratorInternal(host, {
+        addPlugin: false,
         projectNameAndRootFormat: 'derived',
         ...schema,
     });
@@ -25,10 +27,11 @@ async function detoxApplicationGeneratorInternal(host, schema) {
     (0, add_project_1.addProject)(host, options);
     (0, add_git_ignore_entry_1.addGitIgnoreEntry)(host, options);
     const lintingTask = await (0, add_linting_1.addLinting)(host, options);
+    const depsTask = (0, ensure_dependencies_1.ensureDependencies)(host, options);
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(host);
     }
-    return (0, devkit_1.runTasksInSerial)(initTask, lintingTask);
+    return (0, devkit_1.runTasksInSerial)(initTask, lintingTask, depsTask);
 }
 exports.detoxApplicationGeneratorInternal = detoxApplicationGeneratorInternal;
 exports.default = detoxApplicationGenerator;

package/src/generators/application/lib/add-linting.js

@@ -15,8 +15,8 @@ async function addLinting(host, options) {
         tsConfigPaths: [
             (0, devkit_1.joinPathFragments)(options.e2eProjectRoot, 'tsconfig.app.json'),
         ],
-        eslintFilePatterns: [`${options.e2eProjectRoot}/**/*.{ts,tsx,js,jsx}`],
         skipFormat: true,
+        addPlugin: options.addPlugin,
     });
     if ((0, eslint_file_1.isEslintConfigSupported)(host)) {
         (0, eslint_file_1.addExtendsToLintConfig)(host, options.e2eProjectRoot, 'plugin:@nx/react');

package/src/generators/application/lib/add-project.js

@@ -4,11 +4,15 @@ exports.addProject = void 0;
 const devkit_1 = require("@nx/devkit");
 const get_targets_1 = require("./get-targets");
 function addProject(host, options) {
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    const hasPlugin = nxJson.plugins?.some((p) => typeof p === 'string'
+        ? p === '@nx/detox/plugin'
+        : p.plugin === '@nx/detox/plugin');
     (0, devkit_1.addProjectConfiguration)(host, options.e2eProjectName, {
         root: options.e2eProjectRoot,
         sourceRoot: `${options.e2eProjectRoot}/src`,
         projectType: 'application',
-        targets: { ...getTargets(options) },
+        targets: hasPlugin ? {} : getTargets(options),
         tags: [],
         implicitDependencies: [options.appProject],
     });

package/src/generators/application/lib/ensure-dependencies.d.ts

@@ -0,0 +1,3 @@
+import { type Tree } from '@nx/devkit';
+import type { NormalizedSchema } from './normalize-options';
+export declare function ensureDependencies(tree: Tree, options: NormalizedSchema): import("@nx/devkit").GeneratorCallback;

package/src/generators/application/lib/ensure-dependencies.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureDependencies = void 0;
+const devkit_1 = require("@nx/devkit");
+const versions_1 = require("@nx/jest/src/utils/versions");
+const versions_2 = require("../../../utils/versions");
+function ensureDependencies(tree, options) {
+    const devDependencies = {
+        '@testing-library/jest-dom': versions_2.testingLibraryJestDom,
+        '@types/node': versions_1.typesNodeVersion,
+        'jest-circus': versions_1.jestVersion,
+    };
+    if (options.framework === 'expo') {
+        devDependencies['@config-plugins/detox'] = versions_2.configPluginsDetoxVersion;
+    }
+    return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, devDependencies);
+}
+exports.ensureDependencies = ensureDependencies;

package/src/generators/application/lib/normalize-options.js

@@ -11,6 +11,10 @@ async function normalizeOptions(host, options) {
         projectNameAndRootFormat: options.projectNameAndRootFormat,
         callingGenerator: '@nx/detox:application',
     });
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    const addPlugin = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    options.addPlugin ??= addPlugin;
     const { fileName: appFileName, className: appClassName } = (0, devkit_1.names)(options.appName || options.appProject);
     const { root: appRoot } = (0, devkit_1.readProjectConfiguration)(host, (0, devkit_1.names)(options.appProject).fileName);
     return {

package/src/generators/application/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/schema",
+  "$schema": "https://json-schema.org/schema",
   "title": "Create Detox Configuration for the workspace",
   "description": "Create Detox Configuration for the workspace.",
   "type": "object",

package/src/generators/init/init.d.ts

@@ -1,5 +1,6 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
 import { Schema } from './schema';
 export declare function detoxInitGenerator(host: Tree, schema: Schema): Promise<GeneratorCallback>;
+export declare function detoxInitGeneratorInternal(host: Tree, schema: Schema): Promise<GeneratorCallback>;
 export declare function updateDependencies(host: Tree, schema: Schema): GeneratorCallback;
 export default detoxInitGenerator;

package/src/generators/init/init.js

@@ -1,35 +1,64 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateDependencies = exports.detoxInitGenerator = void 0;
+exports.updateDependencies = exports.detoxInitGeneratorInternal = exports.detoxInitGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
-const versions_1 = require("@nx/jest/src/utils/versions");
-const versions_2 = require("../../utils/versions");
-async function detoxInitGenerator(host, schema) {
+const update_package_scripts_1 = require("@nx/devkit/src/utils/update-package-scripts");
+const plugin_1 = require("../../plugins/plugin");
+const versions_1 = require("../../utils/versions");
+function detoxInitGenerator(host, schema) {
+    return detoxInitGeneratorInternal(host, { addPlugin: false, ...schema });
+}
+exports.detoxInitGenerator = detoxInitGenerator;
+async function detoxInitGeneratorInternal(host, schema) {
     const tasks = [];
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    schema.addPlugin ??= addPluginDefault;
     if (!schema.skipPackageJson) {
         tasks.push(moveDependency(host));
         tasks.push(updateDependencies(host, schema));
     }
+    if (schema.addPlugin) {
+        addPlugin(host);
+    }
+    if (schema.updatePackageScripts) {
+        await (0, update_package_scripts_1.updatePackageScripts)(host, plugin_1.createNodes);
+    }
     if (!schema.skipFormat) {
         await (0, devkit_1.formatFiles)(host);
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
-exports.detoxInitGenerator = detoxInitGenerator;
+exports.detoxInitGeneratorInternal = detoxInitGeneratorInternal;
 function updateDependencies(host, schema) {
     return (0, devkit_1.addDependenciesToPackageJson)(host, {}, {
-        '@nx/detox': versions_2.nxVersion,
-        detox: versions_2.detoxVersion,
-        '@testing-library/jest-dom': versions_2.testingLibraryJestDom,
-        '@types/node': versions_1.typesNodeVersion,
-        'jest-circus': versions_1.jestVersion,
-        ...(schema.framework === 'expo'
-            ? { '@config-plugins/detox': versions_2.configPluginsDetoxVersion }
-            : {}),
-    });
+        '@nx/detox': versions_1.nxVersion,
+        detox: versions_1.detoxVersion,
+    }, undefined, schema.keepExistingVersions);
 }
 exports.updateDependencies = updateDependencies;
 function moveDependency(host) {
     return (0, devkit_1.removeDependenciesFromPackageJson)(host, ['@nx/detox'], []);
 }
+function addPlugin(host) {
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    nxJson.plugins ??= [];
+    for (const plugin of nxJson.plugins) {
+        if (typeof plugin === 'string'
+            ? plugin === '@nx/detox/plugin'
+            : plugin.plugin === '@nx/detox/plugin') {
+            return;
+        }
+    }
+    nxJson.plugins.push({
+        plugin: '@nx/detox/plugin',
+        options: {
+            buildTargetName: 'build',
+            startTargetName: 'start',
+            testTargetName: 'test',
+        },
+    });
+    (0, devkit_1.updateNxJson)(host, nxJson);
+}
 exports.default = detoxInitGenerator;

package/src/generators/init/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/schema",
+  "$schema": "https://json-schema.org/schema",
   "title": "Add Detox Schematics",
   "description": "Add Detox Schematics.",
   "type": "object",
@@ -16,11 +16,17 @@
       "description": "Do not add dependencies to `package.json`.",
       "x-priority": "internal"
     },
-    "framework": {
-      "type": "string",
-      "description": "App framework to test",
-      "enum": ["react-native", "expo"],
-      "default": "react-native"
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
+    },
+    "updatePackageScripts": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Update `package.json` scripts with inferred targets",
+      "default": false
     }
   },
   "required": []

package/src/plugins/plugin.d.ts

@@ -0,0 +1,8 @@
+import { CreateDependencies, CreateNodes } from '@nx/devkit';
+export interface DetoxPluginOptions {
+    buildTargetName?: string;
+    startTargetName?: string;
+    testTargetName?: string;
+}
+export declare const createDependencies: CreateDependencies;
+export declare const createNodes: CreateNodes<DetoxPluginOptions>;

package/src/plugins/plugin.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodes = exports.createDependencies = void 0;
+const devkit_1 = require("@nx/devkit");
+const path_1 = require("path");
+const js_1 = require("@nx/js");
+const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
+const fs_1 = require("fs");
+const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
+const cache_directory_1 = require("nx/src/utils/cache-directory");
+const cachePath = (0, path_1.join)(cache_directory_1.projectGraphCacheDirectory, 'detox.hash');
+const targetsCache = (0, fs_1.existsSync)(cachePath) ? readTargetsCache() : {};
+const calculatedTargets = {};
+function readTargetsCache() {
+    return (0, devkit_1.readJsonFile)(cachePath);
+}
+function writeTargetsToCache(targets) {
+    (0, devkit_1.writeJsonFile)(cachePath, targets);
+}
+const createDependencies = () => {
+    writeTargetsToCache(calculatedTargets);
+    return [];
+};
+exports.createDependencies = createDependencies;
+exports.createNodes = [
+    '**/{detox.config,.detoxrc}.{json,js}',
+    (configFilePath, options, context) => {
+        options = normalizeOptions(options);
+        const projectRoot = (0, path_1.dirname)(configFilePath);
+        // Do not create a project if project.json isn't there.
+        const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
+        if (!siblingFiles.includes('project.json')) {
+            return {};
+        }
+        const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [
+            (0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot)),
+        ]);
+        const targets = targetsCache[hash]
+            ? targetsCache[hash]
+            : buildDetoxTargets(projectRoot, options, context);
+        calculatedTargets[hash] = targets;
+        return {
+            projects: {
+                [projectRoot]: {
+                    targets,
+                },
+            },
+        };
+    },
+];
+function buildDetoxTargets(projectRoot, options, context) {
+    const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
+    const targets = {
+        [options.buildTargetName]: {
+            command: `detox build`,
+            options: { cwd: projectRoot },
+            cache: true,
+            inputs: getInputs(namedInputs),
+        },
+        [options.startTargetName]: {
+            command: `detox start`,
+            options: { cwd: projectRoot },
+        },
+        [options.testTargetName]: {
+            command: `detox test`,
+            options: { cwd: projectRoot },
+            cache: true,
+            inputs: getInputs(namedInputs),
+        },
+    };
+    return targets;
+}
+function getInputs(namedInputs) {
+    return [
+        ...('production' in namedInputs
+            ? ['default', '^production']
+            : ['default', '^default']),
+        {
+            externalDependencies: ['detox'],
+        },
+    ];
+}
+function normalizeOptions(options) {
+    options ??= {};
+    options.buildTargetName ??= 'build';
+    options.startTargetName ??= 'start';
+    options.testTargetName ??= 'test';
+    return options;
+}

package/src/utils/versions.d.ts

@@ -1,4 +1,4 @@
 export declare const nxVersion: any;
-export declare const detoxVersion = "^20.11.1";
-export declare const testingLibraryJestDom = "5.16.5";
-export declare const configPluginsDetoxVersion = "~6.0.0";
+export declare const detoxVersion = "~20.18.1";
+export declare const testingLibraryJestDom = "~6.4.2";
+export declare const configPluginsDetoxVersion = "~7.0.0";

package/src/utils/versions.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configPluginsDetoxVersion = exports.testingLibraryJestDom = exports.detoxVersion = exports.nxVersion = void 0;
 exports.nxVersion = require('../../package.json').version;
-exports.detoxVersion = '^20.11.1';
-exports.testingLibraryJestDom = '5.16.5';
-exports.configPluginsDetoxVersion = '~6.0.0'; // only required for expo
+exports.detoxVersion = '~20.18.1';
+exports.testingLibraryJestDom = '~6.4.2';
+exports.configPluginsDetoxVersion = '~7.0.0'; // only required for expo