feat: Allow specifying all initialization parameters supported by WebdriverIO

Author: prantlf

Gruntfile.js

@@ -63,8 +63,10 @@ module.exports = function (grunt) {
 
     'html-dom-snapshot': {
       options: {
-        browserCapabilities: {
-          browserName: 'phantomjs'
+        webdriver: {
+          desiredCapabilities: {
+            browserName: 'phantomjs'
+          }
         },
         snapshots: 'test/snapshots'
       },
@@ -355,6 +357,9 @@ module.exports = function (grunt) {
       },
       'invalid-file': {
         options: {
+          browserCapabilities: {
+            browserName: 'phantomjs'
+          },
           screenshots: 'test/screenshots',
           force: true
         },

README.md

@@ -65,10 +65,12 @@ Default options support the most usual usage scenario:
 ```js
 'html-dom-snapshot': {
   options: {
-    browserCapabilities: {
-      browserName: 'chrome',
-      chromeOptions: {
-        args: ['--headless']
+    webdriver: {
+      desiredCapabilities: {
+        browserName: 'chrome',
+        chromeOptions: {
+          args: ['--headless']
+        }
       }
     },
     viewport: {
@@ -92,11 +94,11 @@ Default options support the most usual usage scenario:
 
 ### Options
 
-#### browserCapabilities
+#### webdriver
 Type: `Object`
 Default value: see above
 
-Chooses the web browser to take snapshots with. Passed as `desiredCapabilities` to `webdriverio.remote`. This object has to contain the property `browserName` and optionally other properties depending on the web browser driver. The following browser names are the most usually used: `chrome`, `edge`, `firefox`, `ie`, `phantomjs`, `safari`. Depending on what browser you specify, you will need to load the corresponding Selenium driver. These are current versions of the drivers:
+Chooses the web browser to take snapshots with, Selenium host and other parameters supported by WebdriverIO as input for the  `webdriverio.remote` method. This object has to contain the property `desiredCapabilities` with `browserName` and optionally other properties depending on the web browser driver. The following browser names are the most usually used: `chrome`, `edge`, `firefox`, `ie`, `phantomjs`, `safari`. Depending on what browser you specify, you will need to load the corresponding Selenium driver. These are current versions of the drivers:
 
 ```js
 'selenium_standalone': {
@@ -497,6 +499,7 @@ your code using Grunt.
 
 ## Release History
 
+ * 2018-03-29  [v1.1.0]  Allow specifying all initialization parameters supported by WebdriverIO
  * 2018-03-28  [v1.0.2]  Stop Selenium and Chromedriver processes on unexpected Grunt process abortion
  * 2018-03-28  [v1.0.1]  Workaround for hanging chromedriver after finishing the task
  * 2018-03-11  [v1.0.0]  Require Node.js >= 6

tasks/html-dom-snapshot.js

@@ -36,10 +36,12 @@ module.exports = function (grunt) {
       const done = this.async()
       const data = this.data
       const options = this.options({
-        browserCapabilities: {
-          browserName: 'chrome',
-          chromeOptions: {
-            args: ['--headless']
+        webdriver: {
+          desiredCapabilities: {
+            browserName: 'chrome',
+            chromeOptions: {
+              args: ['--headless']
+            }
           }
         },
         viewport: {
@@ -58,17 +60,22 @@ module.exports = function (grunt) {
       const pages = data.pages
       const snapshots = options.dest
       const viewport = options.viewport
+      const webdriver = options.webdriver
+      const browserCapabilities = options.browserCapabilities
       const lastViewport = {
         width: viewport.width,
         height: viewport.height
       }
-      let client = webdriverio.remote({
-        desiredCapabilities: options.browserCapabilities
-      })
       let urlCount = 0
       let snapshotCount = 0
       let screenshotCount = 0
       let commands
+      if (browserCapabilities) {
+        grunt.log.warn('The property "browserCapabilities" is deprecated. ' +
+                      'Use "webdriver.desiredCapabilities" with the same content.')
+        webdriver.desiredCapabilities = browserCapabilities
+        delete options.browserCapabilities
+      }
       if (pages) {
         grunt.log.warn('The property "pages" is deprecated. ' +
                       'Use "commands" with the same content.')
@@ -82,6 +89,7 @@ module.exports = function (grunt) {
 
       grunt.verbose.writeln('Open web browser window for the target "' +
                             target + '".')
+      let client = webdriverio.remote(webdriver)
       client.init()
             .then(function () {
               nodeCleanup(stop)