revive: disable package-comments rule

A recent change in revive broke the package-comments rule when .go files
are input individually.
(see https://github.com/mgechev/revive/pull/694)

See the comment within for more info.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2022-08-10 13:51:38 -04:00 committed by mergify[bot]
parent 7abe5a239a
commit f8c4d2c5e9
1 changed files with 6 additions and 0 deletions

View File

@ -20,7 +20,13 @@ warningCode = 0
[rule.var-naming]
arguments = [["ID", "UID"]]
[rule.var-declaration]
# We need to disable the package-comments check because we check all the .go
# files in the repo individually. This appears to confuse the new
# pacakge-comments implementation as it works correctly with ./... or ./a/b/c
# but not ./a/b/c/*.go. We need the latter input style as we have files with
# build tags we want to check, as well as multiple modules, within the repo.
[rule.package-comments]
disabled = true
[rule.range]
[rule.receiver-naming]
[rule.time-naming]