lint: stricter rules (#2798)

detox/.eslintignore

@@ -0,0 +1 @@
+src/android/espressoapi/**/*.js

detox/.eslintrc

@@ -1,24 +1,77 @@
 {
   "env": {
-    "node": true,
-    "jest": true
+    "jest": true,
+    "node": true
   },
-  "plugins": ["node"],
-  "extends": ["plugin:node/recommended"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:import/recommended",
+    "plugin:node/recommended"
+  ],
   "globals": {
-    "fail": true,
+    "fail": true
   },
   "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module",
     "ecmaFeatures": {
       "experimentalObjectRestSpread": true
-    }
+    },
+    "ecmaVersion": 2018,
+    "sourceType": "module"
   },
+  "plugins": [
+    "import",
+    "node",
+    "no-only-tests"
+  ],
   "rules": {
+    "array-bracket-spacing": [
+      "error",
+      "never"
+    ],
+    "computed-property-spacing": [
+      "error",
+      "never"
+    ],
+    "import/order": [
+      "error",
+      {
+        "alphabetize": {
+          "order": "asc"
+        },
+        "newlines-between": "always"
+      }
+    ],
+    "no-case-declarations": "off",
     "no-debugger": "error",
-    "no-undef": "warn",
+    "no-empty": "off",
     "no-mixed-spaces-and-tabs": "error",
-    "node/no-unpublished-require": "warn"
+    "no-multiple-empty-lines": [
+      "error",
+      {
+        "max": 2,
+        "maxBOF": 1
+      }
+    ],
+    "no-only-tests/no-only-tests": "error",
+    "no-undef": "warn",
+    "no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "node/no-unpublished-require": "warn",
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "semi": [
+      "error",
+      "always"
+    ],
+    "quotes": ["error", "single", {
+      "avoidEscape": true,
+      "allowTemplateLiterals": true
+    }]
   }
 }

detox/.nvmrc

@@ -1 +1 @@
-8
+12.22.1

detox/package.json

@@ -33,6 +33,8 @@
     "@types/child-process-promise": "^2.2.1",
     "@types/ws": "^7.4.0",
     "eslint": "^4.11.0",
+    "eslint-plugin-import": "^2.23.3",
+    "eslint-plugin-no-only-tests": "^2.6.0",
     "eslint-plugin-node": "^6.0.1",
     "jest": "^26.5.0",
     "jest-circus": "^26.5.2",

detox/runners/jest-circus/environment.js

@@ -1,12 +1,14 @@
-const _ = require('lodash');
 const NodeEnvironment = require('jest-environment-node');
+const _ = require('lodash');
+
+const DetoxError = require('../../src/errors/DetoxError');
+const Timer = require('../../src/utils/Timer');
+
 const DetoxCoreListener = require('./listeners/DetoxCoreListener');
 const DetoxInitErrorListener = require('./listeners/DetoxInitErrorListener');
-const assertJestCircus26 = require('./utils/assertJestCircus26');
 const assertExistingContext = require('./utils/assertExistingContext');
+const assertJestCircus26 = require('./utils/assertJestCircus26');
 const wrapErrorWithNoopLifecycle = require('./utils/wrapErrorWithNoopLifecycle');
-const DetoxError = require('../../src/errors/DetoxError');
-const Timer = require('../../src/utils/Timer');
 
 const SYNC_CIRCUS_EVENTS = new Set([
   'start_describe_definition',

detox/runners/jest-circus/index.js

@@ -1,6 +1,7 @@
-const DetoxCircusEnvironment = require('./environment');
-const WorkerAssignReporterCircus = require('../jest/WorkerAssignReporterCircus');
 const SpecReporterCircus = require('../jest/SpecReporterCircus');
+const WorkerAssignReporterCircus = require('../jest/WorkerAssignReporterCircus');
+
+const DetoxCircusEnvironment = require('./environment');
 
 module.exports = {
   DetoxCircusEnvironment,

detox/runners/jest-circus/listeners/DetoxCoreListener.js

@@ -1,5 +1,6 @@
+const { RETRY_TIMES } = require('jest-circus/build/types');
 const _ = require('lodash');
-const {getFullTestName, hasTimedOut} = require('../../jest/utils');
+
 const {
   onRunDescribeStart,
   onTestStart,
@@ -8,7 +9,7 @@ const {
   onTestDone,
   onRunDescribeFinish,
 } = require('../../integration').lifecycle;
-const { RETRY_TIMES } = require('jest-circus/build/types');
+const { getFullTestName, hasTimedOut } = require('../../jest/utils');
 
 class DetoxCoreListener {
   constructor({ detox, env }) {
@@ -20,7 +21,7 @@ class DetoxCoreListener {
   }
 
   _getTestInvocations(test) {
-    const {DETOX_RERUN_INDEX} = process.env;
+    const { DETOX_RERUN_INDEX } = process.env;
 
     if (!isNaN(DETOX_RERUN_INDEX)) {
       return Number(DETOX_RERUN_INDEX) * this._testRunTimes + test.invocations;
@@ -29,13 +30,13 @@ class DetoxCoreListener {
     }
   }
 
-  async run_describe_start({describeBlock: {name, children}}) {
+  async run_describe_start({ describeBlock: { name, children } }) {
     if (children.length) {
       await this.detox[onRunDescribeStart]({ name });
     }
   }
 
-  async run_describe_finish({describeBlock: {name, children}}) {
+  async run_describe_finish({ describeBlock: { name, children } }) {
     if (children.length) {
       await this.detox[onRunDescribeFinish]({ name });
     }

detox/runners/jest-circus/utils/assertExistingContext.js

@@ -1,5 +1,5 @@
-const { filterErrorStack } = require('../../../src/utils/errorUtils');
 const { DetoxRuntimeError } = require('../../../src/errors/DetoxRuntimeError');
+const { filterErrorStack } = require('../../../src/utils/errorUtils');
 
 function findUserConstructor() {
   let wasInBaseClass = false;

detox/runners/jest-circus/utils/assertJestCircus26.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+
 const DetoxRuntimeError = require('../../../src/errors/DetoxRuntimeError');
 
 function assertJestCircus26(config) {

detox/runners/jest-circus/utils/wrapErrorWithNoopLifecycle.js

@@ -1,4 +1,5 @@
 const _ = require('lodash');
+
 const lifecycleSymbols = require('../../integration').lifecycle;
 
 function wrapErrorWithNoopLifecycle(error) {

detox/runners/jest/DetoxAdapterCircus.js

@@ -1,4 +1,5 @@
 const _ = require('lodash');
+
 const DetoxAdapter = require('./DetoxAdapterImpl');
 const { getFullTestName, hasTimedOut } = require('./utils');
 
@@ -24,12 +25,12 @@ class DetoxAdapterCircus {
     await this._adapter.afterAll();
   }
 
-  async run_describe_start({describeBlock: {name, children}}, state) {
-    if (children.length) await this._adapter.suiteStart({name});
+  async run_describe_start({ describeBlock: { name, children } }, state) {
+    if (children.length) await this._adapter.suiteStart({ name });
   }
 
-  async run_describe_finish({describeBlock: {name, children}}, state) {
-    if (children.length) await this._adapter.suiteEnd({name});
+  async run_describe_finish({ describeBlock: { name, children } }, state) {
+    if (children.length) await this._adapter.suiteEnd({ name });
   }
 
   test_start(event) {

detox/runners/jest/DetoxAdapterImpl.js

@@ -32,23 +32,23 @@ class DetoxAdapterImpl {
     await this._flush();
   }
 
-  async suiteStart({name}) {
-    this._enqueue(() => this.detox.suiteStart({name}));
+  async suiteStart({ name }) {
+    this._enqueue(() => this.detox.suiteStart({ name }));
   }
 
-  async suiteEnd({name}) {
-    this._enqueue(() => this.detox.suiteEnd({name}));
+  async suiteEnd({ name }) {
+    this._enqueue(() => this.detox.suiteEnd({ name }));
   }
 
-  testStart({title, fullName, status}) {
+  testStart({ title, fullName, status }) {
     this._currentTest = {
       title,
       fullName,
       status,
     };
   }
 
-  testComplete({status, timedOut}) {
+  testComplete({ status, timedOut }) {
     if (this._currentTest) {
       const _test = {
         ...this._currentTest,

detox/runners/jest/DetoxAdapterJasmine.js

@@ -1,4 +1,5 @@
 const _ = require('lodash');
+
 const DetoxAdapter = require('./DetoxAdapterImpl');
 
 class DetoxAdapterJasmine /* extends JasmineReporter */ {
@@ -24,11 +25,11 @@ class DetoxAdapterJasmine /* extends JasmineReporter */ {
   }
 
   async suiteStarted(result) {
-    await this._adapter.suiteStart({name: result.description});
+    await this._adapter.suiteStart({ name: result.description });
   }
 
   async suiteDone(result) {
-    await this._adapter.suiteEnd({name: result.description});
+    await this._adapter.suiteEnd({ name: result.description });
   }
 
   specStarted(result) {

detox/runners/jest/DetoxStreamlineJestReporter.js

@@ -1,4 +1,5 @@
-const {VerboseReporter: JestVerboseReporter} = require('@jest/reporters'); // eslint-disable-line node/no-extraneous-require
+const { VerboseReporter: JestVerboseReporter } = require('@jest/reporters'); // eslint-disable-line node/no-extraneous-require
+
 const DetoxRuntimeError = require('../../src/errors/DetoxRuntimeError');
 
 class DetoxStreamlineJestReporter extends JestVerboseReporter {

detox/runners/jest/FailingTestsReporter.js

@@ -1,4 +1,5 @@
 const path = require('path');
+
 const { saveLastFailedTests } = require('../../src/utils/lastFailedTests');
 
 class FailingTestsReporter {

detox/runners/jest/SpecReporterCircus.js

@@ -1,4 +1,5 @@
 const argparse = require('../../src/utils/argparse');
+
 const SpecReporter = require('./SpecReporterImpl');
 
 class SpecReporterCircus {

detox/runners/jest/SpecReporterImpl.js

@@ -1,7 +1,9 @@
 const chalk = require('chalk').default;
-const { traceln } = require('./utils/stdout');
+
 const log = require('../../src/utils/logger').child();
 
+const { traceln } = require('./utils/stdout');
+
 const RESULT_SKIPPED = chalk.yellow('SKIPPED');
 const RESULT_FAILED = chalk.red('FAIL');
 const RESULT_PENDING = chalk.yellow('PENDING');
@@ -14,8 +16,8 @@ class SpecReporter {
     this._suitesDesc = '';
   }
 
-  onSuiteStart({description}) {
-    this._suites.push({description});
+  onSuiteStart({ description }) {
+    this._suites.push({ description });
     this._regenerateSuitesDesc();
   }
 
@@ -28,11 +30,11 @@ class SpecReporter {
     }
   }
 
-  onTestStart({description, invocations = 1}) {
-    this._traceTest({description, invocations});
+  onTestStart({ description, invocations = 1 }) {
+    this._traceTest({ description, invocations });
   }
 
-  onTestEnd({description, invocations = 1}, result) {
+  onTestEnd({ description, invocations = 1 }, result) {
     let status;
     switch (result) {
       case 'skipped': status = RESULT_SKIPPED; break;
@@ -41,7 +43,7 @@ class SpecReporter {
       case 'success': status = RESULT_SUCCESS; break;
       default: status = RESULT_OTHER; break;
     }
-    this._traceTest({description, invocations}, status);
+    this._traceTest({ description, invocations }, status);
   }
 
   _regenerateSuitesDesc() {
@@ -57,12 +59,12 @@ class SpecReporter {
     this._suitesDesc = chalk.bold.white(this._suitesDesc);
   }
 
-  _traceTest({description, invocations}, _status = undefined) {
+  _traceTest({ description, invocations }, _status = undefined) {
     const testDescription = chalk.gray(description);
     const retriesDescription = (invocations > 1) ? chalk.gray(` [Retry #${invocations - 1}]`) : '';
     const status = chalk.gray(_status ? ` [${_status}]` : '');
     const desc = this._suitesDesc + testDescription + retriesDescription + status;
-    log.info({event: 'SPEC_STATE_CHANGE'}, desc);
+    log.info({ event: 'SPEC_STATE_CHANGE' }, desc);
   }
 }
 

detox/runners/jest/WorkerAssignReporterImpl.js

@@ -1,5 +1,6 @@
-const _ = require('lodash');
 const chalk = require('chalk').default;
+const _ = require('lodash');
+
 const log = require('../../src/utils/logger').child();
 
 class WorkerAssignReporterImpl {
@@ -13,7 +14,7 @@ class WorkerAssignReporterImpl {
       ? chalk.redBright('undefined')
       : chalk.blueBright(deviceName);
 
-    log.info({event: 'WORKER_ASSIGN'}, `${chalk.whiteBright(workerName)} is assigned to ${formattedDeviceName}`);
+    log.info({ event: 'WORKER_ASSIGN' }, `${chalk.whiteBright(workerName)} is assigned to ${formattedDeviceName}`);
   }
 }
 

detox/runners/jest/WorkerAssignReporterJasmine.js

@@ -1,4 +1,5 @@
 const path = require('path');
+
 const WorkerAssignReporter = require('./WorkerAssignReporterImpl');
 
 class WorkerAssignReporterJasmine {

detox/runners/jest/adapter.js

@@ -1,5 +1,6 @@
-const runnerInfo = require('./runnerInfo');
 const detox = require('../../src/index');
+
+const runnerInfo = require('./runnerInfo');
 const DetoxAdapter = runnerInfo.isJestCircus ? require('./DetoxAdapterCircus') : require('./DetoxAdapterJasmine');
 
 module.exports = new DetoxAdapter(detox);

detox/runners/jest/assignReporter.js

@@ -1,4 +1,5 @@
 const detox = require('../../src/index');
+
 const runnerInfo = require('./runnerInfo');
 
 const Reporter = runnerInfo.isJestCircus ? require('./WorkerAssignReporterCircus') : require('./WorkerAssignReporterJasmine');

detox/runners/jest/specReporter.js

@@ -1,4 +1,5 @@
 const argparse = require('../../src/utils/argparse');
+
 const runnerInfo = require('./runnerInfo');
 
 if (argparse.getArgValue('reportSpecs') === 'true') {

detox/runners/mocha/adapter.js

@@ -1,4 +1,5 @@
 const detox = require('../../src/index');
+
 const DetoxMochaAdapter = require('./DetoxMochaAdapter');
 
 module.exports = new DetoxMochaAdapter(detox);