feat(rules): add 'no-get-inner-outer-html' rule

Author: alecxe

README.md

@@ -56,6 +56,7 @@ Rule                         | Default Error Level | Auto-fixable | Options
 [no-promise-in-if][]         | 1                   |              | 
 [no-execute-script][]        | 1                   |              | requires plugin "settings"
 [no-repetitive-locators][]   | 1                   |              |
+[no-get-inner-outer-html][]  | 1                   |              |
 [by-css-shortcut][]          | 0                   |              |
 
 For example, the `missing-perform` rule is enabled by default and will cause
@@ -97,6 +98,7 @@ See [configuring rules][] for more information.
 [no-execute-script]: docs/rules/no-execute-script.md
 [correct-chaining]: docs/rules/correct-chaining.md
 [no-repetitive-locators]: docs/rules/no-repetitive-locators.md
+[no-get-inner-outer-html]: docs/rules/no-get-inner-outer-html.md
 [configuring rules]: http://eslint.org/docs/user-guide/configuring#configuring-rules
 
 ## Recommended configuration

docs/rules/no-get-inner-outer-html.md

@@ -0,0 +1,27 @@
+# Warn about using `getInnerHtml()` and `getOuterHtml()` methods
+
+Selenium [has deprecated `getInnerHtml()` and `getOuterHtml()` methods in version 2.53](https://github.com/SeleniumHQ/selenium/blob/96ed95a97405fa267eea09c4008cda9e7703e84d/javascript/node/selenium-webdriver/CHANGES.md#change-summary).
+And, hence, Protractor itself _does not have these methods documented_ as a part of [public API](http://www.protractortest.org/#/api) anymore.
+
+## Rule details
+
+Any use of the following patterns are considered warnings:
+
+```js
+expect(element(by.id("myid")).getInnerHtml()).toEqual("test");
+expect(element(by.id("myid")).getOuterHtml()).toEqual("test");
+element.all(by.css(".class")).first().getOuterHtml();
+element(by.id("id")).all(by.css(".class")).last().getInnerHtml();
+$$(".class").first().getOuterHtml();
+$(".class").getInnerHtml().then(function (html) { console.log(html) });
+```
+
+The following patterns are not warnings:
+
+```js
+expect(element(by.id("myid")).getText()).toEqual("test");
+getInnerHtml();
+var html = getOuterHtml();
+elm.getInnerHTML();
+elm.getOuterHTML();
+```

index.js

@@ -21,6 +21,7 @@ var noPromiseInIf = require('./lib/rules/no-promise-in-if')
 var noExecuteScript = require('./lib/rules/no-execute-script')
 var correctChaining = require('./lib/rules/correct-chaining')
 var noRepetitiveLocators = require('./lib/rules/no-repetitive-locators')
+var noGetInnerOuterHtml = require('./lib/rules/no-get-inner-outer-html')
 
 module.exports = {
   rules: {
@@ -44,7 +45,8 @@ module.exports = {
     'no-promise-in-if': noPromiseInIf,
     'no-execute-script': noExecuteScript,
     'no-repetitive-locators': noRepetitiveLocators,
-    'correct-chaining': correctChaining
+    'correct-chaining': correctChaining,
+    'no-get-inner-outer-html': noGetInnerOuterHtml
   },
   configs: {
     recommended: {
@@ -69,6 +71,7 @@ module.exports = {
         'protractor/no-promise-in-if': 1,
         'protractor/no-execute-script': 1,
         'protractor/no-repetitive-locators': 1,
+        'protractor/no-get-inner-outer-html': 1,
         'protractor/by-css-shortcut': 0
       },
       globals: {

lib/rules/no-get-inner-outer-html.js

@@ -0,0 +1,32 @@
+'use strict'
+
+/**
+ * @fileoverview Warn about using `getInnerHtml()` and `getOuterHtml()` methods
+ * @author Alexander Afanasyev
+ */
+
+module.exports = {
+  meta: {
+    schema: []
+  },
+
+  create: function (context) {
+    return {
+      'CallExpression': function (node) {
+        var object = node.callee.object
+        var property = node.callee.property
+
+        if (object && property) {
+          var isInnerHtml = property.name === 'getInnerHtml'
+          var isOuterHtml = property.name === 'getOuterHtml'
+          if (isInnerHtml || isOuterHtml) {
+            context.report({
+              node: node,
+              message: 'Unexpected "' + property.name + '()"'
+            })
+          }
+        }
+      }
+    }
+  }
+}

test/rules/no-get-inner-outer-html.js

@@ -0,0 +1,67 @@
+'use strict'
+
+var rule = require('../../lib/rules/no-get-inner-outer-html')
+var RuleTester = require('eslint').RuleTester
+
+var eslintTester = new RuleTester()
+
+eslintTester.run('no-get-inner-outer-html', rule, {
+  valid: [
+    'expect(element(by.id("myid")).getText()).toEqual("test");',
+    'getInnerHtml();',
+    'var html = getOuterHtml();',
+    'elm.getInnerHTML();',
+    'elm.getOuterHTML();'
+  ],
+
+  invalid: [
+    {
+      code: 'expect(element(by.id("myid")).getInnerHtml()).toEqual("test");',
+      errors: [
+        {
+          message: 'Unexpected "getInnerHtml()"'
+        }
+      ]
+    },
+    {
+      code: 'expect(element(by.id("myid")).getOuterHtml()).toEqual("test");',
+      errors: [
+        {
+          message: 'Unexpected "getOuterHtml()"'
+        }
+      ]
+    },
+    {
+      code: 'element.all(by.css(".class")).first().getOuterHtml();',
+      errors: [
+        {
+          message: 'Unexpected "getOuterHtml()"'
+        }
+      ]
+    },
+    {
+      code: 'element(by.id("id")).all(by.css(".class")).last().getInnerHtml();',
+      errors: [
+        {
+          message: 'Unexpected "getInnerHtml()"'
+        }
+      ]
+    },
+    {
+      code: '$$(".class").first().getOuterHtml();',
+      errors: [
+        {
+          message: 'Unexpected "getOuterHtml()"'
+        }
+      ]
+    },
+    {
+      code: '$(".class").getInnerHtml().then(function (html) { console.log(html) });',
+      errors: [
+        {
+          message: 'Unexpected "getInnerHtml()"'
+        }
+      ]
+    }
+  ]
+})