Allow use of nolint comments if linter configured #133
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some projects prefer using '//nolint' comments instead of configuring exclusions in the config file. These have the benefit of only disabling the selected linters at the specific place in the code and not across the entire file, they are automatically cleaned up when they no longer apply with 'allow-unused: false', and we can continue to require explanations at call sites along the code failing the lint check. Update makego to call a bash script 'checknolintlint.bash' to verify that the 'nolintlint' linter is enabled and has the standard config. If this script passes, then allow for '//nolint' comments to be used in the source code. If not, continue using the existing '//nolint' detection to fail the build if comments are used.
pkwarren
commented
Mar 21, 2024
| # allow-unused: false | ||
| # allow-no-explanation: [] | ||
| # require-explanation: true | ||
| # require-specific: true |
mfridman
approved these changes
Mar 21, 2024
bufdev
reviewed
Mar 21, 2024
bufdev
reviewed
Mar 21, 2024
| set -euo pipefail | ||
|
|
||
| if [[ ! -f .golangci.yml ]]; then | ||
| echo "nolintlint not enabled in .golangci.yml" >&2 |
There was a problem hiding this comment.
Clarifying my previous comment: my concern is if I don't have a .golangci.yml, then this script errors. In the context of makego, I think I should be able to not have a .golangci.yml file. I would instead exit 0 with no message.
| @if grep -r --include "*.go" '//nolint'; then \ | ||
| checknonolint: $(YQ) | ||
| @if bash $(MAKEGO)/scripts/checknolintlint.bash; then \ | ||
| echo 'golangci-lint nolintlint configured' >&2; \ |
There was a problem hiding this comment.
If the below is updated, this may not be true. I would remove entirely.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some projects prefer using
//nolintcomments instead of configuring exclusions in the config file. These have the benefit of only disabling the selected linters at the specific place in the code and not across the entire file, they are automatically cleaned up when they no longer apply withallow-unused: false, and we can continue to require explanations at call sites alongside the code failing the lint check.Update makego to call a bash script
checknolintlint.bashto verify that thenolintlintlinter is enabled and has the standard config. If this script passes, then allow for//nolintcomments to be used in the source code. If not, continue using the existing//nolintdetection to fail the build if comments are used.