Конфиг линтера: tools.lint_config¶
По умолчанию генератор пишет configs/golangci-lint.yml целиком и перезаписывает его на
каждом make regenerate. Правила линтера при этом формируют вердикт merge-гейта, а
принадлежат они проекту: бывают слова, которые проект обязан писать так, как их задаёт
внешний контракт (cancelled как член enum — US-локаль misspell требует переименовать),
и линтеры, которые проекту нужно отложить или выключить.
Секция tools.lint_config даёт два способа это сделать. Они взаимоисключающие — указать
оба сразу ошибка конфига.
| Состояние | Что делает генератор |
|---|---|
| секции нет | Пишет весь файл, перезаписывает на каждом прогоне. Поведение по умолчанию |
own: true |
Файл не пишет вообще: он принадлежит проекту |
overrides: <URI> |
Пишет файл, но вливает в свой шаблон объявленное проектом |
configs/golangci-metrics.yml и цель make metrics-validate (гейт
карты метрик) генерируются независимо от этой секции — это отдельный
файл и отдельный гейт.
own: true — свой файл целиком¶
Генератор перестаёт считать configs/golangci-lint.yml своим: не пишет его, не читает, не
диффит и не удаляет. Файл переходит в тот же класс, что go.mod, .gitignore и
README.md — «сгенерировать один раз, дальше владеет проект».
Включение параметра в существующем проекте файл не теряет: он остаётся на диске таким,
каким был, и пропадает из манифеста .project-config/meta.yaml. Включать можно как на
правленном файле, так и на ещё не тронутом.
Цели make lint, lint-full и lint-fix по-прежнему передают
--config=./configs/golangci-lint.yml, так что файл надо держать по этому пути — и больше
ничего менять не нужно.
Чего при этом не будет: линтеры, которые генератор добавит в шаблон в будущих версиях, в проект не приедут. Набор правил целиком на проекте.
Ключ tools.lint_exclude_paths при own: true ни на что не влияет (его единственная
задача — подставить пути в генерируемый файл). Генерация в этом случае печатает warning,
сам ключ остаётся валидным — чтобы существующему проекту не приходилось чистить конфиг тем
же шагом, которым он забирает файл себе.
overrides — слой переопределений¶
configs/golangci-lint.yml остаётся сгенерированным файлом (ручные правки выше
disclaimer-маркера так же перезаписываются), а проект владеет только документом
переопределений. Генератор его не пишет и в проект не копирует.
Мерж происходит во время генерации, а не поверх уже записанного файла: генератор
рендерит свой шаблон, вливает в результат документ проекта и записывает итог. Поэтому
результат детерминирован и попадает в манифест meta.yaml как generated.
Путь принимает те же формы URI, что rest[].path (см. Remote specs) —
политика линтера, общая для нескольких репозиториев, такой же артефакт контракта, как
спека:
./configs/golangci-overrides.yml— локальноhttps://host/golangci-overrides.yml[?token_env=NAME]git+ssh://git@host/org/repo.git@<ref>#lint/golangci.ymlgit+https://host/org/repo.git@<ref>#lint/golangci.yml[?token_env=NAME]
Как и остальные каналы, учитывает переопределение ref через
--sourceRef.
Правила слияния¶
- Мапы сливаются рекурсивно — ключи проекта побеждают, незатронутые ключи генератора выживают.
- Скаляры и списки заменяются. Объявив
linters.settings.misspell, проект заменяет настройкиmisspellцеликом. - Явный
nullудаляет ключ (wsl: ~) — чтобы выключить блок настроек, не переписывая его. - Исключение из правила 2 — списки имён линтеров.
linters.enable/linters.disableиformatters.enable/formatters.disableработают как операции над множеством:enableдобавляет,disableубирает. Иначе, чтобы убрать один линтер, проекту пришлось бы переписать все ~50 из набора генератора — и эта копия потом никогда не подхватила бы новый линтер из шаблона.
disable разрешается на этапе генерации: линтер, который генератор включает явно,
просто вычитается из enable — golangci-lint отвергает конфиг, где линтер одновременно
включён и выключен. Имя, которого в enable генератора нет, — это дефолт golangci-lint
(errcheck, govet, ineffassign, staticcheck, unused приходят из
linters.default: standard), и оно уезжает в итоговый конфиг как настоящая запись
disable: другого способа выключить дефолт нет. Ни один линтер в результате не попадает в
enable и disable одновременно.
Итоговый linters.enable отсортирован — чтобы прогон был детерминирован, а diff читался.
Пример¶
# configs/golangci-overrides.yml
linters:
enable:
- gochecknoinits # добавить к набору генератора
disable:
- dupl # генератор включает явно → вычитается из enable
- errcheck # дефолт golangci → уедет в disable итогового конфига
settings:
misspell:
ignore-rules:
- cancelled # locale: US от генератора при этом сохраняется
lll:
line-length: 200 # заменяет 160
wsl: ~ # весь блок настроек wsl удалён
Без документа переопределений (и без own) результат побайтно совпадает с тем, что
генератор писал раньше: мерж в этом случае не запускается вовсе.