feat(rules): add 'missing-wait-message' rule

README.md

@@ -33,7 +33,7 @@ This plugin ships with a default configuration for each rule:
 Rule                         | Default       | Options
 ----                         | -------       | -------
 [missing-perform][]          | 2             |
-
+[missing-wait-message][]     | 1             |
 
 For example, the `missing-perform` rule is enabled by default and will cause
 ESLint to throw an error (with an exit code of `1`) when triggered.
@@ -51,6 +51,7 @@ rules:
 See [configuring rules][] for more information.
 
 [missing-perform]: docs/rules/missing-perform.md
+[missing-wait-message]: docs/rules/missing-wait-message.md
 [configuring rules]: http://eslint.org/docs/user-guide/configuring#configuring-rules
 
 ## Author

docs/rules/missing-wait-message.md

@@ -0,0 +1,22 @@
+# Missing wait timeout message in `browser.wait()` (missing-wait-message)
+
+Ensure the timeout message is set when `browser.wait()` is called.
+
+## Rule details
+
+This rule triggers a warning if there is no message in case `browser.wait()` timeouts. 
+Having explicit timeout messages helps in debugging and troubleshooting the test failures.
+
+The following patterns are considered warnings:
+
+```js
+browser.wait(EC.presenceOf(elm), 5000);
+browser.wait(EC.visibilityOf(elm), 5000);
+```
+
+The following patterns are not warnings:
+
+```js
+browser.wait(EC.presenceOf(elm), 5000, "The user menu is not present");
+browser.wait(EC.elementToBeClickable(elm), 5000, "The submit button has not become clickable. Watch for the modal popup not to be opened.");
+```

index.js

@@ -5,6 +5,7 @@ module.exports = {
     'missing-perform': require('./lib/rules/missing-perform')
   },
   rulesConfig: {
-    'missing-perform': 2
+    'missing-perform': 2,
+    'missing-wait-message': 1
   }
 }

lib/rules/missing-wait-message.js

@@ -0,0 +1,19 @@
+'use strict'
+
+/**
+ * @fileoverview Missing wait timeout message in browser.wait() (missing-wait-message)
+ * @author Alexander Afanasyev
+ */
+
+module.exports = function (context) {
+  return {
+    'CallExpression': function (node) {
+      var objectName = node.callee.object.name
+      var propertyName = node.callee.property.name
+
+      if (propertyName === 'wait' && objectName === 'browser' && node.arguments.length < 3) {
+        context.report(node, 'No timeout message provided for browser.wait()')
+      }
+    }
+  }
+}

test/rules/missing-wait-message.js

@@ -0,0 +1,32 @@
+'use strict'
+
+var rule = require('../../lib/rules/missing-wait-message')
+var RuleTester = require('eslint').RuleTester
+
+var eslintTester = new RuleTester()
+
+eslintTester.run('missing-wait-message', rule, {
+  valid: [
+    'browser.wait(EC.presenceOf(elm), 5000, \'The user menu is not present\');',
+    'browser.wait(EC.elementToBeClickable(elm), 5000, \'The submit button has not become clickable. Watch for the modal popup not to be opened\');'
+  ],
+
+  invalid: [
+    {
+      code: 'browser.wait(EC.presenceOf(elm), 5000);',
+      errors: [
+        {
+          message: 'No timeout message provided for browser.wait()'
+        }
+      ]
+    },
+    {
+      code: 'browser.wait(EC.visibilityOf(elm), 5000);',
+      errors: [
+        {
+          message: 'No timeout message provided for browser.wait()'
+        }
+      ]
+    }
+  ]
+})