Update changelog and module documentation

Naktibalda · Naktibalda · commit 546fce20f3d3 · 2021-03-28T16:38:02.000+03:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -8,6 +8,15 @@ title: Codeception Changelog
 # Changelog
 
 
+#### 4.1.19
+
+* Action file generator supports PHP 8 union types
+* Action file generator generates typehints for method parameters
+* Removed dead code related to DataProviderTestSuite
+* Removed documentation related to Cept format
+* Deprecated generate:cept command
+* Documentation improvements
+
 #### 4.1.18
 
 * Fix cleanup of included test directories [#6117](https://github.com/Codeception/Codeception/issues/6117) by **[rolandsaven](https://github.com/rolandsaven)**
diff --git a/docs/modules/DataFactory.md b/docs/modules/DataFactory.md
@@ -154,6 +154,40 @@ In case your ORM expects a related record itself (Doctrine) then you should use
 
 {% endhighlight %}
 
+#### Custom store
+
+You can define a custom store for Factory Muffin using `customStore` parameter. It can be a simple class or a factory with `create` method.
+The instantiated object must implement `\League\FactoryMuffin\Stores\StoreInterface`.
+
+Store factory example:
+{% highlight yaml %}
+
+modules:
+    enabled:
+        - DataFactory:
+            customStore: \common\tests\store\MyCustomStoreFactory
+
+{% endhighlight %}
+
+{% highlight php %}
+
+use League\FactoryMuffin\Stores\StoreInterface;
+
+class MyCustomStoreFactory
+{
+    public function create(): StoreInterface
+    {
+        return CustomStore();
+    }
+}
+
+class CustomStore implements StoreInterface
+{
+    // ...
+}
+
+{% endhighlight %}
+
 ### Actions
 
 #### have
diff --git a/docs/modules/Laminas.md b/docs/modules/Laminas.md
@@ -625,7 +625,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/Laravel.md b/docs/modules/Laravel.md
@@ -851,7 +851,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/Lumen.md b/docs/modules/Lumen.md
@@ -651,7 +651,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/Mezzio.md b/docs/modules/Mezzio.md
@@ -576,7 +576,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/Phalcon.md b/docs/modules/Phalcon.md
@@ -682,7 +682,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/Phalcon4.md b/docs/modules/Phalcon4.md
@@ -675,7 +675,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/PhpBrowser.md b/docs/modules/PhpBrowser.md
@@ -677,7 +677,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/Symfony.md b/docs/modules/Symfony.md
@@ -780,7 +780,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -1155,7 +1155,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md
@@ -770,7 +770,7 @@ Fills a text field or textarea with the given string.
 
 <?php
 $I->fillField("//input[@type='text']", "Hello World!");
-$I->fillField(['name' => 'email'], 'jon@mail.com');
+$I->fillField(['name' => 'email'], 'jon@example.com');
 ?>
 
 {% endhighlight %}
diff --git a/docs/reference/Commands.md b/docs/reference/Commands.md
@@ -7,12 +7,7 @@ title: Commands - Codeception - Documentation
 
 ## GenerateCept
 
-Generates Cept (scenario-driven test) file:
-
-* `codecept generate:cept suite Login`
-* `codecept g:cept suite subdir/subdir/testnameCept.php`
-* `codecept g:cept suite LoginCept -c path/to/project`
-
+@deprecated
 
 
 
@@ -97,8 +92,8 @@ Executes tests.
 Usage:
 
 * `codecept run acceptance`: run all acceptance tests
-* `codecept run tests/acceptance/MyCept.php`: run only MyCept
-* `codecept run acceptance MyCept`: same as above
+* `codecept run tests/acceptance/MyCest.php`: run only MyCest
+* `codecept run acceptance MyCest`: same as above
 * `codecept run acceptance MyCest:myTestInIt`: run one test from a Cest
 * `codecept run acceptance checkout.feature`: run feature-file
 * `codecept run acceptance -g slow`: run tests from *slow* group
@@ -108,9 +103,9 @@ Verbosity modes:
 
 * `codecept run -v`:
 * `codecept run --steps`: print step-by-step execution
-* `codecept run -vv`:
-* `codecept run --debug`: print steps and debug information
-* `codecept run -vvv`: print internal debug information
+* `codecept run -vv`: print steps and debug information
+* `codecept run --debug`: alias for `-vv`
+* `codecept run -vvv`: print Codeception-internal debug information
 
 Load config:
 
@@ -147,9 +142,9 @@ Options:
  --json                Generate Json Log (default: "report.json")
  --colors              Use colors in output
  --no-colors           Force no colors in output (useful to override config file)
- --silent              Only outputs suite names and final results
+ --silent              Only outputs suite names and final results. Almost the same as `--quiet`
  --steps               Show steps in output
- --debug (-d)          Show debug and scenario output
+ --debug (-d)          Alias for `-vv`
  --bootstrap           Execute bootstrap script before the test
  --coverage            Run with code coverage (default: "coverage.serialized")
  --coverage-html       Generate CodeCoverage HTML report in path (default: "coverage")
@@ -165,8 +160,8 @@ Options:
  --fail-fast (-f)      Stop after first failure
  --no-rebuild          Do not rebuild actor classes on start
  --help (-h)           Display this help message.
- --quiet (-q)          Do not output any message.
- --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+ --quiet (-q)          Do not output any message. Almost the same as `--silent`
+ --verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug
  --version (-V)        Display this application version.
  --ansi                Force ANSI output.
  --no-ansi             Disable ANSI output.
@@ -324,7 +319,7 @@ Creates empty GroupObject - extension which handles all group events.
 
 ## GenerateScenarios
 
-Generates user-friendly text scenarios from scenario-driven tests (Cest, Cept).
+Generates user-friendly text scenarios from scenario-driven tests (Cest).
 
 * `codecept g:scenarios acceptance` - for all acceptance tests
 * `codecept g:scenarios acceptance --format html` - in html format
