docs: add lastFailed config option (#21)

Author: Kabir-Ivan

docs/config/last-failed.mdx

@@ -0,0 +1,51 @@
+import Admonition from "@theme/Admonition";
+
+# lastFailed
+
+## Обзор {#overview}
+
+Раздел `lastFailed` в настройках Testplane не является обязательным.
+
+Используйте его, чтобы настроить перезапуск упавших тестов.
+
+## Настройка {#setup}
+
+Раздел `lastFailed` имеет следующий формат:
+
+```javascript
+module.exports = {
+    lastFailed: {
+        only: false,
+        input: [".testplane/failed.json"],
+        output: ".testplane/failed.json",
+    },
+
+    // другие настройки Testplane...
+};
+```
+
+### Расшифровка параметров конфигурации {#setup_description}
+
+<table>
+<thead>
+<tr><td>**Параметр**</td><td>**Тип**</td><td>**По&nbsp;умолчанию**</td><td>**Описание**</td></tr>
+</thead>
+<tbody>
+<tr><td>[only](#only)</td><td>Boolean</td><td>false</td><td>Включить / отключить режим перезапуска упавших тестов.</td></tr>
+<tr><td>[input](#input)</td><td>String или Array</td><td>.testplane/failed.json</td><td>Путь или список путей для чтения списка упавших тестов</td></tr>
+<tr><td>[output](#output)</td><td>String</td><td>.testplane/failed.json</td><td>Путь для сохранения списка упавших тестов</td></tr>
+
+</tbody>
+</table>
+
+### only {#only}
+
+Включает режим перезапуска упавших тестов, в котором запускаются только тесты из списка, путь к которому указан в input, если установить значение в `true`. По умолчанию: `false`.
+
+### input {#input}
+
+Путь или список путей для чтения списка упавших тестов. Если указан список путей к файлам, то перезапускаются все тесты, которые встречаются хотя бы в одном из них. По умолчанию: `.testplane/failed.json`
+
+### output {#output}
+
+Путь для сохранения списка упавших тестов. Используется всегда, независимо от опции `only`. По умолчанию: `.testplane/failed.json`

docs/config/main.mdx

@@ -54,6 +54,9 @@ module.exports = {
     plugins: {
         // подключение внешних плагинов Testplane...
     },
+    lastFailed: {
+        // настройки перезапуска упавших тестов...
+    },
     prepareBrowser: function(browser) {
         // здесь можно добавить новые команды к объекту browser,
         // где browser - это сессия WebdriverIO
@@ -84,6 +87,7 @@ module.exports = {
 <tr><td>[sets][sets]</td><td>Раздел, позволяющий привязать набор тестов к определенным браузерам и запускать их сразу одной командой. Может пригодиться, например, для отдельного запуска десктопных и мобильных тестов.</td></tr>
 <tr><td>[system][system]</td><td>Раздел системных настроек Testplane. Позволяет задать число подпроцессов, в которых будут запускаться тесты, включить режим дебага для WebDriver, и многое другое.</td></tr>
 <tr><td>[plugins][plugins]</td><td>Раздел, с помощью которого можно подключить к testplane внешние плагины.</td></tr>
+<tr><td>[lastFailed][last-failed]</td><td>Раздел, с помощью которого можно настроить перезапуск упавших тестов.</td></tr>
 <tr><td>[prepareBrowser][prepare-browser]</td><td>Функция, в которой можно подготовить браузер до того, как в нем будут запущены тесты. Например, в этой функции можно добавить новые команды для объекта _browser_.</td></tr>
 <tr><td>[prepareEnvironment][prepare-environment]</td><td>Функция, в которой можно задать переменные окружения или, например, дополнить какие-то параметры конфига.</td></tr>
 
@@ -102,5 +106,6 @@ module.exports = {
 [sets]: ../sets
 [system]: ../system
 [plugins]: ../plugins
+[last-failed]: ../last-failed
 [prepare-browser]: ../prepare-browser
 [prepare-environment]: ../prepare-environment

i18n/en/docusaurus-plugin-content-docs/current/config/last-failed.mdx

@@ -0,0 +1,52 @@
+javascript
+import Admonition from "@theme/Admonition";
+
+# lastFailed
+
+## Overview {#overview}
+
+The `lastFailed` section in Testplane settings is optional.
+
+Use it to configure the rerun of failed tests.
+
+## Setup {#setup}
+
+The `lastFailed` section has the following format:
+
+```javascript
+module.exports = {
+    lastFailed: {
+        only: false,
+        input: [".testplane/failed.json"],
+        output: ".testplane/failed.json",
+    },
+
+    // other Testplane settings...
+};
+```
+
+### Description of Configuration Parameters {#setup_description}
+
+<table>
+<thead>
+<tr><td>**Parameter**</td><td>**Type**</td><td>**Default&nbsp;value**</td><td>**Description**</td></tr>
+</thead>
+<tbody>
+<tr><td>[only](#only)</td><td>Boolean</td><td>false</td><td>Enable / disable the mode for rerunning failed tests.</td></tr>
+<tr><td>[input](#input)</td><td>String or Array</td><td>.testplane/failed.json</td><td>Path or list of paths for reading the list of failed tests.</td></tr>
+<tr><td>[output](#input)</td><td>String</td><td>.testplane/failed.json</td><td>Path for saving the list of failed tests.</td></tr>
+
+</tbody>
+</table>
+
+### only {#only}
+
+Enables the mode for rerunning failed tests, in which only the tests from the list specified in input are run if set to true. Default: `false`.
+
+### input {#input}
+
+Path or list of paths for reading the list of failed tests. If a list of file paths is specified, all tests that are found in at least one of them are rerun. Default: `.testplane/failed.json`
+
+### output {#output}
+
+Path for saving the list of failed tests. Always used regardless of the only option. Default: `.testplane/failed.json`

i18n/en/docusaurus-plugin-content-docs/current/config/main.mdx

@@ -54,6 +54,9 @@ module.exports = {
     plugins: {
         // external Testplane plugins settings...
     },
+    lastFailed: {
+        // failed tests rerun settings...
+    },
     prepareBrowser: function(browser) {
         // here you can add new commands to the browser object,
         // where browser is a WebdriverIO session
@@ -84,6 +87,7 @@ In order not to repeat common [settings of each browser][browsers] over and over
 <tr><td>[sets][sets]</td><td>A section that allows you to bind a set of tests to certain browsers and run them at once with one command. For example, you can launch desktop and mobiles tests separately by using this option.</td></tr>
 <tr><td>[system][system]</td><td>Testplane system settings section. Allows you to set the number of subprocesses to run the tests in, enable the debug mode for WebDriver, and much more.</td></tr>
 <tr><td>[plugins][plugins]</td><td>A section with which you can mount external plugins to Testplane.</td></tr>
+<tr><td>[lastFailed][last-failed]</td><td>A section with which you can configure the rerun of failed tests.</td></tr>
 <tr><td>[prepareBrowser][prepare-browser]</td><td>A function in which you can prepare the browser before to run the tests in it. For example, in this function you can add new commands for the _browser_ object.</td></tr>
 <tr><td>[prepareEnvironment][prepare-environment]</td><td>A function in which you can set environment variables or, for example, add some config parameters.</td></tr>
 
@@ -102,5 +106,6 @@ You can set your configuration file using the `--config` CLI option, specifying
 [sets]: ../sets
 [system]: ../system
 [plugins]: ../plugins
+[last-failed]: ../last-failed
 [prepare-browser]: ../prepare-browser
 [prepare-environment]: ../prepare-environment