docs: adds a section about exclude-dirs-use-default (#5045)

This commit is contained in:
Ludovic Fernandez 2024-09-28 14:27:46 +02:00 committed by GitHub
parent 75f4396c4a
commit 3ed307e113
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -175,3 +175,18 @@ Some exclusions are considered as common, to help golangci-lint users those comm
If you don't want to use it you can set `issues.exclude-use-default` to `false`.
{.DefaultExclusions}
### Default Directory Exclusions
By default, the reports from directory names, that match the following regular expressions, are excluded:
- `third_party$`
- `examples$`
- `Godeps$`
- `builtin$`
This option has been defined when Go modules was not existed and when the golangci-lint core was different, this is not something we still recommend.
At some point, we will remove all those obsolete exclusions, but as it's a breaking changes it will only happen inside a major version.
So we recommend setting `issues.exclude-dirs-use-default` to `false`.