codeceptjs 2.6.7 → 2.6.11

package/docs/videos.md

@@ -6,14 +6,14 @@ title: Videos
 editLink: false
 ---
 
-> Add your own videos to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Videos)
+> Add your own videos to our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Videos)
 [![](http://i3.ytimg.com/vi/BRMWstiOTks/maxresdefault.jpg)](https://www.youtube.com/watch?v=BRMWstiOTks)
 
-* ## [An Introduction, Getting started and working with CodeceptJS & Puppeteer (EAWeekend)](https://www.youtube.com/watch?v=BRMWstiOTks)
+## [An Introduction, Getting started and working with CodeceptJS & Puppeteer (EAWeekend)](https://www.youtube.com/watch?v=BRMWstiOTks)
 
-* ## [CodeceptJS Official YouTube Channel](https://www.youtube.com/channel/UCEs4030bmtonyDhTHEXa_2g)
+## [CodeceptJS Official YouTube Channel](https://www.youtube.com/channel/UCEs4030bmtonyDhTHEXa_2g)
 
-* ## [Introductory Videos](https://www.youtube.com/watch?v=FPFG1rBNJ64&list=PLcFXthgti9Lt4SjSvL1ALDg6dOeTC0TvT)
+## [Introductory Videos](https://www.youtube.com/watch?v=FPFG1rBNJ64&list=PLcFXthgti9Lt4SjSvL1ALDg6dOeTC0TvT)
 
 Free educational videos provided by our community member **[@ontytoom](http://github.com/ontytoom)**.
 

package/docs/webapi/saveElementScreenshot.mustache

@@ -0,0 +1,9 @@
+Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+Filename is relative to output folder.
+
+```js
+I.saveElementScreenshot(`#submit`,'debug.png');
+```
+
+@param {string|object} locator element located by CSS|XPath|strict locator.  
+@param {string} fileName file name to save.

package/docs/webapi/type.mustache

@@ -1,12 +1,17 @@
-
-Types out the given string or the array of keys provided.
-_Note:_ Should only be used when using [`fillField`](#fillfield) is not an option.
+Types out the given text into an active field.
+To slow down typing use a second parameter, to set interval between key presses.
+_Note:_ Should be used when [`fillField`](#fillfield) is not an option.
 
 ```js
-// When passing in a string
+// passing in a string
 I.type('Type this out.');
-// When passing in an array
+
+// typing values with a 100ms interval
+I.type('4141555311111111', 100);
+
+// passing in an array
 I.type(['T', 'E', 'X', 'T']);
 ```
 
-@param {string|string[]} key or array of keys to type.
+@param {string|string[]} key or array of keys to type.
+@param {?number} [delay=null] (optional) delay in ms between key presses

package/docs/wiki/{Community-Helpers.md → Community-Helpers-&-Plugins.md}

@@ -4,12 +4,13 @@ Please **add your own** by editing this page.
 ## Email Checking
 
 * [MailCatcher](https://gist.github.com/schmkr/026732dfa1627b927ff3a08dc31ee884) - to check emails via Mailcatcher locally.
+* [codeceptjs-mailhog-helper](https://github.com/tsuemura/codeceptjs-mailhog-helper) - to check emails via Mailhog locally.
 
 ## Data Sources
 
 * [codeceptjs-httpmock](https://github.com/testphony/codeceptjs-httpMock) -  a helper which wraps mockttp library to manage http mock in tests.
 * [codeceptjs-http](https://github.com/testphony/codeceptjs-http) - a helper which wraps then-request library to process HTTP requests. It's alternative helper that provides more flexible request management.
-* [codeceptjs-dbhelper](https://www.npmjs.com/package/codeceptjs-dbhelper) - allows you to execute queries or commands to databases using database-js. 
+* [codeceptjs-dbhelper](https://github.com/thiagodp/codeceptjs-dbhelper) - allows you to execute queries or commands to databases using database-js. 
 
 ## Cloud Providers
 * [codeceptjs-saucehelper](https://github.com/puneet0191/codeceptjs-saucehelper/) - a helper which updates `Test Names` & `Test Results` on Saucelabs 
@@ -24,7 +25,9 @@ Please **add your own** by editing this page.
 * [codeceptjs-applitoolshelper](https://www.npmjs.com/package/codeceptjs-applitoolshelper) - a helper which helps interaction with [Applitools](https://applitools.com)
 
 ## Reporters
-* [codeceptjs-rphelper](https://www.npmjs.com/package/codeceptjs-rphelper) is a CodeceptJS helper which can publish tests results on ReportPortal after execution.
+* [codeceptjs-rphelper](https://github.com/reportportal/agent-js-codecept) is a CodeceptJS helper which can publish tests results on ReportPortal after execution.
+* [codeceptjs-xray-helper](https://www.npmjs.com/package/codeceptjs-xray-helper) is a CodeceptJS helper which can publish tests results on [XRAY](https://confluence.xpand-it.com/display/XRAYCLOUD/Import+Execution+Results+-+REST).
+* [codeceptjs-slack-reporter](https://www.npmjs.com/package/codeceptjs-slack-reporter) Get a Slack notification when one or more scenarios fail.
 
 ## Page Object Code Generator
 * [codeceptjs-CodeGenerator](https://github.com/senthillkumar/CodeCeptJS-PageObject) is a CodeceptJS custom wrapper which can create page class with action methods from the page object file(JSON) and project setup(Folder Structure).
@@ -38,4 +41,5 @@ Please **add your own** by editing this page.
 
 ## Other
 
+* [codeceptjs-cmdhelper](https://github.com/thiagodp/codeceptjs-cmdhelper) allows you to run commands in the terminal/console
 * [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.

package/docs/wiki/Examples.md

@@ -135,4 +135,14 @@ This is a ready to use example that shows how to integrate CodeceptJS with Puppe
 * puppeteer helper example
 * test steps, pages, fragments
 * examples for sequential and parallel execution
-* generation of allure test results  
+* generation of allure test results  
+
+## [Framework with UI and API test support : CodeceptJS , Puppeteer , REST , ESLint](https://github.com/avighub/CodeceptJS-puppeteer)
+This is a basic framework with Puppeteer , REST helpers which can support both UI and API actions within same test.
+More improvements and features will be added and will be updated. 
+Suggestions and improvements are welcome , please raise a ticket in Issue tab.
+
+* Step by step setup in README
+* Two helpers are added. UI - Puppeteer , API - REST and chai-codeceptJS for assetion
+* ESLint for code check
+* Upcoming : API generic functions , Adaptor design pattern , More utilities

package/docs/wiki/Google-Summer-of-Code-(GSoC)-2020.md

@@ -0,0 +1,68 @@
+### About
+GSoC is an international annual program in which Google awards stipends to university students who successfully complete a requested coding project during the summer. 
+
+Codecept-JS has decided to apply to participate in GSoC 2020, Please note that the final list of GSoC 2020 organizations will be announced on 22nd Feb 2020.  
+
+To read more about the program please visit [GSoC Program](https://summerofcode.withgoogle.com/)
+
+The timeline for the program can be found on [Official Program Timeline](https://summerofcode.withgoogle.com/how-it-works/#timeline)
+
+### Contact Information
+
+For all the students who are interested in working with Codecept-JS organization for GSoC 2020, you can start by reaching out to our organization team by posting your interest in our [Forum](https://codecept.discourse.group/)
+
+Read about the Project on our [Official Project Website](https://codecept.io/)
+
+You can also join our Community Slack, which is used for community conversation, our GSoC team will be available on slack, we will have dedicated channel for GSoC Students and Projects, join [here](http://bit.ly/chat-codeceptjs)
+
+### Student Information
+
+If you are a student and are interested in participating, the following is useful information. 
+
+#### Proposal Guidelines
+Before applying as a Codeceptjs Contributor, we suggest you review the points below. It can help you with creating a strong Proposal.
+
+1. Read about Codeceptjs on our [Official Website](https://codecept.io/)
+2. Setup Codeceptjs on your working system, and then Go through the list of open issues on our [Github Repo](https://github.com/Codeception/CodeceptJS/issues), try to help us with fixing some of them, or help in testing existing PR's from our developers. 
+3. Go through the guides available on our official website, understand how our helpers work and check the list of current helpers on our organization [Github](https://github.com/codecept-js)
+
+#### Application Template
+
+If you are planning to send us a proposal, please make sure you have addressed the following elements:
+
+1. About you (your background, experience, education, hobbies)
+2. Project background (current state of what exist)
+3. Design/description of work
+4. Benefit of your work to the project users and developers
+5. Deliverables
+6. Scheduling
+7. Other commitments (i.e., exams, part time work, holidays, lectures, etc.)
+8. Community engagement (involvement, sample PR's, forum discussions, other open-source involvement)
+
+### Idea's for GSoC 2020
+
+#### Improve Visual Testing Support in Codeceptjs
+CodeceptJS has a visual testing helper which is based on resemble.js, instructions to set up and use the helper can be found [here](https://github.com/codecept-js/codeceptjs-resemblehelper)
+
+We have several improvements we want to make to our helper, here is the list. 
+1. Add Support for Allure Reporter
+2. Add Support for Visual Testing with [Codecept UI](https://codecept.io/ui/) 
+3. Support for [Workers](https://codecept.io/parallel/)
+
+Knowledge Prerequisite: Github, Nodejs, CodeceptJS, Resemble.js
+
+Difficulty: Medium
+
+Possible Mentors: Puneet Kala, Koushik Mohan
+
+#### Improve Codecept UI
+CodeceptJS has an interactive, graphical test runner, which is called CodeceptUI. It works on Browsers and helps in managing tests. 
+We need help with improving the CodeceptUI project, fixing existing issues. 
+1. To get started, please read about CodeceptUI [here](https://codecept.io/ui/)
+2. To get your hands on the code, you can check out the Repo [here](https://github.com/codecept-js/ui), look at the list of open issues and start with fixing them. 
+
+Knowledge Prerequisite: Github, CodeceptJS, JS, VueJS, Express.js, WebSockets, NodeJS
+
+Difficulty: Medium
+
+Possible Mentors: Michael Bodnarchuk, Paul 

package/docs/wiki/Home.md

@@ -1,11 +1,16 @@
-Welcome to the CodeceptJS wiki!
+Wiki Pages contain community content which is partly copied into the website.
 
-Some useful links:
+* :toolbox:  [Community Helpers & Plugins](https://github.com/codeceptjs/CodeceptJS/wiki/Community-Helpers-&-Plugins) - collection of community-driven plugins and helpers (synced with website).
+* :eyes:  [Examples](https://github.com/codeceptjs/CodeceptJS/wiki/Examples) - collection of CodeceptJS sample projects (synced with website).
+* :book: [Books & Posts](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts) - posts about CodeceptJS (synced with website).
+* :tv: [Videos](https://github.com/codeceptjs/CodeceptJS/wiki/Videos) - videos on CodeceptJS (synced with website).
+Add your own entries to these lists.
+
+Other useful links:
 * [Official Site](http://codecept.io)
 * [Roadmap](https://github.com/Codeception/CodeceptJS/wiki/Roadmap)
-* [Books & Posts](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts)
-* [Community Helpers](https://github.com/Codeception/CodeceptJS/wiki/Community-Helpers)
 * [Code on Github](https://github.com/Codeception/CodeceptJS)
 * [Change log](https://github.com/Codeception/CodeceptJS/blob/master/CHANGELOG.md)
+* [GSoC](https://github.com/Codeception/CodeceptJS/wiki/Google-Summer-of-Code-(GSoC)-2020)
 
 

package/docs/wiki/Release-Process.md

@@ -0,0 +1,24 @@
+This is the guide for maintainers:
+
+## Release Process
+
+1. Pull the latest changes from master
+2. Create a branch `release-x.x.x` and switch to it `git checkout -b release-x.x.x`
+3. Update version in `package.json`
+4. Go through the commits for the new release and add them to the CHANGELOG.md: 
+  * Changelog should be written for humans (not for robots). 
+  * Use simple wording explaining what the change is, how to use a new feature (maybe with a code example) and mention the related issue. 
+  * When using `#123` a link for issue #123 will be automatically added. 
+  * A contributor must be mentioned. We use GitHub names with `@` prefix. A link to user profile is automatically added.
+5. Run `./runio.js docs` to build documentation
+6. Commit all changes, push and create a PR
+7. Check that all tests pass and merge your PR
+8. Run `./runio.js release` to publish latest release. The website will be updated.
+  * To update version for patch release: `./runio.js release patch`
+  * To update version for minor release: `./runio.js release minor`
+9. Post announcements in Twitter & Slack
+
+## Updating the website
+
+* Run `./runio.js docs:helpers` to build docs from helpers
+* Run `./runio.js publish:site` to update a website