eslint-plugin-detox-bcp

Contains ESLint rules that may enforce current best practices for Detox.

Installation

You'll first need to install ESLint:

1npm i eslint --save-dev

Next, install eslint-plugin-detox-bcp:

1npm install eslint-plugin-detox-bcp --save-dev

Usage

Add detox to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

1{
2    "plugins": [
3        "detox-bcp"
4    ]
5}

Then configure the rules you want to use under the rules section.

1{
2    "rules": {
3        "detox-bcp/no-unhandled-catch": "error"
4    }
5}

or just use:

1{
2    "extends": [
3        "plugin:detox-bcp/all"
4    ]
5}

Supported Rules

detox-bcp/no-unhandled-catch

Prevents situations where the test writer always treats a caught error as a failed expectation or element action:

1try {
2  await myTestDriver.tapOnNewButton();
3} catch (e) {
4  // what if `e` is a SyntaxError or anything else?
5  await myTestDriver.tapOnOldButton();
6}

The rule enforces handling of the caught errors, e.g.:

1try {
2  await myTestDriver.tapOnNewButton();
3} catch (e) {
4  if (!`${e}`.match(/^DetoxRuntimeError.*visible/)) {
5    throw e;
6  }
7
8  await myTestDriver.tapOnOldButton();
9}