feat: warn if readme plugin contains a comment. #253
Merged
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
|
|
academo
reviewed
Sep 17, 2024
s4kh
force-pushed
the
skh-warn-readme-comment
branch
from
b59cfcc to
d5a9670
Compare
academo
approved these changes
Sep 17, 2024
xnyo
approved these changes
Sep 18, 2024
pkg/analysis/passes/readme/readme.go
Outdated
| } | ||
| if readmeComment.ReportAll { | ||
| readmeComment.Severity = analysis.OK | ||
| pass.ReportResult(pass.AnalyzerName, readmeComment, "README.md contains no comment(s).", "") |
There was a problem hiding this comment.
Nit:
Suggested change
| pass.ReportResult(pass.AnalyzerName, readmeComment, "README.md contains no comment(s).", "") | |
| pass.ReportResult(pass.AnalyzerName, readmeComment, "README.md doesn't contain any comment", "") |
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.
Issue
#251 readme comment
Change
Warns if readme plugin contains a comment.