docs: Обновлена документация по возможностям отладки by Kyrales · Pull Request #56 · bia-technologies/precommit4onec

Kyrales · 2025-11-09T20:21:47Z

Добавлена крайне нужна информация по возможностям настройки отладки тестов с деталями.
Не все знают как работать с тестами Oscript

Summary by CodeRabbit

Документация
- Добавлена подробная инструкция по отладке сценариев обработок и тестов: установка и запуск тестового раннера, запуск всех или выбранных тестов, отладка через VSCode, требования к позитивному/негативному покрытию, проверки конфигурации и исходников, рекомендации по организации тестовых файлов и фикстур.
- Обновлён README: добавлен раздел с навигационной ссылкой на новую страницу документации для быстрого доступа.

coderabbitai · 2025-11-09T20:51:55Z

Walkthrough

Добавлена новая документация по отладке сценариев обработок и тестов и ссылка на неё в README.md; включены инструкции по установке 1testrunner, команды запуска тестов, пример launch.json для VSCode и рекомендации по структуре тестов и фикстур.

Changes

Cohort / File(s)	Описание изменений
README: ссылка на новую документацию `README.md`	Добавлена подсекция "Отладка сценариев обработок и тестов" с ссылкой на новый документ `docs/ОтладкаСценариев.md`.
Новая документация `docs/ОтладкаСценариев.md`	Добавлен новый файл с инструкциями: установка 1testrunner, команды для запуска всех/конкретных тестов, руководство по созданию тестов и фикстур, требования к покрытию, и пример `launch.json` для отладки в VSCode (включая пример конфигурации для Windows).

Sequence Diagram(s)

Не применимо — изменения затрагивают только документацию, контрольный поток или новые runtime-компоненты не вводятся.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Документационные изменения в двух файлах.
Обратить внимание на корректность ссылок, примеров команд и JSON-конфигурации (launch.json) в docs/ОтладкаСценариев.md.

Poem

🐰 В ветвях страниц шуршит листок,

Я прячу тест и включаю ток.
Фикстуры ждут, отладка светит,
Прыжок — и тест уже победит,
В поле кода радостный сток.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	Название в полной мере соответствует основному изменению — добавлена новая документация по отладке, что отражает суть PR.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a25bde7 and 3ca7a45.

📒 Files selected for processing (1)

docs/ОтладкаСценариев.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

docs/ОтладкаСценариев.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b1e4489 and 7b0e5b8.

📒 Files selected for processing (2)

README.md (1 hunks)
docs/ОтладкаСценариев.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/ОтладкаСценариев.md

[uncategorized] ~10-~10: Пропущена запятая в сложном предложении: «как до, так и»
Context: ...дятся все тесты. Не должно быть ошибок, как до так и после разработки сценариев. Запуск все...

(Kak_Tak_i)

🔇 Additional comments (3)

README.md (1)

138-140: Добавление ссылки на документацию по отладке выполнено корректно.

Новая ссылка на документацию по отладке сценариев логично размещена в разделе "Расширение функциональности" и соответствует формату других ссылок на документацию в файле.

docs/ОтладкаСценариев.md (2)

1-9: Введение и инструкция по установке оформлены хорошо.

Вводное предложение мотивирует разработчика, а инструкция по установке 1testrunner ясна и формально корректна.

53-56: Рекомендации по покрытию тестами и организации fixtures практичны и полезны.

Указания по позитивному/негативному покрытию сценариев и рекомендация хранить заготовки входных данных в папке tests\fixtures соответствуют лучшим практикам модульного тестирования.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (1)

docs/ОтладкаСценариев.md (1)
29-51: Исправьте путь к 1testrunner в конфигурации launch.json.

Этот вопрос был уже отмечен в предыдущих отзывах. Путь на строке 41 некорректен и не будет работать для большинства пользователей. Согласно документации OneScript, 1testrunner распространяется как пакет opm (OneScript Package Manager), а не как отдельное приложение в Program Files.

Правильные пути обычно находятся в:

<директория установки OneScript>/lib/packages/1testrunner/...

или в директории пакетов текущего пользователя (в зависимости от конфигурации opm)

Рекомендуемое решение: Добавьте инструкцию для пользователей по определению корректного пути. Например:
 4. Для успешной отладки должен быть установлен набор расширений: 1C (BSL) Extension Pack. Чтобы запускать и отлаживать правила-сценарии обработок через 1testrunner, требуется настроить launch.json в vscode (пример ниже). 
+
+**Примечание:** Путь к 1testrunner зависит от способа установки. Чтобы найти корректный путь, выполните:
+```bash
+opm help 1testrunner
+```
+или проверьте конфигурацию в `opm.cfg`.
Затем обновите пример:
-            "program": "c:\\Program Files\\OneScript\\lib\\1testrunner\\src\\main.os",
+            "program": "<путь к установленному пакету 1testrunner>\\src\\main.os",

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b0e5b8 and 4eee99d.

📒 Files selected for processing (1)

docs/ОтладкаСценариев.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/ОтладкаСценариев.md

7-7: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

13-13: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

18-18: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

23-23: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

theshadowco · 2025-11-11T02:06:23Z

@Kyrales Обнови свою ветку, она отстает от develop сильно

Kyrales · 2025-11-11T14:20:16Z

@Kyrales Обнови свою ветку, она отстает от develop сильно

@theshadowco актуализировал ветку

theshadowco · 2025-11-12T08:25:16Z

@Kyrales
Фиксы когда ждать?

Kyrales · 2025-11-12T09:25:55Z

@Kyrales Фиксы когда ждать?

@theshadowco исправил все замечания, кроме пути в program (т.к. решения не найдено как проще и универсальней задать и чтобы везде работало)

docs: Обновлена документация по возможностям отладки

7b0e5b8

coderabbitai Bot reviewed Nov 9, 2025

View reviewed changes

Comment thread docs/ОтладкаСценариев.md Outdated

Comment thread docs/ОтладкаСценариев.md Outdated

Update docs/ОтладкаСценариев.md

4eee99d

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai Bot reviewed Nov 10, 2025

View reviewed changes

Comment thread docs/ОтладкаСценариев.md Outdated

theshadowco force-pushed the develop branch from b1e4489 to 63f7e36 Compare November 11, 2025 01:46

theshadowco reviewed Nov 11, 2025

View reviewed changes

Comment thread docs/ОтладкаСценариев.md Outdated

Comment thread docs/ОтладкаСценариев.md Outdated

theshadowco reviewed Nov 11, 2025

View reviewed changes

Comment thread docs/ОтладкаСценариев.md Outdated

Comment thread docs/ОтладкаСценариев.md Outdated

Comment thread docs/ОтладкаСценариев.md Outdated

Merge branch 'develop' into feature/doc_debug

4d53702

Исправлено по замечания при код-ревью

a25bde7

Дополнение

3ca7a45

theshadowco merged commit 39c325c into bia-technologies:develop Nov 12, 2025
1 check passed

Conversation

Kyrales commented Nov 9, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Nov 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theshadowco commented Nov 11, 2025

Uh oh!

Kyrales commented Nov 11, 2025

Uh oh!

theshadowco commented Nov 12, 2025

Uh oh!

Kyrales commented Nov 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Kyrales commented Nov 9, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Nov 9, 2025 •

edited

Loading