From 167247377c393de59340fe4e33324642389b6af8 Mon Sep 17 00:00:00 2001 From: sipayrt Date: Wed, 27 Nov 2024 18:11:11 +0300 Subject: [PATCH] fix: fix typos --- docs/reference/testplane-events.mdx | 41 +++++++---- .../current/reference/testplane-events.mdx | 69 ++++++++++--------- 2 files changed, 64 insertions(+), 46 deletions(-) diff --git a/docs/reference/testplane-events.mdx b/docs/reference/testplane-events.mdx index 3265750..bf71c75 100644 --- a/docs/reference/testplane-events.mdx +++ b/docs/reference/testplane-events.mdx @@ -272,14 +272,27 @@ Or as follows: see the [example](#new_worker_process_usage) from the description The test runner has a `registerWorkers` method which registers the plugin code for parallel execution in the Testplane workers. The method takes the following parameters: - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
**Parameter****Type****Description**
workerFilepathStringAbsolute path to the worker.
exportedMethodsString[]List of exported methods.
**Parameter****Type****Description**
workerFilepathStringAbsolute path to the worker.
exportedMethodsString[]List of exported methods.
It returns an object which contains asynchronous functions with names from exported methods. @@ -421,13 +434,13 @@ Click to see the code ```javascript -const http = require('http'); -const parseConfig = require('./config'); +const http = require("http"); +const parseConfig = require("./config"); module.exports = (testplane, opts) => { const pluginConfig = parseConfig(opts); - if (!pluginConfig.enabled testplane.isWorker()) { + if (!pluginConfig.enabled || testplane.isWorker()) { // either the plugin is disabled, or we are in the worker context – exit return; } @@ -436,12 +449,10 @@ module.exports = (testplane, opts) => { testplane.on(testplane.events.INIT, () => { // content served by the dev-server - const content = '

Hello, World!

'; + const content = "

Hello, World!

"; // create a server and start listening on port 3000 - http - .createServer((req, res) => res.end(content)) - .listen(3000); + http.createServer((req, res) => res.end(content)).listen(3000); // at http://localhost:3000/index.html it will serve:

Hello, World!

}); diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx index 72f6c1e..c65da24 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx +++ b/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx @@ -273,14 +273,25 @@ module.exports = (testplane, opts) => { У раннера тестов есть метод `registerWorkers`, который регистрирует код плагина для параллельного выполнения в воркерах testplane. Метод принимает следующие параметры: - - - - - - - - + + + + + + + + + + + + + + + + + + +
**Параметр****Тип****Описание**
workerFilepathStringАбсолютный путь к воркеру.
exportedMethodsString[]Список экспортируемых методов.
>**Параметр****Тип****Описание**
>workerFilepathStringАбсолютный путь к воркеру.
>exportedMethodsString[]Список экспортируемых методов.
При этом возвращает объект, который содержит асинхронные функции с именами из экспортированных методов. @@ -360,22 +371,22 @@ testplane.on(testplane.events.CLI, cli => { ```javascript -const parseConfig = require('./config'); +const parseConfig = require("./config"); module.exports = (testplane, opts) => { const pluginConfig = parseConfig(opts); - if (!pluginConfig.enabled testplane.isWorker()) { + if (!pluginConfig.enabled || testplane.isWorker()) { // или плагин отключен, или мы находимся в контексте воркера – уходим return; } - testplane.on(testplane.events.CLI, (cli) => { + testplane.on(testplane.events.CLI, cli => { // добавляем опцию --repeat cli.option( - '--repeat ', - 'how many times tests should be repeated regardless of the result', - (value) => parseNonNegativeInteger(value, 'repeat') + "--repeat ", + "how many times tests should be repeated regardless of the result", + value => parseNonNegativeInteger(value, "repeat"), ); }); @@ -422,13 +433,13 @@ testplane.on(testplane.events.INIT, async () => { ```javascript -const http = require('http'); -const parseConfig = require('./config'); +const http = require("http"); +const parseConfig = require("./config"); module.exports = (testplane, opts) => { const pluginConfig = parseConfig(opts); - if (!pluginConfig.enabled testplane.isWorker()) { + if (!pluginConfig.enabled || testplane.isWorker()) { // или плагин отключен, или мы находимся в контексте воркера – уходим return; } @@ -437,12 +448,10 @@ module.exports = (testplane, opts) => { testplane.on(testplane.events.INIT, () => { // контент, который отдает dev-сервер - const content = '

Hello, World!

'; + const content = "

Hello, World!

"; // создаем сервер и начинаем слушать порт 3000 - http - .createServer((req, res) => res.end(content)) - .listen(3000); + http.createServer((req, res) => res.end(content)).listen(3000); // по адресу http://localhost:3000/index.html будет отдаваться:

Hello, World!

}); @@ -1495,32 +1504,32 @@ module.exports = (testplane, opts) => { **Код плагина** ```javascript -const http = require('http'); -const parseConfig = require('./config'); +const http = require("http"); +const parseConfig = require("./config"); module.exports = (testplane, opts) => { const pluginConfig = parseConfig(opts); - if (!pluginConfig.enabled testplane.isWorker()) { + if (!pluginConfig.enabled || testplane.isWorker()) { // или плагин отключен, или мы находимся в контексте воркера – уходим return; } let program; - testplane.on(testplane.events.CLI, (cli) => { + testplane.on(testplane.events.CLI, cli => { // нужно сохранить ссылку на инстанс commander'а (https://github.com/tj/commander.js), // чтобы потом проверить наличие опции program = cli; // добавляем к testplane опцию --dev-server, // чтобы пользователь мог явно указывать, когда надо запустить dev-сервер - cli.option('--dev-server', 'run dev-server'); + cli.option("--dev-server", "run dev-server"); }); testplane.on(testplane.events.INIT, () => { // dev-сервер может быть запущен как через указание опции --dev-server // при запуске testplane, так и в настройках плагина - const devServer = program && program.devServer pluginConfig.devServer; + const devServer = (program && program.devServer) || pluginConfig.devServer; if (!devServer) { // если dev-сервер запускать не нужно – уходим @@ -1528,12 +1537,10 @@ module.exports = (testplane, opts) => { } // контент, который отдает dev-сервер - const content = '

Hello, World!

'; + const content = "

Hello, World!

"; // создаем сервер и начинаем слушать порт 3000 - http - .createServer((req, res) => res.end(content)) - .listen(3000); + http.createServer((req, res) => res.end(content)).listen(3000); // по адресу http://localhost:3000/index.html будет отдаваться:

Hello, World!

});