Documentation (#638)

* Marking script blocks, fixing spelling errors, adding cSpell.json for VSCode users for common words

* Added a markdown-lint configuration file to encapsulate what previous authors were following

* Responding to code review comments and reverting unordered list spacing

* Touched up spacing

Author: Drew Diamantoukos

.markdownlint.json

@@ -0,0 +1,19 @@
+{
+  "MD007": {
+    "indent": 4
+  },
+  "MD013": false,
+  "MD026": {
+    "punctuation": ".,;:!"
+  },
+  "MD029": {
+    "style": "ordered"
+  },
+  "MD030": {
+    "ul_multi": 1,
+    "ul_single": 1,
+    "ol_single": 2,
+    "ol_multi": 2
+  },
+  "MD036": false
+}

CODE_OF_CONDUCT.md

@@ -18,8 +18,7 @@ Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Public or private harassment Publishing others' private information, such as a physical or electronic address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities

CONTRIBUTING.md

@@ -4,12 +4,12 @@ Thanks for getting here. If you have a good will to improve CodeceptJS we are al
 
 To start you need:
 
-1. Fork the repo. 
-2. Run `npm install` to install all required libraries
-3. Do the changes.
-4. Add/Update Test (if possible)
-5. Commit and Push to your fork
-6. Make Pull Request
+1.  Fork the repo.
+2.  Run `npm install` to install all required libraries
+3.  Do the changes.
+4.  Add/Update Test (if possible)
+5.  Commit and Push to your fork
+6.  Make Pull Request
 
 Depending on a type of a change you should do the following.
 
@@ -21,34 +21,37 @@ Please keep in mind that CodeceptJS have **unified API** for WebDriverIO, Appium
 
 *Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required! Do **not edit** `docs/helpers/`, those files are generated from docblocks in corresponding helpers! *
 
-Working test is highly appreciated. To run the test suite you need: 
+Working test is highly appreciated. To run the test suite you need:
 
 * selenium server + chromedriver
 * PHP installed
 
 To launch PHP demo application run:
 
-```
+```sh
 php -S 127.0.0.1:8000 -t test/data/app
 ```
 
 Execute test suite:
 
-```
+```sh
 mocha test/helper/WebDriverIO_test.js
 mocha test/helper/SeleniumWebdriver_test.js
 ```
+
 Use `--grep` to execute tests only for changed parts.
 
 If you need to add new HTML page for a test, please create new `.php` file in to `tests/data/app/view/form`:
 
 Adding `myexample` page:
+
+```sh
+tests/data/app/view/form/myexample.php
 ```
-tests/data/app/view/form/myexample.php 
-```
+
 Then is should be accessible at:
 
-```
+```sh
 http://localhost:8000/form/myexample
 ```
 
@@ -58,7 +61,7 @@ http://localhost:8000/form/myexample
 
 Protractor Helper extends SeleniumWebdriver. For non-protractor specific changes you will need to update SeleniumWebdriver helper instead. See section above.
 
-In case you do Protractor-specific change, please add a test:To run the test suite you need: 
+In case you do Protractor-specific change, please add a test:To run the test suite you need:
 
 * selenium server + chromedriver
 
@@ -68,11 +71,11 @@ Demo application is located at: [http://davertmik.github.io/angular-demo-app](ht
 
 *Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required!*
 
-Adding a test is highly appreciated. 
+Adding a test is highly appreciated.
 
 Start JSON server to run tests:
 
-```
+```sh
 npm run json-server
 ```
 
@@ -82,26 +85,25 @@ Edit a test at `tests/helper/REST_test.js` or `test/helper/ApiDataFactory_test.j
 
 *Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required! Do **not edit** `docs/helpers/`, those files are generated from docblocks in corresponding helpers! *
 
-It is recommened to run mobile tests on CI. 
+It is recommended to run mobile tests on CI.
 So do the changes, make pull request, see the CI status.
 Appium tests are executed at **Semaphore CI**.
 
-
 ## Core Changes
 
-Before applying any Core changes please raise an issue to disucss that change with core team.
+Before applying any Core changes please raise an issue to discuss that change with core team.
 
 Whenever you implemented a feature/bugfix
 
 Run unit tests:
 
-```
+```sh
 mocha test/unit
 ```
 
 Run general tests:
 
-```
+```sh
 mocha test/runner
 ```
 

ISSUE_TEMPLATE.md

@@ -7,14 +7,16 @@
 ```bash
 # paste output here
 ```
+
 > Provide test source code if related
 
 ```php
 // paste test
 ```
+
 ### Details
 
-* CodeceptJS version: 
+* CodeceptJS version:
 * NodeJS Version:
 * Operating System:
 * Protractor || WebDriverIO || Nightmare version (if related)

README.md

@@ -26,10 +26,11 @@ Codeception tests are:
 Codeception uses **Helper** modules to provide actions to `I` object. Currently CodeceptJS has these helpers:
 
 * [**WebDriverIO**](https://github.com/Codeception/CodeceptJS/blob/master/docs/helpers/WebDriverIO.md) - wrapper on top of Selenium bindings library [WebDriverIO](http://webdriver.io/)
-* [**Protractor**](https://github.com/Codeception/CodeceptJS/blob/master/docs/helpers/Protractor.md) - helper enpowered by [Protractor](http://protractortest.org/) framework for AngularJS testing
+* [**Protractor**](https://github.com/Codeception/CodeceptJS/blob/master/docs/helpers/Protractor.md) - helper empowered by [Protractor](http://protractortest.org/) framework for AngularJS testing
 * [**Nightmare**](https://github.com/Codeception/CodeceptJS/blob/master/docs/helpers/Nightmare.md) - helper which for testing web applications indi Electron  using NightmareJS.
 * [**Appium**](https://github.com/Codeception/CodeceptJS/blob/master/docs/helpers/Appium.md)
 * [**SeleniumWebdriver**](https://github.com/Codeception/CodeceptJS/blob/master/docs/helpers/SeleniumWebdriver.md) - helper which for selenium testing using official Selenium Webdriver JS bindings.
+
 And more to come...
 
 ## Why CodeceptJS?
@@ -50,16 +51,15 @@ as CodeceptJS unifies them and makes them work as they were synchronous.
 * Interactive debugging shell: pause test at any point and try different commands in a browser.
 * Easily create tests, pageobjects, stepobjects with CLI generators.
 
-
 ## Install
 
 ```sh
-$ npm install -g codeceptjs
+npm install -g codeceptjs
 ```
 
 Move to directory where you'd like to have your tests (and codeceptjs config) stored, and run
 
-```
+```sh
 codeceptjs init
 ```
 
@@ -68,19 +68,19 @@ if you need to write Selenium WebDriver tests.
 
 After that create your first test by executing:
 
-```
+```sh
 codeceptjs generate:test
 ```
 
 Now test is created and can be executed with
 
-```
+```sh
 codeceptjs run
 ```
 
 If you want to write your tests using TypeScript just generate standard Type Definitions by executing:
 
-```
+```sh
 codeceptjs def .
 ```
 
@@ -95,7 +95,8 @@ Learn CodeceptJS by examples. Let's assume we have CodeceptJS installed and WebD
 ### Basics
 
 Let's see how we can handle basic form testing:
-```js
+
+```sh
 Feature('CodeceptJS Demonstration');
 
 Scenario('test some forms', (I) => {
@@ -115,13 +116,13 @@ In this examples all methods of `I` are taken from WebDriverIO helper, see [refe
 
 Let's execute this test with `run` command. Additional option `--steps` will show us the running process. We recommend use `--steps` or `--debug` during development.
 
-```
+```sh
 codeceptjs run --steps
 ```
 
 This will produce an output:
 
-```
+```sh
 CodeceptJS Demonstration --
  test some forms
  • I am on page "http://simple-form-bootstrap.plataformatec.com.br/documentation"
@@ -141,7 +142,7 @@ Just add `pause()` call at any place in a test and run it.
 
 Interactive shell can be started outside test context by running:
 
-```
+```sh
 codeceptjs shell
 ```
 
@@ -220,7 +221,7 @@ Scenario('test title', (I) => {
 CodeceptJS provides the most simple way to create and use page objects in your test.
 You can create one by running
 
-```
+```sh
 codeceptjs generate pageobject
 ```
 
@@ -268,12 +269,10 @@ Scenario('test some forms', (I, docsPage) => {
 });
 ```
 
-
 ## License
 
 MIT © [DavertMik](http://codegyre.com)
 
-
 [npm-image]: https://badge.fury.io/js/codeceptjs.svg
 [npm-url]: https://npmjs.org/package/codeceptjs
 [travis-image]: https://travis-ci.org/Codeception/codeceptjs.svg?branch=master

bin/codecept.js

@@ -15,7 +15,7 @@ program.command('init [path]')
 
 program.command('shell [path]')
   .alias('sh')
-  .description('Interative shell')
+  .description('Interactive shell')
   .option('--verbose', 'output internal logging information')
   .option('--profile [value]', 'configuration profile to be used')
   .action(require('../lib/command/interactive'));

docker/README.md

@@ -11,10 +11,9 @@ Sample mount: `-v path/to/codecept.json:/tests`
 
 ### Locally
 
-
 You can execute CodeceptJS with Nightmare locally with no extra configuration.
 
-```
+```sh
 docker run --net=host -v $PWD:/tests codeception/codeceptjs
 ```
 
@@ -77,5 +76,5 @@ _Note: If running with the Nightmare driver, it is not necessary to run a seleni
 To build this image:
 
 ```sh
-$ docker build -t codeception/codeceptjs .
+docker build -t codeception/codeceptjs .
 ```

docs/acceptance.md

@@ -13,7 +13,6 @@ In case of CodeceptJS you can be sure that in code it will be as easy as it soun
 Within web page you can locate elements, interact with them, and check that expected elements are present on a page. That is what a test look like.
 That is what a test look like.
 
-
 ```js
 I.amOnPage('/login');
 I.fillField('Username', 'john');
@@ -200,6 +199,7 @@ I.waitForElement('#agree_button', 30); // secs
 // clicks a button only when it is visible
 I.click('#agree_button');
 ```
+
 More wait actions can be found in helper's reference.
 
 ## SmartWait

docs/advanced.md

@@ -29,7 +29,7 @@ Data(accounts).Scenario('Test Login', (I, current) => {
 This will produce 2 tests with different data sets.
 Current data set is appended to a test name in output:
 
-```
+```sh
 ✓ Test Login | {"login":"davert","password":"123456"}
 ✓ Test Login | {"login":"admin","password":"123456"}
 ```
@@ -54,7 +54,7 @@ all tests with `@tag` could be executed with `--grep @tag` option.
 Scenario('update user profile @slow')
 ```
 
-```
+```sh
 codeceptjs run --grep @slow
 ```
 
@@ -70,23 +70,22 @@ Use regex for more flexible filtering:
 CodeceptJS provides a debug mode in which additional information is printed.
 It can be turned on with `--debug` flag.
 
-```
+```sh
 codeceptjs run --debug
 ```
 
 While running in debug mode you can pause execution and enter interactive console mode by using `pause()` function.
 
 For advanced debugging use NodeJS debugger. In WebStorm IDE:
 
-```
+```sh
 node $NODE_DEBUG_OPTION ./node_modules/.bin/codeceptjs run
 ```
 
 ## Multiple Execution
 
 CodeceptJS can execute multiple suites in parallel. This is useful if you want to execute same tests but on different browsers and with different configurations. Before using this feature you need to add `multiple` option to the config:
 
-
 ```js
 "multiple": {
   "basic": {