-
-
Notifications
You must be signed in to change notification settings - Fork 0
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
Disable revive
linter rule package-comments
#78
Milestone
Comments
svengreb
added a commit
that referenced
this issue
Nov 23, 2021
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
added a commit
that referenced
this issue
Nov 23, 2021
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
added a commit
to svengreb/wand
that referenced
this issue
Nov 23, 2021
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
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
added a commit
to svengreb/nib
that referenced
this issue
May 9, 2022
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
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
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/golib
that referenced
this issue
May 10, 2022
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
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
Even though the
package-comments
rule of therevive
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.The text was updated successfully, but these errors were encountered: