feat(config): skipLegacyWorkersInjection

[noomorph]

Description

• This pull request addresses the issue described here: Ability to NOT pass --maxWorkers to Jest #2862.

In this pull request, I have added skipLegacyWorkersInjection: boolean to Detox.DetoxConfig, so that detox test command avoids the permanent passthrough of --workers 1 to Jest by default. For the opposite case, when a user specifies a custom workers number via -w, --workers <count> CLI option, the previous behavior remains the same.

 {
   testRunner: 'nyc jest',
   runnerConfig: 'e2e/config.js',
+  skipLegacyWorkersInjection: true,

From now on, the default Jest config file generated by detox init -r jest contains maxWorkers: 1 to prevent an unintended overallocation of devices if there are multiple test files — an average personal computer is likely to have a problem with more than 3-4 simulators/emulators running at once, therefore we add a safeguard mechanism this way.

 {
+    "maxWorkers": 1,
     "testEnvironment": "./environment",
     "testRunner": "jest-circus/runner",
     "testTimeout": 120000,
     "testRegex": "\\\\.e2e\\\\.js$",
     "reporters": ["detox/runners/jest/streamlineReporter"],
     "verbose": true
 }

The temporary flag, skipLegacyWorkersInjection is intended to be removed in the next Detox major release in favor of the new behavior added with this pull request.

For features/enhancements:

• I have added/updated the relevant references in the documentation files.

For API changes:

• I have made the necessary changes in the types index file.