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

Disable revive linter rule package-comments #78

Closed
svengreb opened this issue Nov 23, 2021 · 0 comments · Fixed by #79
Closed

Disable revive linter rule package-comments #78

svengreb opened this issue Nov 23, 2021 · 0 comments · Fixed by #79
Labels
context-techstack scope-compatibility scope-quality type-improvement
Milestone
0.11.0

Comments

@svengreb
Copy link
Owner

svengreb commented Nov 23, 2021 •
edited
Loading

Even though the package-comments rule of the revive linter is quite useful, it produces false-positive errors when another file already has a package documentation. Duplicating documentation is not a workaround so the rule will be disabled for now and might be re-enabled if the rule logic gets updated.
@svengreb svengreb added this to the 0.10.1 milestone Nov 23, 2021
@svengreb svengreb self-assigned this Nov 23, 2021
svengreb added a commit that referenced this issue Nov 23, 2021
@svengreb
Disable revive linter rule package-comments
37de0a2 
Even though the `package-comments` rule [1] of the `revive` linter [2]
is quite useful, it produces false-positive errors when another file
already has a package documentation. Duplicating documentation is not a
workaround so the rule has been disabled for now and might be re-enabled
if the rule logic gets updated.

[1]: https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments

GH-78
@svengreb svengreb mentioned this issue Nov 23, 2021
Merged
svengreb added a commit that referenced this issue Nov 23, 2021
@svengreb
Disable revive linter rule package-comments (#79)
918ba3c 
Even though the `package-comments` rule [1] of the `revive` linter [2]
is quite useful, it produces false-positive errors when another file
already has a package documentation. Duplicating documentation is not a
workaround so the rule has been disabled for now and might be re-enabled
if the rule logic gets updated.

[1]: https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments

Closes GH-78
@svengreb svengreb removed their assignment Nov 23, 2021
@svengreb svengreb mentioned this issue Nov 23, 2021
Closed
svengreb added a commit to svengreb/wand that referenced this issue Nov 23, 2021
@svengreb
Update to tmpl-go template repository version 0.11.0
fd024b6 
Updated to `tmpl-go` version `0.11.0` [1] which...

1. fixed `golangci-lint` running errors due to `revive`s unknown
   `time-equal` rule [2].
2. disabled the `revive` linter rule `package-comments` [3].

See the full `tmpl-go` version `0.10.1` changelog [1] for all details.

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.10.1
[2]: svengreb/tmpl-go#76
[3]: svengreb/tmpl-go#78

GH-112
svengreb added a commit to svengreb/wand that referenced this issue Nov 23, 2021
@svengreb
Update to tmpl-go template repository version 0.11.0 (#113)
a4e2a38 
Updated to `tmpl-go` version `0.11.0` [1] which...

1. fixed `golangci-lint` running errors due to `revive`s unknown
   `time-equal` rule [2].
2. disabled the `revive` linter rule `package-comments` [3].

See the full `tmpl-go` version `0.10.1` changelog [1] for all details.

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.10.1
[2]: svengreb/tmpl-go#76
[3]: svengreb/tmpl-go#78

Closes GH-112
@svengreb svengreb mentioned this issue May 9, 2022
Closed
svengreb added a commit to svengreb/nib that referenced this issue May 9, 2022
@svengreb
Update to tmpl-go template repository version 0.12.0
fef2e6a 
Updated to `tmpl-go` version 0.12.0 [1], including the versions in
between starting from 0.7.0 [3]:

1. Updated to Go 1.17 [4].
2. Updated to golangci-lint `v1.43.0` [5].
3. Updated to `tmpl` template repository version `0.11.0` [6].
4. Optimized GitHub action workflows for Go and Node [7].
5. Disabled golangci-lint's default excluded issues [8].
6. Introduced Go dependency caching and build outputs in `ci-go`
   workflow [9].
7. Disabled revive linter rule `package-comments` [10].
8. Fixed golangci-lint fail to run due to `revives` unknown `time-equal`
   rule [11].
9. updated Node.js packages & GitHub actions [12].

This also included changes required for any linter matches.

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.12.0
[3]: https://github.com/svengreb/tmpl-go/releases/tag/v0.7.0
[4]: svengreb/tmpl-go#66
[5]: svengreb/tmpl-go#64
[6]: svengreb/tmpl-go#91
[7]: svengreb/tmpl-go#68
[8]: svengreb/tmpl-go#72
[9]: svengreb/tmpl-go#74
[10]: svengreb/tmpl-go#78
[11]: svengreb/tmpl-go#76
[12]: svengreb/tmpl-go#42

GH-62
svengreb added a commit to svengreb/nib that referenced this issue May 9, 2022
@svengreb
Update to tmpl-go template repository version 0.12.0
797b5ba 
Updated to `tmpl-go` version 0.12.0 [1], including the versions in
between starting from 0.7.0 [3]:

1. Updated to Go 1.17 [4].
2. Updated to golangci-lint `v1.43.0` [5].
3. Updated to `tmpl` template repository version `0.11.0` [6].
4. Optimized GitHub action workflows for Go and Node [7].
5. Disabled golangci-lint's default excluded issues [8].
6. Introduced Go dependency caching and build outputs in `ci-go`
   workflow [9].
7. Disabled revive linter rule `package-comments` [10].
8. Fixed golangci-lint fail to run due to `revives` unknown `time-equal`
   rule [11].
9. updated Node.js packages & GitHub actions [12].

This also included changes required for any linter matches.

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.12.0
[3]: https://github.com/svengreb/tmpl-go/releases/tag/v0.7.0
[4]: svengreb/tmpl-go#66
[5]: svengreb/tmpl-go#64
[6]: svengreb/tmpl-go#91
[7]: svengreb/tmpl-go#68
[8]: svengreb/tmpl-go#72
[9]: svengreb/tmpl-go#74
[10]: svengreb/tmpl-go#78
[11]: svengreb/tmpl-go#76
[12]: svengreb/tmpl-go#42

GH-62
svengreb added a commit to svengreb/nib that referenced this issue May 9, 2022
@svengreb
Update to tmpl-go template repository version 0.12.0 (#63)
4890bd0 
Updated to `tmpl-go` version 0.12.0 [1], including the versions in
between starting from 0.7.0 [3]:

1. Updated to Go 1.17 [4].
2. Updated to golangci-lint `v1.43.0` [5].
3. Updated to `tmpl` template repository version `0.11.0` [6].
4. Optimized GitHub action workflows for Go and Node [7].
5. Disabled golangci-lint's default excluded issues [8].
6. Introduced Go dependency caching and build outputs in `ci-go`
   workflow [9].
7. Disabled revive linter rule `package-comments` [10].
8. Fixed golangci-lint fail to run due to `revives` unknown `time-equal`
   rule [11].
9. updated Node.js packages & GitHub actions [12].

This also included changes required for any linter matches.

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.12.0
[3]: https://github.com/svengreb/tmpl-go/releases/tag/v0.7.0
[4]: svengreb/tmpl-go#66
[5]: svengreb/tmpl-go#64
[6]: svengreb/tmpl-go#91
[7]: svengreb/tmpl-go#68
[8]: svengreb/tmpl-go#72
[9]: svengreb/tmpl-go#74
[10]: svengreb/tmpl-go#78
[11]: svengreb/tmpl-go#76
[12]: svengreb/tmpl-go#42

GH-62
@svengreb svengreb mentioned this issue May 10, 2022
Closed
svengreb added a commit to svengreb/golib that referenced this issue May 10, 2022
@svengreb
Update to tmpl-go template repository version 0.12.0
4f35b10 
Updated to `tmpl-go` version `0.12.0` [1], including the versions in
between starting from 0.7.0 [3]:

1. Updated to Go 1.17 [4].
2. Updated to golangci-lint `v1.43.0` [5].
3. Updated to `tmpl` template repository version `0.11.0` [6].
4. Optimized GitHub action workflows for Go and Node [7].
5. Disabled golangci-lint's default excluded issues [8].
6. Introduced Go dependency caching and build outputs in `ci-go`
   workflow [9].
7. Disabled revive linter rule `package-comments` [10].
8. Fixed golangci-lint fail to run due to `revives` unknown `time-equal`
   rule [11].
9. Updated Node.js packages & GitHub actions [12].

This also includes changes required for any linter matches.

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.12.0
[3]: https://github.com/svengreb/tmpl-go/releases/tag/v0.7.0
[4]: svengreb/tmpl-go#66
[5]: svengreb/tmpl-go#64
[6]: svengreb/tmpl-go#91
[7]: svengreb/tmpl-go#68
[8]: svengreb/tmpl-go#72
[9]: svengreb/tmpl-go#74
[10]: svengreb/tmpl-go#78
[11]: svengreb/tmpl-go#76
[12]: svengreb/tmpl-go#42

GH-41
svengreb added a commit to svengreb/golib that referenced this issue May 10, 2022
@svengreb
Update to tmpl-go template repository version 0.12.0 (#42)
5116546 
Updated to `tmpl-go` version `0.12.0` [1], including the versions in
between starting from 0.7.0 [3]:

1. Updated to Go 1.17 [4].
2. Updated to golangci-lint `v1.43.0` [5].
3. Updated to `tmpl` template repository version `0.11.0` [6].
4. Optimized GitHub action workflows for Go and Node [7].
5. Disabled golangci-lint's default excluded issues [8].
6. Introduced Go dependency caching and build outputs in `ci-go`
   workflow [9].
7. Disabled revive linter rule `package-comments` [10].
8. Fixed golangci-lint fail to run due to `revives` unknown `time-equal`
   rule [11].
9. Updated Node.js packages & GitHub actions [12].

This also includes changes required for any linter matches.

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.12.0
[3]: https://github.com/svengreb/tmpl-go/releases/tag/v0.7.0
[4]: svengreb/tmpl-go#66
[5]: svengreb/tmpl-go#64
[6]: svengreb/tmpl-go#91
[7]: svengreb/tmpl-go#68
[8]: svengreb/tmpl-go#72
[9]: svengreb/tmpl-go#74
[10]: svengreb/tmpl-go#78
[11]: svengreb/tmpl-go#76
[12]: svengreb/tmpl-go#42

GH-41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
context-techstack scope-compatibility scope-quality type-improvement
Projects
None yet
Milestone
0.11.0
Development

Successfully merging a pull request may close this issue.

Disable revive linter rule package-comments svengreb/tmpl-go
1 participant
@svengreb