<commit_before>#  Мануал початківця wTools
***
## Зміст
1. [Репозиторій](#repository)
2. [Клонування репозиторію](#repository-cloning)
3. [Встановлення пакету](#package-installation)
4. [Способи запуска тестів](#way-of-test-running)
5. [Кількість вихідної інформації](#verbosity)
6. [Підказка по параметрам скрипта](#getting-parameters-help)
7. [Опції тестера](#tester-options)
8. [Структурні одиниці тестування](#testing-structure-units)
9. [Розташуванння окремих тест рутин та їх реалізацій](#test-routines-location)

<a name="repository"/>

## Репозиторій
***
Репозіторій розташовано за адресою  [https://github.com/Wandalen/wTools](https://github.com/Wandalen/wTools)

<a name="repository-cloning"/>

## Клонування репозиторію
***
Для клонування репозіторію використовувати команду `git clone https://github.com/Wandalen/wTools.git`

<a name="package-installation"/>

## Встановлення пакету
***
Для встановлення пакету глобально використовуйте
`npm install`
`npm install -g wTesting`
відповідно перейшовши в директорію (теку) проекту

<a name="way-of-test-running"/>

## Способи запуска тестів
***
 Існують три способа запуска тестів з наступними командами

|N п/п      | Спосіб запуску                                              | Команда                                              |
|:----------|:------------------------------------------------------------|:-----------------------------------------------------|
|[1](#1)    | Безпосередньо через npm                                     | `npm test`                                           |
|[2.1](#2.1)| Альтернативний спосіб запуску                               | `wtest staging`                                      |
|[2.2](#2.2)| Альтернативний спосіб запуску використовуючи файл тест сюіта| `wtest staging/dwtools/abase/layer1.test/Map.test.s` |
|[3](#3)    | Використовуючи файл тест сюіта                              | `node staging/dwtools/abase/layer1.test/Map.test.s`  |

Экран терміналу вищовказаних команд в операційній системі Linux буде виглядати наступним образом:

<a name="1"/>

![Результат команди 1](./img/1.png)

<a name="2.11"/>

![Результат команди 2.1](./img/2.1.png)

<a name="2.2"/>

![Результат команди 2.2](./img/2.2.png)

<a name="3"/>

![Результат команди 3](./img/3.png)

<a name="verbosity"/>

## Кількість вихідної інформації
***

Кількість інформації, яка буде видаватися скриптом, можно регулювати наступним чином:
використовуючи параметр `verbosity`, який регулює багатослівність.

| Параметр      | Кількість отриманої інформації |
|:--------------|:-------------------------------|
| verbosity:0   | Жодної інформації              |
| verbosity:1   | Один рядок                     |
| verbosity:2   | Багато рядків                  |
| verbosity:9   | Максимум                       |

Наприклад: `wtest staging verbosity:2`

<a name="getting-parameters-help"/>

## Підказка по параметрам скрипта
***
 Для отримання підказки по параметрам використовуйте 
 `wtest staging scenario:help`

| Сценарії      | Виконувана дія                            |
|:--------------|:------------------------------------------|
| test          | Запустити тести, сценарій за замовчуванням|
| help          | Отримати допомогу                         |<commit_msg>Fixed junior introduction<commit_after>#  Мануал початківця wTools
***
## Зміст
1. [Репозиторій](#repository)
2. [Клонування репозиторію](#repository-cloning)
3. [Встановлення пакету](#package-installation)
4. [Способи запуска тестів](#way-of-test-running)
5. [Кількість вихідної інформації](#verbosity)
6. [Підказка по параметрам скрипта](#getting-parameters-help)
7. [Опції тестера](#tester-options)
8. [Структурні одиниці тестування](#testing-structure-units)
9. [Розташуванння окремих тест рутин та їх реалізацій](#test-routines-location)

<a name="repository"/>

## Репозиторій
***
Репозіторій розташовано за адресою  [https://github.com/Wandalen/wTools](https://github.com/Wandalen/wTools)

<a name="repository-cloning"/>

## Клонування репозиторію
***
Для клонування репозіторію використовувати команду `git clone https://github.com/Wandalen/wTools.git`

<a name="package-installation"/>

## Встановлення пакету
***
Для встановлення пакету глобально використовуйте
`npm install`
`npm install -g wTesting`
відповідно перейшовши в директорію (теку) проекту

<a name="way-of-test-running"/>

## Способи запуска тестів
***
 Існують три способа запуска тестів з наступними командами

|N п/п      | Спосіб запуску                                              | Команда                                              |
|:----------|:------------------------------------------------------------|:-----------------------------------------------------|
|[1](#1)    | Безпосередньо через npm                                     | `npm test`                                           |
|[2.1](#2.1)| Альтернативний спосіб запуску                               | `wtest staging`                                      |
|[2.2](#2.2)| Альтернативний спосіб запуску використовуючи файл тест сюіта| `wtest staging/dwtools/abase/layer1.test/Map.test.s` |
|[3](#3)    | Використовуючи файл тест сюіта                              | `node staging/dwtools/abase/layer1.test/Map.test.s`  |

Экран терміналу вищовказаних команд в операційній системі Linux буде виглядати наступним образом:

<a name="1"/>

![Результат команди 1](./reference/img/1.png)

<a name="2.1"/>

![Результат команди 2.1](./reference/img/2.1.png)

<a name="2.2"/>

![Результат команди 2.2](./reference/img/2.2.png)

<a name="3"/>

![Результат команди 3](./reference/img/3.png)

<a name="verbosity"/>

## Кількість вихідної інформації
***

Кількість інформації, яка буде видаватися скриптом, можно регулювати наступним чином:
використовуючи параметр `verbosity`, який регулює багатослівність.

| Параметр      | Кількість отриманої інформації |
|:--------------|:-------------------------------|
| verbosity:0   | Жодної інформації              |
| verbosity:1   | Один рядок                     |
| verbosity:2   | Багато рядків                  |
| verbosity:9   | Максимум                       |

Наприклад: `wtest staging verbosity:2`

<a name="getting-parameters-help"/>

## Підказка по параметрам скрипта
***
 Для отримання підказки по параметрам використовуйте 
 `wtest staging scenario:help`

| Сценарії      | Виконувана дія                            |
|:--------------|:------------------------------------------|
| test          | Запустити тести, сценарій за замовчуванням|
| help          | Отримати допомогу                         |
{'fraction_non_alphanumeric': 0.18312223409125591, 'fraction_numerical': 0.014191973142072333, 'mean_word_length': 2.0611863615133115, 'pattern_counts': {'":': 0, '<': 23, '<?xml version=': 0, '>': 23, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 19, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1051190', 'n_tokens_mistral': 2326, 'n_tokens_neox': 2742, 'n_words': 458}