Update docs and bump version (#35)

* Update docs and bump version * Update examples * Reformat code with prettier
mucsi96 · Oct 27, 2018 · a06f121 · a06f121
1 parent ef12f17
commit a06f121
Show file tree

Hide file tree

Showing 56 changed files with 303 additions and 319 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,4 @@
+{
+ "printWidth": 100,
+ "singleQuote": true
+}
diff --git a/.travis.yml b/.travis.yml
@@ -4,8 +4,8 @@ addons:
  chrome: stable
 language: node_js
 node_js:
- - "8"
- - "10"
+ - '8'
+ - '10'
 env:
  global:
  - DEBUG=nightwatch-api

diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -2,32 +2,37 @@ Your issue may already be reported!
 Please search on the [issue track](../) before creating one.
 
 ## Expected Behavior
+
 <!--- If you're describing a bug, tell us what should happen -->
 <!--- If you're suggesting a change/improvement, tell us how it should work -->
 
 ## Current Behavior
+
 <!--- If describing a bug, tell us what happens instead of the expected behavior -->
 <!--- If suggesting a change/improvement, explain the difference from current behavior -->
 
 ## Possible Solution
+
 <!--- Not obligatory, but suggest a fix/reason for the bug, -->
 <!--- or ideas how to implement the addition or change -->
 
 ## Steps to Reproduce (for bugs)
+
 <!--- Provide a link to a live example, or an unambiguous set of steps to -->
 <!--- reproduce this bug. Include code to reproduce, if relevant -->
-1.
-2.
-3.
-4.
+
+1. 2. 3. 4.
 
 ## Context
+
 <!--- How has this issue affected you? What are you trying to accomplish? -->
 <!--- Providing context helps us come up with a solution that is most useful in the real world -->
 
 ## Your Environment
+
 <!--- Include as many relevant details about the environment you experienced the bug in -->
-* Version used:
-* Browser Name and version:
-* Operating System and version (desktop or mobile):
-* Link to your project:
+
+- Version used:
+- Browser Name and version:
+- Operating System and version (desktop or mobile):
+- Link to your project:
diff --git a/packages/cucumber-example/nightwatch.conf.js b/packages/cucumber-example/nightwatch.conf.js
@@ -1,20 +1,20 @@
-const chromedriver = require("chromedriver");
-const geckodriver = require("geckodriver");
+const chromedriver = require('chromedriver');
+const geckodriver = require('geckodriver');
 
 module.exports = {
  test_settings: {
  default: {
  webdriver: {
  start_process: true,
  server_path: chromedriver.path,
- cli_args: ["--port=4444"]
+ cli_args: ['--port=4444']
  },
  desiredCapabilities: {
- browserName: "chrome",
+ browserName: 'chrome',
  javascriptEnabled: true,
  acceptSslCerts: true,
  chromeOptions: {
- args: ["headless", "disable-gpu"]
+ args: ['headless', 'disable-gpu']
  }
  }
  },
@@ -23,11 +23,11 @@ module.exports = {
  server_path: chromedriver.path
  },
  desiredCapabilities: {
- browserName: "chrome",
+ browserName: 'chrome',
  javascriptEnabled: true,
  acceptSslCerts: true,
  chromeOptions: {
- args: ["disable-gpu"]
+ args: ['disable-gpu']
  }
  }
  },
@@ -36,7 +36,7 @@ module.exports = {
  server_path: geckodriver.path
  },
  desiredCapabilities: {
- browserName: "firefox",
+ browserName: 'firefox',
  marionette: true
  }
  }

diff --git a/packages/cucumber-example/step-definitions/steps.js b/packages/cucumber-example/step-definitions/steps.js
@@ -1,12 +1,12 @@
-import { client } from "nightwatch-api";
-import { Given, Then } from "cucumber";
+import { client } from 'nightwatch-api';
+import { Given, Then } from 'cucumber';
 
 Given(/^I open Google`s search page$/, async () => {
- await client.url("http://google.com");
+ await client.url('http://google.com');
 });
 
 Given(/^I open DuckDuckGo search page$/, async () => {
- await client.url("https://duckduckgo.com/");
+ await client.url('https://duckduckgo.com/');
 });
 
 Then(/^the title is "(.*?)"$/, async text => {

diff --git a/packages/cucumber-example/test/server.js b/packages/cucumber-example/test/server.js
@@ -1,8 +1,8 @@
-import { startWebDriver, stopWebDriver } from "nightwatch-api";
+import { startWebDriver, stopWebDriver } from 'nightwatch-api';
 
-startWebDriver("default").catch(err => console.log(err));
+startWebDriver('default').catch(err => console.log(err));
 
-process.once("SIGTERM", async () => {
+process.once('SIGTERM', async () => {
  try {
  await stopWebDriver();
  } finally {

diff --git a/packages/cucumber-example/test/support/setup.js b/packages/cucumber-example/test/support/setup.js
@@ -1,10 +1,10 @@
-import { setDefaultTimeout, AfterAll, BeforeAll } from "cucumber";
-import { createSession, closeSession } from "nightwatch-api";
+import { setDefaultTimeout, AfterAll, BeforeAll } from 'cucumber';
+import { createSession, closeSession } from 'nightwatch-api';
 
 setDefaultTimeout(60000);
 
 BeforeAll(async () => {
- await createSession("default");
+ await createSession({ env: 'default' });
 });
 
 AfterAll(async () => {

diff --git a/packages/jest-example/jest.config.js b/packages/jest-example/jest.config.js
@@ -1,3 +1,3 @@
 module.exports = {
- setupTestFrameworkScriptFile: "./test/setup"
+ setupTestFrameworkScriptFile: './test/setup'
 };
diff --git a/packages/jest-example/nightwatch.conf.js b/packages/jest-example/nightwatch.conf.js
@@ -1,20 +1,20 @@
-const chromedriver = require("chromedriver");
-const geckodriver = require("geckodriver");
+const chromedriver = require('chromedriver');
+const geckodriver = require('geckodriver');
 
 module.exports = {
  test_settings: {
  default: {
  webdriver: {
  start_process: true,
  server_path: chromedriver.path,
- cli_args: ["--port=4444"]
+ cli_args: ['--port=4444']
  },
  desiredCapabilities: {
- browserName: "chrome",
+ browserName: 'chrome',
  javascriptEnabled: true,
  acceptSslCerts: true,
  chromeOptions: {
- args: ["headless", "disable-gpu"]
+ args: ['headless', 'disable-gpu']
  }
  }
  },
@@ -23,11 +23,11 @@ module.exports = {
  server_path: chromedriver.path
  },
  desiredCapabilities: {
- browserName: "chrome",
+ browserName: 'chrome',
  javascriptEnabled: true,
  acceptSslCerts: true,
  chromeOptions: {
- args: ["disable-gpu"]
+ args: ['disable-gpu']
  }
  }
  },
@@ -36,7 +36,7 @@ module.exports = {
  server_path: geckodriver.path
  },
  desiredCapabilities: {
- browserName: "firefox",
+ browserName: 'firefox',
  marionette: true
  }
  }

diff --git a/packages/jest-example/test/duckduckgo-search.test.js b/packages/jest-example/test/duckduckgo-search.test.js
@@ -1,18 +1,18 @@
-import { client } from "nightwatch-api";
+import { client } from 'nightwatch-api';
 
-describe("Searching DuckDuckGo", () => {
- test("title and search form", async () => {
+describe('Searching DuckDuckGo', () => {
+ test('title and search form', async () => {
  await client
- .url("https://duckduckgo.com/")
- .assert.title("DuckDuckGo — Privacy, simplified.")
+ .url('https://duckduckgo.com/')
+ .assert.title('DuckDuckGo — Privacy, simplified.')
  .assert.visible('input[name="q"]');
  });
 
- test("search for WebDriver", async () => {
+ test('search for WebDriver', async () => {
  await client
- .url("https://duckduckgo.com/")
- .setValue('input[name="q"]', "WebDriver")
+ .url('https://duckduckgo.com/')
+ .setValue('input[name="q"]', 'WebDriver')
  .click('input[type="submit"]')
- .assert.containsText("#links", "WebDriver - w3.org");
+ .assert.containsText('#links', 'WebDriver - w3.org');
  });
 });
diff --git a/packages/jest-example/test/server.js b/packages/jest-example/test/server.js
@@ -1,8 +1,8 @@
-import { startWebDriver, stopWebDriver } from "nightwatch-api";
+import { startWebDriver, stopWebDriver } from 'nightwatch-api';
 
-startWebDriver("default").catch(err => console.log(err));
+startWebDriver({ env: 'default' }).catch(err => console.log(err));
 
-process.once("SIGTERM", async () => {
+process.once('SIGTERM', async () => {
  try {
  await stopWebDriver();
  } finally {

diff --git a/packages/jest-example/test/setup.js b/packages/jest-example/test/setup.js
@@ -1,9 +1,9 @@
-import { createSession, closeSession } from "nightwatch-api";
+import { createSession, closeSession } from 'nightwatch-api';
 
 jest.setTimeout(60000);
 
 beforeAll(async () => {
- await createSession("default");
+ await createSession({ env: 'default' });
 });
 
 afterAll(async () => {

diff --git a/packages/nightwatch-api/package.json b/packages/nightwatch-api/package.json
@@ -1,6 +1,6 @@
 {
  "name": "nightwatch-api",
- "version": "0.4.0",
+ "version": "1.0.0",
  "main": "./lib/index.js",
  "files": [
  "lib",
@@ -65,10 +65,6 @@
  "pre-commit": "pretty-quick --staged"
  }
  },
- "prettier": {
- "printWidth": 100,
- "singleQuote": true
- },
  "dependencies": {
  "debug": "^4.1.0",
  "@types/debug": "^0.0.31"

diff --git a/packages/nightwatch-api/test/nightwatch.conf.js b/packages/nightwatch-api/test/nightwatch.conf.js
@@ -13,6 +13,7 @@ module.exports = {
  webdriver: {
  start_process: true,
  server_path: chromedriver.path,
+ port: 4444,
  cli_args: ['--port=4444']
  },
  desiredCapabilities: {

diff --git a/packages/node-example/nightwatch.conf.js b/packages/node-example/nightwatch.conf.js
@@ -1,20 +1,20 @@
-const chromedriver = require("chromedriver");
-const geckodriver = require("geckodriver");
+const chromedriver = require('chromedriver');
+const geckodriver = require('geckodriver');
 
 module.exports = {
  test_settings: {
  default: {
  webdriver: {
  start_process: true,
  server_path: chromedriver.path,
- cli_args: ["--port=4444"]
+ cli_args: ['--port=4444']
  },
  desiredCapabilities: {
- browserName: "chrome",
+ browserName: 'chrome',
  javascriptEnabled: true,
  acceptSslCerts: true,
  chromeOptions: {
- args: ["headless", "disable-gpu"]
+ args: ['headless', 'disable-gpu']
  }
  }
  },
@@ -23,11 +23,11 @@ module.exports = {
  server_path: chromedriver.path
  },
  desiredCapabilities: {
- browserName: "chrome",
+ browserName: 'chrome',
  javascriptEnabled: true,
  acceptSslCerts: true,
  chromeOptions: {
- args: ["disable-gpu"]
+ args: ['disable-gpu']
  }
  }
  },
@@ -36,7 +36,7 @@ module.exports = {
  server_path: geckodriver.path
  },
  desiredCapabilities: {
- browserName: "firefox",
+ browserName: 'firefox',
  marionette: true
  }
  }

diff --git a/packages/node-example/test.js b/packages/node-example/test.js
@@ -4,11 +4,11 @@ const {
  startWebDriver,
  stopWebDriver,
  client
-} = require("nightwatch-api");
+} = require('nightwatch-api');
 
-async function setup(env = "default") {
- await startWebDriver(env);
- await createSession(env);
+async function setup(options) {
+ await startWebDriver(options);
+ await createSession(options);
 }
 
 async function shutdown() {
@@ -18,16 +18,16 @@ async function shutdown() {
 }
 
 async function run() {
- await client.url("https://duckduckgo.com/");
+ await client.url('https://duckduckgo.com/');
  let title;
  await client.getTitle(t => (title = t));
- await client.assert.title("DuckDuckGo — Privacy, simplified.");
+ await client.assert.title('DuckDuckGo — Privacy, simplified.');
  console.log(title);
 }
 
 (async function() {
  try {
- await setup("default");
+ await setup({ env: 'default' });
  await run();
  } catch (err) {
  console.log(err.stack);

diff --git a/packages/website/.babelrc b/packages/website/.babelrc
@@ -1,14 +1,14 @@
 {
- "presets": [
- "@babel/preset-env",
- "@babel/preset-react"
- ],
+ "presets": ["@babel/preset-env", "@babel/preset-react"],
  "plugins": [
  "@babel/plugin-proposal-class-properties",
  "@babel/plugin-proposal-object-rest-spread",
- ["babel-plugin-styled-components", {
- "ssr": true
- }],
+ [
+ "babel-plugin-styled-components",
+ {
+ "ssr": true
+ }
+ ],
  "inline-react-svg"
  ]
 }