Участие в разработке¶

Окружение¶

git clone https://github.com/Trum-ok/normik.git
cd normik
uv sync

Внутри клона команда запускается через uv run:

uv run nk check chapters

Проверки¶

make check      # ruff, ty, pytest
make lint       # только линтеры и проверка типов
make test       # только тесты
make format     # автоформатирование
make coverage   # покрытие: сводка в терминал, подробности в htmlcov/index.html

Документация¶

Исходники сайта — в каталоге docs/. Каталог docs/rules/ генерируется командой uv run nk rules docs и руками не редактируется.

make docs       # перегенерировать правила и собрать сайт
make docs-serve # локальный просмотр на http://127.0.0.1:8000

Новое правило¶

Правило — это один файл в src/nk/rules/ и один каталог в tests/fixtures/. Рецепт, полный пример, требования к тексту находки и правка для --fix — в руководстве Как добавить правило.