Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix 922 #989

Merged
merged 2 commits into from
May 13, 2024
Merged

Fix 922 #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f3b35c
removes spurious warning on package comments starting with spaces
May 11, 2024
753687c
skips directive comments when linting package comments
May 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 2 additions & 10 deletions rule/package-comments.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,17 +150,9 @@ func (l *lintPackageComments) Visit(_ ast.Node) ast.Visitor {
return nil
}
s := l.fileAst.Doc.Text()
if ts := strings.TrimLeft(s, " \t"); ts != s {
l.onFailure(lint.Failure{
Category: "comments",
Node: l.fileAst.Doc,
Confidence: 1,
Failure: "package comment should not have leading space",
})
s = ts
}

// Only non-main packages need to keep to this form.
if !l.file.Pkg.IsMain() && !strings.HasPrefix(s, prefix) {
if !l.file.Pkg.IsMain() && !strings.HasPrefix(s, prefix) && !isDirectiveComment(s) {
l.onFailure(lint.Failure{
Category: "comments",
Node: l.fileAst.Doc,
Expand Down
7 changes: 0 additions & 7 deletions testdata/golint/package-doc4.go
View file
Open in desktop

This file was deleted.

5 changes: 5 additions & 0 deletions testdata/golint/package-doc6.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//revive:disable
//nolint:dupl,revive // looks the same but isn't
//revive:enable

package foo // MATCH /should have a package comment/