normik

nk — линтер оформления отчёта о НИР по ГОСТ 7.32-2017 для исходников LaTeX.

Документация: https://trum-ok.github.io/normik/

Принимает .tex и выдаёт список нарушений с указанием пункта стандарта, файла и строки.

nk check report.tex

report.tex
  1:17  warning  G732-6.5.1-reference-word
    Нарушение: В ссылке на иллюстрацию использовано сокращение «рис.».
    Требуется: При ссылке пишут слово «рисунок» полностью и его номер.
    Исправить: Заменить «рис.» на «рисунок» в нужном падеже.
    > 1 | Как показано на рис.~\ref{fig:speed}, зависимость линейная.
        |                 ^
      2 | 
      3 | \begin{figure}[h]

  5:5  error  G732-6.5.7-caption-dot
    Нарушение: Наименование рисунка заканчивается точкой.
    Требуется: Наименование рисунка приводят с прописной буквы без точки в конце.
    Исправить: \caption{Зависимость скорости от нагрузки}
      3 | \begin{figure}[h]
      4 |     \includegraphics{plot.png}
    > 5 |     \caption{Зависимость скорости от нагрузки.}
      6 |     \label{fig:speed}
      7 | \end{figure}

Итого: 1 error, 1 warning, 0 info.
Исправимо машинно: 1 из 2. Применить: nk check report.tex --fix, посмотреть правки: --diff.
Машинный вывод: --format json, вывод для агента: --format agent

Установка

uv tool install normik

После этого команда nk доступна в системе. Разовый запуск без установки:

uvx --from normik nk check chapters

Для работы над самим линтером — клонировать репозиторий и выполнить uv sync; внутри клона команда запускается как uv run nk.

Примеры запуска

Проверить весь каталог с исходниками:

nk check chapters

Получить вывод, который можно скопировать в Claude Code без пояснений:

nk check chapters --format agent

Проверить по профилю кафедры, показывая только ошибки:

nk check report.tex --profile profiles/example-university.toml --severity error

Без ключа профиль ищется рядом с исходниками — nk.toml, .nk.toml или секция [tool.nk] в pyproject.toml.

Починить то, что чинится механически — сначала посмотреть, потом применить:

nk check chapters --diff
nk check chapters --fix

Включить линтер на готовой работе: зафиксировать текущие нарушения снимком и дальше видеть только новые:

nk check chapters --write-baseline .nk-baseline.json
nk check chapters --baseline .nk-baseline.json

Команды

Ключи check, коды возврата и форматы вывода — на странице Использование.

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

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

Разработка

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