codeceptjs 2.3.4 → 2.4.1

package/docs/webapi/scrollTo.mustache

@@ -6,6 +6,6 @@ I.scrollTo('footer');
 I.scrollTo('#submit', 5, 5);
 ```
 
-@param {string|object} locator located by CSS|XPath|strict locator.
-@param {number} offsetX (optional, `0` by default) X-axis offset.
-@param {number} offsetY (optional, `0` by default) Y-axis offset.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+@param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
+@param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.

package/docs/webapi/see.mustache

@@ -7,4 +7,4 @@ I.see('Welcome', '.content'); // text inside .content div
 I.see('Register', {css: 'form.register'}); // use strict locator
 ```
 @param {string} text expected on page.
-@param {string|object} context (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
+@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.

package/docs/webapi/seeAttributesOnElements.mustache

@@ -4,5 +4,5 @@ Checks that all elements with given locator have given attributes.
 I.seeAttributesOnElements('//form', { method: "post"});
 ```
 
-@param {string|object} locator located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {object} attributes attributes and their values to check.

package/docs/webapi/seeCheckboxIsChecked.mustache

@@ -6,4 +6,4 @@ I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
 I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 ```
 
-@param {string|object} field located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.

package/docs/webapi/seeCssPropertiesOnElements.mustache

@@ -4,5 +4,5 @@ Checks that all elements with given locator have given CSS properties.
 I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 ```
 
-@param {string|object} locator located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {object} cssProperties object with CSS properties and their values to check.

package/docs/webapi/seeElement.mustache

@@ -4,4 +4,4 @@ Element is located by CSS or XPath.
 ```js
 I.seeElement('#modal');
 ```
-@param {string|object} locator located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.

package/docs/webapi/seeElementInDOM.mustache

@@ -4,4 +4,4 @@ Element is located by CSS or XPath.
 ```js
 I.seeElementInDOM('#modal');
 ```
-@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.

package/docs/webapi/seeInField.mustache

@@ -7,5 +7,5 @@ I.seeInField({css: 'form textarea'},'Type your comment here');
 I.seeInField('form input[type=hidden]','hidden_value');
 I.seeInField('#searchform input','Search');
 ```
-@param {string|object} field located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
 @param {string} value value to check.

package/docs/webapi/seeNumberOfElements.mustache

@@ -6,5 +6,5 @@ Element is located by label or name or CSS or XPath.
 I.seeNumberOfElements('#submitBtn', 1);
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.

package/docs/webapi/seeNumberOfVisibleElements.mustache

@@ -5,5 +5,5 @@ Element is located by CSS or XPath.
 I.seeNumberOfVisibleElements('.buttons', 3);
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.

package/docs/webapi/seeTextEquals.mustache

@@ -0,0 +1,8 @@
+Checks that text is equal to provided one.
+
+```js
+I.seeTextEquals('text', 'h1');
+```
+
+@param {string} text element value to check.
+@param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.

package/docs/webapi/selectOption.mustache

@@ -16,5 +16,5 @@ Provide an array for the second argument to select multiple options.
 ```js
 I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 ```
-@param {string|object} select field located by label|name|CSS|XPath|strict locator.
-@param {string|array} option visible text or value of option.
+@param {CodeceptJS.LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
+@param {string|Array<*>} option visible text or value of option.

package/docs/webapi/switchTo.mustache

@@ -5,4 +5,4 @@ I.switchTo('iframe'); // switch to first iframe
 I.switchTo(); // switch back to main page
 ```
 
-@param {string|object} locator (optional, `null` by default) element located by CSS|XPath|strict locator.
+@param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.

package/docs/webapi/uncheckOption.mustache

@@ -8,5 +8,5 @@ I.uncheckOption('#agree');
 I.uncheckOption('I Agree to Terms and Conditions');
 I.uncheckOption('agree', '//form');
 ```
-@param {string|object} field checkbox located by label | name | CSS | XPath | strict locator.
-@param {string} context (optional, `null` by default) element located by CSS | XPath | strict locator.
+@param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
+@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.

package/docs/webapi/waitForClickable.mustache

@@ -0,0 +1,10 @@
+Waits for element to be clickable (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitForClickable('.btn.continue');
+I.waitForClickable('.btn.continue', 5); // wait for 5 secs
+```
+
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {number} [sec] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForDetached.mustache

@@ -5,5 +5,5 @@ Element can be located by CSS or XPath.
 I.waitForDetached('#popup');
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForElement.mustache

@@ -6,5 +6,5 @@ I.waitForElement('.btn.continue');
 I.waitForElement('.btn.continue', 5); // wait for 5 secs
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {number} [sec] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForEnabled.mustache

@@ -1,5 +1,5 @@
 Waits for element to become enabled (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.

package/docs/webapi/waitForFunction.mustache

@@ -12,5 +12,5 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 ```
 
 @param {string|function} fn to be executed in browser context.
-@param {array|number} argsOrSec (optional, `1` by default) arguments for function or seconds.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
+@param {number} [sec] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForInvisible.mustache

@@ -5,5 +5,5 @@ Element can be located by CSS or XPath.
 I.waitForInvisible('#popup');
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForText.mustache

@@ -8,5 +8,5 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 ```
 
 @param {string }text to wait for.
-@param {number} sec (optional, `1` by default) time in seconds to wait
-@param {string|object} context (optional) element located by CSS|XPath|strict locator.
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.

package/docs/webapi/waitForValue.mustache

@@ -6,4 +6,4 @@ I.waitForValue('//input', "GoodValue");
 
 @param {string|object} field input field.
 @param {string }value expected value.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForVisible.mustache

@@ -5,5 +5,5 @@ Element can be located by CSS or XPath.
 I.waitForVisible('#popup');
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitInUrl.mustache

@@ -5,4 +5,4 @@ I.waitInUrl('/info', 2);
 ```
 
 @param {string} urlPart value to check.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitNumberOfVisibleElements.mustache

@@ -4,6 +4,6 @@ Waits for a specified number of elements on the page.
 I.waitNumberOfVisibleElements('a', 3);
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitToHide.mustache

@@ -5,5 +5,5 @@ Element can be located by CSS or XPath.
 I.waitToHide('#popup');
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitUntil.mustache

@@ -6,5 +6,6 @@ I.waitUntil(() => window.requests == 0, 5);
 ```
 
 @param {function|string} fn function which is executed in browser context.
-@param {number} sec (optional, `1` by default) time in seconds to wait
-@param {string} [timeoutMsg=''] message to show in case of timeout fail.
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
+@param {string} [timeoutMsg=''] message to show in case of timeout fail.
+@param {?number} [interval=null]

package/docs/webapi/waitUrlEquals.mustache

@@ -6,4 +6,4 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 ```
 
 @param {string} urlPart value to check.
-@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {number} [sec=1] (optional, `1` by default) time in seconds to wait

package/docs/webdriver.md

@@ -1,15 +1,17 @@
 ---
-id: webdriver
+permalink: /webdriver
 title: Testing with WebDriver
 ---
 
+# Testing with WebDriver
+
 How does your client, manager, or tester, or any other non-technical person, know your web application is working? By opening the browser, accessing a site, clicking on links, filling in the forms, and actually seeing the content on a web page.
 
 End to End tests can cover standard but complex scenarios from a user's perspective. With e2e tests you can be confident that users, following all defined scenarios, won't get errors. We check **functionality of application and a user interface** (UI) as well.
 
 ## What is Selenium WebDriver
 
-The standard and proved way to run browser test automation over years is Selenium WebDriver. Over years this technology was standartized and works over all popular browsers and operating systems. There are cloud services like SauceLabs or BrowserStack which allow executing such browsers in the clooud. The superset of WebDriver protocol is also used to test [native and hybrid mobile applications](https://codecept.io/mobile).
+The standard and proved way to run browser test automation over years is Selenium WebDriver. Over years this technology was standartized and works over all popular browsers and operating systems. There are cloud services like SauceLabs or BrowserStack which allow executing such browsers in the cloud. The superset of WebDriver protocol is also used to test [native and hybrid mobile applications](/mobile).
 
 Let's clarify the terms:
 
@@ -19,9 +21,9 @@ Let's clarify the terms:
 
 We use [webdriverio](https://webdriver.io) library to run tests over WebDriver.
 
-> Popular tool [Protractor](https://codecept.io/angular) also uses WebDriver for running end 2 end tests.
+> Popular tool [Protractor](/angular) also uses WebDriver for running end 2 end tests.
 
-To proceed you need to have [CodeceptJS installed](https://codecept.io/quickstart#using-selenium-webdriver) and `WebDriver` helper selected.
+To proceed you need to have [CodeceptJS installed](/quickstart#using-selenium-webdriver) and `WebDriver` helper selected.
 
 Selenium WebDriver may be complicated from start, as it requires following tools to be installed and started.
 
@@ -79,7 +81,7 @@ Configuration for WebDriver should be provided inside `codecept.conf.js` file un
 
 WebDriver protocol works over HTTP, so you need to have a Selenium Server to be running or other service that will launch a browser for you. That's why you may need to specify `host`, `port`, `protocol`, and `path` parameters.
 
-By default, those parameters are set to connect to local Selenium Server but they should be changed if you want to run tests via [Cloud Services](https://codecept.io/helpers/WebDriver#cloud-providers). You may also need `user` and `key` parameters to authenticate on cloud service.
+By default, those parameters are set to connect to local Selenium Server but they should be changed if you want to run tests via [Cloud Services](/helpers/WebDriver#cloud-providers). You may also need `user` and `key` parameters to authenticate on cloud service.
 
 If you want to run tests using raw ChromeDriver (which also supports WebDriver protocol) avoiding Selenium Server, you should provide following configuration:
 
@@ -147,7 +149,7 @@ keepBrowserState: true,
 keepCookies: true,
 ```
 
-> ▶ More config options available on [WebDriver helper reference](https://codecept.io/helpers/WebDriver#configuration)
+> ▶ More config options available on [WebDriver helper reference](/helpers/WebDriver#configuration)
 
 ## Writing Tests
 
@@ -168,7 +170,7 @@ Scenario('login test', (I) => {
   I.see('Welcome, John');
 });
 ```
-> ▶ Actions like `amOnPage`, `click`, `fillField` are not limited to WebDriver only. They work similarly for all available helpers. [Go to Basics guide to learn them](https://codecept.io/basics#writing-tests).
+> ▶ Actions like `amOnPage`, `click`, `fillField` are not limited to WebDriver only. They work similarly for all available helpers. [Go to Basics guide to learn them](/basics#writing-tests).
 
 
 An empty test case can be created with `codeceptjs gt` command.
@@ -177,7 +179,7 @@ An empty test case can be created with `codeceptjs gt` command.
 npx codeceptjs gt
 ```
 
-It's easy to start writing a test if you use [interactive pause](https://codecept.io/basics#debug). Just open a web page and pause execution.
+It's easy to start writing a test if you use [interactive pause](/basics#debug). Just open a web page and pause execution.
 
 ```js
 Feature('Sample Test');
@@ -198,7 +200,7 @@ npx codeceptjs run --steps
 
 After a page is opened a full control of a browser is given to a terminal. Type in different commands such as `click`, `see`, `fillField` to write the test. A successful commands will be saved to `./output/cli-history` file and can be copied into a test.
 
-> ℹ  All actions are listed in [WebDriver helper reference](https://codecept.io/helpers/WebDriver).
+> ℹ  All actions are listed in [WebDriver helper reference](/helpers/WebDriver).
 
 An interactive shell output may look like this:
 
@@ -301,7 +303,7 @@ Usage example:
 I.click('#click-me');
 ```
 
-If it's hard to define what to wait, it is recommended to use [retries](https://codecept.io/basics/#retries) to rerun flaky steps.
+If it's hard to define what to wait, it is recommended to use [retries](/basics/#retries) to rerun flaky steps.
 
 ## Configuring CI
 
@@ -310,8 +312,8 @@ To develop tests it's fine to use local Selenium Server and window mode. Setting
 There are following options available:
 
 * Use headless Chrome or Firefox.
-* Use [Selenoid](https://codecept.io/helpers/WebDriver#selenoid-options) to run browsers inside Docker containers.
-* Use paid [cloud services (SauceLabs, BrowserStack, TestingBot)](https://codecept.io/helpers/WebDriver#cloud-providers).
+* Use [Selenoid](/helpers/WebDriver#selenoid-options) to run browsers inside Docker containers.
+* Use paid [cloud services (SauceLabs, BrowserStack, TestingBot)](/helpers/WebDriver#cloud-providers).
 
 ### Aerokube Cloud Browsers
 
@@ -360,7 +362,7 @@ npx codeceptjs run --plugins aerokube
 
 ## Auto Login
 
-To share the same user session across different tests CodeceptJS provides [autoLogin plugin](https://codecept.io/plugins#autologin). It simplifies login management and reduces time consuming login operations. Instead of filling in login form before each test it saves the cookies of a valid user session and reuses it for next tests. If a session expires or doesn't exist, logs in a user again.
+To share the same user session across different tests CodeceptJS provides [autoLogin plugin](/plugins#autologin). It simplifies login management and reduces time consuming login operations. Instead of filling in login form before each test it saves the cookies of a valid user session and reuses it for next tests. If a session expires or doesn't exist, logs in a user again.
 
 This plugin requires some configuration but is very simple in use:
 
@@ -373,7 +375,7 @@ Scenario('do something with logged in user', (I, login)) => {
 
 With `autoLogin` plugin you can save cookies into a file and reuse same session on different runs.
 
-> [▶ How to set up autoLogin plugin](https://codecept.io/plugins#autologin)
+> [▶ How to set up autoLogin plugin](/plugins#autologin)
 
 
 ## Multiple Windows
@@ -426,7 +428,7 @@ This is useful when you want to isolate application testing from a backend. For
 
   > **WebDriver has limited ability to mock requests**, so you can only mock only requests performed after page is loaded. This means that you can't block Google Analytics, or CDN calls, but you can mock API requests performed on user action.
 
-To mock requests enable additional helper [MockRequest](https://codecept.io/helpers/MockRequest) (which is based on Polly.js).
+To mock requests enable additional helper [MockRequest](/helpers/MockRequest) (which is based on Polly.js).
 
 ```js
 helpers: {
@@ -461,7 +463,7 @@ I.click('Go to Next Page');
 // in WebDriver as we can't detect that the page was reloaded, so no mocking :(
 ```
 
-> See [`mockRequest` API](https://codecept.io/helpers/MockRequest#mockrequest)
+> See [`mockRequest` API](/helpers/MockRequest#mockrequest)
 
 To see `mockRequest` method in intellisense auto completion don't forget to run `codeceptjs def` command:
 
@@ -495,7 +497,7 @@ exports.config = {
 }
 ```
 
-> ℹ  See [Custom Helper](https://codecept.io/helpers) guide to see more examples.
+> ℹ  See [Custom Helper](/helpers) guide to see more examples.
 
 While implementing custom actions using WebDriver API please note that, there is two versions of protocol: WebDriver and JSON Wire. Depending on a browser version one of those protocols can be used. We can't know for sure which protocol is going to used, so we will need to implement an action using both APIs.
 
@@ -540,7 +542,7 @@ class Web extends Helper {
 }
 ```
 
-When a helper is created, regenerate your step definitions, so you could see those actions when using [intellisense](https://codecept.io/basics#intellisense):
+When a helper is created, regenerate your step definitions, so you could see those actions when using [intellisense](/basics#intellisense):
 
 ```
 npx codeceptjs def

package/docs/wiki/.git/FETCH_HEAD

@@ -0,0 +1 @@
+4753181844fc4dc563cf3aa5e80462243cb58d38		branch 'master' of github.com:Codeception/CodeceptJS.wiki

package/docs/wiki/.git/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

package/docs/wiki/.git/ORIG_HEAD

@@ -0,0 +1 @@
+c99f3e4bd227d6b050b2e416f9876df49583dbf6

package/docs/wiki/.git/config

@@ -0,0 +1,11 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+[remote "origin"]
+	url = git@github.com:Codeception/CodeceptJS.wiki.git
+	fetch = +refs/heads/*:refs/remotes/origin/*
+[branch "master"]
+	remote = origin
+	merge = refs/heads/master

package/docs/wiki/.git/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

package/docs/wiki/.git/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
+test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
+:

package/docs/wiki/.git/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

package/docs/wiki/.git/hooks/fsmonitor-watchman.sample

@@ -0,0 +1,114 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use IPC::Open2;
+
+# An example hook script to integrate Watchman
+# (https://facebook.github.io/watchman/) with git to speed up detecting
+# new and modified files.
+#
+# The hook is passed a version (currently 1) and a time in nanoseconds
+# formatted as a string and outputs to stdout all files that have been
+# modified since the given time. Paths must be relative to the root of
+# the working tree and separated by a single NUL.
+#
+# To enable this hook, rename this file to "query-watchman" and set
+# 'git config core.fsmonitor .git/hooks/query-watchman'
+#
+my ($version, $time) = @ARGV;
+
+# Check the hook interface version
+
+if ($version == 1) {
+	# convert nanoseconds to seconds
+	$time = int $time / 1000000000;
+} else {
+	die "Unsupported query-fsmonitor hook version '$version'.\n" .
+	    "Falling back to scanning...\n";
+}
+
+my $git_work_tree;
+if ($^O =~ 'msys' || $^O =~ 'cygwin') {
+	$git_work_tree = Win32::GetCwd();
+	$git_work_tree =~ tr/\\/\//;
+} else {
+	require Cwd;
+	$git_work_tree = Cwd::cwd();
+}
+
+my $retry = 1;
+
+launch_watchman();
+
+sub launch_watchman {
+
+	my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
+	    or die "open2() failed: $!\n" .
+	    "Falling back to scanning...\n";
+
+	# In the query expression below we're asking for names of files that
+	# changed since $time but were not transient (ie created after
+	# $time but no longer exist).
+	#
+	# To accomplish this, we're using the "since" generator to use the
+	# recency index to select candidate nodes and "fields" to limit the
+	# output to file names only. Then we're using the "expression" term to
+	# further constrain the results.
+	#
+	# The category of transient files that we want to ignore will have a
+	# creation clock (cclock) newer than $time_t value and will also not
+	# currently exist.
+
+	my $query = <<"	END";
+		["query", "$git_work_tree", {
+			"since": $time,
+			"fields": ["name"],
+			"expression": ["not", ["allof", ["since", $time, "cclock"], ["not", "exists"]]]
+		}]
+	END
+
+	print CHLD_IN $query;
+	close CHLD_IN;
+	my $response = do {local $/; <CHLD_OUT>};
+
+	die "Watchman: command returned no output.\n" .
+	    "Falling back to scanning...\n" if $response eq "";
+	die "Watchman: command returned invalid output: $response\n" .
+	    "Falling back to scanning...\n" unless $response =~ /^\{/;
+
+	my $json_pkg;
+	eval {
+		require JSON::XS;
+		$json_pkg = "JSON::XS";
+		1;
+	} or do {
+		require JSON::PP;
+		$json_pkg = "JSON::PP";
+	};
+
+	my $o = $json_pkg->new->utf8->decode($response);
+
+	if ($retry > 0 and $o->{error} and $o->{error} =~ m/unable to resolve root .* directory (.*) is not watched/) {
+		print STDERR "Adding '$git_work_tree' to watchman's watch list.\n";
+		$retry--;
+		qx/watchman watch "$git_work_tree"/;
+		die "Failed to make watchman watch '$git_work_tree'.\n" .
+		    "Falling back to scanning...\n" if $? != 0;
+
+		# Watchman will always return all files on the first query so
+		# return the fast "everything is dirty" flag to git and do the
+		# Watchman query just to get it over with now so we won't pay
+		# the cost in git to look up each individual file.
+		print "/\0";
+		eval { launch_watchman() };
+		exit 0;
+	}
+
+	die "Watchman: $o->{error}.\n" .
+	    "Falling back to scanning...\n" if $o->{error};
+
+	binmode STDOUT, ":utf8";
+	local $, = "\0";
+	print @{$o->{files}};
+}

package/docs/wiki/.git/hooks/post-update.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script to prepare a packed repository for use over
+# dumb transports.
+#
+# To enable this hook, rename this file to "post-update".
+
+exec git update-server-info

package/docs/wiki/.git/hooks/pre-applypatch.sample

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed
+# by applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-applypatch".
+
+. git-sh-setup
+precommit="$(git rev-parse --git-path hooks/pre-commit)"
+test -x "$precommit" && exec "$precommit" ${1+"$@"}
+: