Repolode
Предложить
yoheimuta

yoheimuta/protolint

Расширяемый линтер и автоисправитель, который проверяет соблюдение правил стиля Protocol Buffer без компилятора protoc.

Открыть на GitHub
Звёзды
697
Форки
65
Открытые issues
53
Последний коммит
15 дней назад

Что это?

protolint проверяет и исправляет файлы .proto для proto2 и proto3. Он разбирает файлы напрямую, не запуская компилятор protobuf, поэтому проверки выполняются быстро и не требуют полноценного окружения для компиляции. Большинство официальных правил стиля можно исправить с помощью флага -fix, а режим автоотключения добавляет комментарии-подавления вместо изменений, нарушающих совместимость API.

Правила можно отключать прямо в файле комментариями protolint:disable или настраивать через файл .protolint.yaml. Пользовательские правила линтинга можно подключать в виде плагинов. Результаты можно выводить в форматах для GitHub Actions, Azure DevOps, GitLab CI, JUnit, SARIF, SonarQube и других инструментов.

protolint можно запускать как отдельный CLI, плагин protoc, pre-commit hook, библиотеку Go, пакет npm или Python либо MCP-сервер для AI-клиентов.

Ключевые возможности

  • 01Проверяет файлы proto2 и proto3 без необходимости устанавливать protoc.
  • 02Автоматически исправляет большинство нарушений официального руководства по стилю с помощью -fix.
  • 03Режим автоотключения добавляет комментарии-подавления, сохраняя совместимость API.
  • 04Поддерживает комментарии для отключения правил и конфигурацию через .protolint.yaml.
  • 05Подключает пользовательские правила через систему плагинов.
  • 06Предоставляет форматы вывода для JUnit, SARIF, SonarQube, JSON и CI-систем.

Сценарии использования

  • Поддержание единых правил именования и отступов в protobuf-схемах команды.
  • Запуск проверок стиля в CI-пайплайнах или pre-commit hooks перед слиянием изменений.
  • Проверка protobuf-файлов в редакторах, например VS Code, IntelliJ или Vim.
  • Добавление правил линтинга для внутренних соглашений проекта об API.

Быстрый старт

  1. 1

    Установите protolint с помощью Homebrew

    brew install protolint
  2. 2

    Проверьте с помощью линтера все файлы .proto в текущем каталоге

    protolint lint .

Темы

#protobuf#linter#proto3#code-style#cli#golang#ci-cd#fixer#lint#plugin-architecture

Частые вопросы

Что такое protolint?
Расширяемый линтер и автоисправитель, который проверяет соблюдение правил стиля Protocol Buffer без компилятора protoc. protolint проверяет и исправляет файлы .proto для proto2 и proto3. Он разбирает файлы напрямую, не запуская компилятор protobuf, поэтому проверки выполняются быстро и не требуют полноценного окружения для компиляции. Большинство официальных правил стиля можно исправить с помощью флага -fix, а режим автоотключения добавляет комментарии-подавления вместо изменений, нарушающих совместимость API.
protolint можно использовать бесплатно? Какая у него лицензия?
protolint распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
protolint всё ещё поддерживается?
Активно поддерживается. Последний коммит в protolint — 7 окт. 2026 г..
Для чего можно использовать protolint?
Поддержание единых правил именования и отступов в protobuf-схемах команды. Запуск проверок стиля в CI-пайплайнах или pre-commit hooks перед слиянием изменений. Проверка protobuf-файлов в редакторах, например VS Code, IntelliJ или Vim. Добавление правил линтинга для внутренних соглашений проекта об API.
Как установить protolint?
Установите protolint с помощью Homebrew: brew install protolint Проверьте с помощью линтера все файлы .proto в текущем каталоге: protolint lint .
Где скачать protolint?
Исходный код и инструкции по установке — на GitHub: https://github.com/yoheimuta/protolint

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты