diff --git a/docs/generated/api-detox/executors/test.md b/docs/generated/api-detox/executors/test.md index ffd6f347f2d91..a1555442be979 100644 --- a/docs/generated/api-detox/executors/test.md +++ b/docs/generated/api-detox/executors/test.md @@ -43,6 +43,8 @@ Target which builds the application Type: `string` +Possible values: `enabled`, `disabled` + [iOS Only] Capture \*.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls. ### cleanup @@ -63,7 +65,7 @@ Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js Alias(es): d -Type: `string` +Type: `boolean` Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete. @@ -117,6 +119,8 @@ Alias(es): l Type: `string` +Possible values: `fatal`, `error`, `warn`, `info`, `verbose`, `trace` + Log level: fatal, error, warn, info, verbose, trace ### noColor @@ -129,24 +133,32 @@ Disable colors in log output Type: `string` +Possible values: `failing`, `all`, `none` + Save logs during each test to artifacts directory. Pass "failing" to save logs of failing tests only. ### recordPerformance Type: `string` +Possible values: `all`, `none` + [iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory. ### recordTimeline Type: `string` +Possible values: `all`, `none` + [Jest Only] Record tests and events timeline, for visual display on the chrome://tracing tool. ### recordVideos Type: `string` +Possible values: `failing`, `all`, `none` + Save screen recordings of each test to artifacts directory. Pass "failing" to save recordings of failing tests only. ### retries @@ -173,6 +185,8 @@ Test runner config file, defaults to 'e2e/mocha.opts' for mocha and 'e2e/config. Type: `string` +Possible values: `manual`, `failing`, `all`, `none` + Save screenshots before and after each test to artifacts directory. Pass "failing" to save screenshots of failing tests only. ### useCustomLogger diff --git a/docs/generated/api-react-native/executors/run-ios.md b/docs/generated/api-react-native/executors/run-ios.md index b96753151dffc..ca42a972ba817 100644 --- a/docs/generated/api-react-native/executors/run-ios.md +++ b/docs/generated/api-react-native/executors/run-ios.md @@ -57,8 +57,6 @@ Explicitly set the Xcode scheme to use ### simulator -Default: `iPhone X` - Type: `string` Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: "iPhone X (12.1)" diff --git a/packages/detox/src/executors/test/schema.d.ts b/packages/detox/src/executors/test/schema.d.ts index edcf2d33ac5b7..b19704a79ad18 100644 --- a/packages/detox/src/executors/test/schema.d.ts +++ b/packages/detox/src/executors/test/schema.d.ts @@ -1,31 +1,31 @@ // options from https://github.com/wix/Detox/blob/master/docs/APIRef.DetoxCLI.md#test // detox test args: https://github.com/wix/Detox/blob/master/detox/local-cli/utils/testCommandArgs.js export interface DetoxTestOptions { - configPath: string; + configPath?: string; detoxConfiguration: string; - runnerConfig: string; - deviceName: string; - loglevel: string; - debugSynchronization: string; - artifactsLocation: string; - recordLogs: 'failing' | 'all' | 'none'; - takeScreenshots: 'manual' | 'failing' | 'all' | 'none'; - recordVideos: 'failing' | 'all' | 'none'; - recordPerformance: 'all' | 'none'; - recordTimeline: 'all' | 'none'; - captureViewHierarchy: 'enabled' | 'disabled'; - retries: number; - resuse: boolean; - cleanup: boolean; - workers: number; - jestReportSpecs: boolean; - headeless: boolean; - gpu: boolean; - deviceLauchArgs: string; - appLaunchArgs: string; - noColor: boolean; - useCutsomeLogger: boolean; - forceAdbInstall: boolean; - inspectBrk: boolean; - buildTarget: string; + runnerConfig?: string; + deviceName?: string; + loglevel?: string; + debugSynchronization?: boolean; + artifactsLocation?: string; + recordLogs?: 'failing' | 'all' | 'none'; + takeScreenshots?: 'manual' | 'failing' | 'all' | 'none'; + recordVideos?: 'failing' | 'all' | 'none'; + recordPerformance?: 'all' | 'none'; + recordTimeline?: 'all' | 'none'; + captureViewHierarchy?: 'enabled' | 'disabled'; + retries?: number; + resuse?: boolean; + cleanup?: boolean; + workers?: number; + jestReportSpecs?: boolean; + headeless?: boolean; + gpu?: boolean; + deviceLauchArgs?: string; + appLaunchArgs?: string; + noColor?: boolean; + useCutsomeLogger?: boolean; + forceAdbInstall?: boolean; + inspectBrk?: boolean; + buildTarget?: string; } diff --git a/packages/detox/src/executors/test/schema.json b/packages/detox/src/executors/test/schema.json index 16f1f95126461..3a941fa053374 100644 --- a/packages/detox/src/executors/test/schema.json +++ b/packages/detox/src/executors/test/schema.json @@ -7,7 +7,13 @@ "detoxConfiguration": { "type": "string", "description": "Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it", - "alias": "C" + "alias": "C", + "examples": [ + "ios.sim.debug", + "ios.sim.release", + "android.emu.debug", + "android.emu.release" + ] }, "buildTarget": { "type": "string", @@ -30,11 +36,12 @@ }, "loglevel": { "type": "string", + "enum": ["fatal", "error", "warn", "info", "verbose", "trace"], "description": "Log level: fatal, error, warn, info, verbose, trace", "alias": "l" }, "debugSynchronization": { - "type": "string", + "type": "boolean", "description": "Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete.", "alias": "d" }, @@ -45,26 +52,32 @@ }, "recordLogs": { "type": "string", + "enum": ["failing", "all", "none"], "description": "Save logs during each test to artifacts directory. Pass \"failing\" to save logs of failing tests only." }, "takeScreenshots": { "type": "string", + "enum": ["manual", "failing", "all", "none"], "description": "Save screenshots before and after each test to artifacts directory. Pass \"failing\" to save screenshots of failing tests only. " }, "recordVideos": { "type": "string", + "enum": ["failing", "all", "none"], "description": "Save screen recordings of each test to artifacts directory. Pass \"failing\" to save recordings of failing tests only." }, "recordPerformance": { "type": "string", + "enum": ["all", "none"], "description": "[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory." }, "recordTimeline": { "type": "string", + "enum": ["all", "none"], "description": "[Jest Only] Record tests and events timeline, for visual display on the chrome://tracing tool." }, "captureViewHierarchy": { "type": "string", + "enum": ["enabled", "disabled"], "description": "[iOS Only] Capture *.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls." }, "retries": { diff --git a/packages/react-native/src/executors/run-android/schema.json b/packages/react-native/src/executors/run-android/schema.json index 5783969ff6d30..d6150091a3ad4 100644 --- a/packages/react-native/src/executors/run-android/schema.json +++ b/packages/react-native/src/executors/run-android/schema.json @@ -9,7 +9,8 @@ "variant": { "type": "string", "description": "Specify your app's build variant (e.g. debug, release).", - "default": "debug" + "default": "debug", + "examples": ["debug", "release"] }, "appId": { "type": "string", diff --git a/packages/react-native/src/executors/run-ios/schema.json b/packages/react-native/src/executors/run-ios/schema.json index 84ea7aba439e5..0012df0460c43 100644 --- a/packages/react-native/src/executors/run-ios/schema.json +++ b/packages/react-native/src/executors/run-ios/schema.json @@ -9,7 +9,8 @@ "xcodeConfiguration": { "type": "string", "description": "Explicitly set the Xcode configuration to use", - "default": "Debug" + "default": "Debug", + "examples": ["Debug", "Release"] }, "scheme": { "type": "string", @@ -18,7 +19,7 @@ "simulator": { "type": "string", "description": "Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: \"iPhone X (12.1)\"", - "default": "iPhone X" + "examples": ["iPhone X"] }, "device": { "type": "string",