Skip to content

Document the "source" option in exclude-rules #3409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
james-johnston-thumbtack opened this issue Dec 10, 2022 · 0 comments · Fixed by #4105
Closed

Document the "source" option in exclude-rules #3409

james-johnston-thumbtack opened this issue Dec 10, 2022 · 0 comments · Fixed by #4105
Labels
area: docs enhancement New feature or improvement

Comments

@james-johnston-thumbtack

Your feature request related to a problem? Please describe.

There is apparently a source option which is available under exclude-rules in order to exclude a rule from code lines that match a particular regular expression. After some amount of digging around and first considering filing an issue about exclusions at least for the lll linter, I found it mentioned here: #207 (comment)

Unfortunately this option is not documented on the False Positives page at https://golangci-lint.run/usage/false-positives/ which is where I would have expected it: searching the page for source yields zero results. This was actually one of the first places I looked to try to find out if such a feature might exist.

Instead, the only mention is at https://golangci-lint.run/usage/configuration/#issues-configuration in a passing example that doesn't go into the depth of explanation that the False Positives page does.

Describe the solution you'd like.

Add documentation for the source option to the False Positives documentation page.

Describe alternatives you've considered.

none

Additional context.

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants