Skip to content

ddovwll/loglint

Repository files navigation

loglint

loglint - модульный плагин для golangci-lint, который проверяет текст сообщений в логах log/slog и go.uber.org/zap.

Что проверяет

  • start-with-lowercase (по умолчанию: true) - сообщение должно начинаться с маленькой английской буквы.
  • eng-letters (по умолчанию: true) - в сообщении разрешены только английские буквы.
  • no-special-symbols (по умолчанию: true) - запрет специальных символов.
  • allowed-symbols (по умолчанию: пусто) - символы, которые разрешены дополнительно.
  • sensitive-keywords (по умолчанию: пусто) - список чувствительных слов (без учета регистра).
  • sensitive-patterns (по умолчанию: пусто) - список regex-паттернов для поиска чувствительных данных.

Установка

  1. Установите golangci-lint v2:
go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest
  1. Создайте файл .custom-gcl.yml рядом с проектом:
version: v2.9.0
plugins:
  - module: 'github.com/ddovwll/loglint'
    import: 'github.com/ddovwll/loglint/plugin'
    version: latest
  1. Соберите исполняемый файл:
golangci-lint custom

После этого появится файл custom-gcl

Использование

  1. Добавьте loglint в .golangci.yml вашего Go-проекта.
  2. Запускайте линтер через полученный исполняемый файл:
./custom-gcl run ./...

Запуск для применения автоисправлений

./custom-gcl run ./... --fix

Пример golangci конфига

Пример .golangci.yml с подключенным loglint в файле .golangci.example.yml

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors