Implement //nolint parsing similar to golangci-lint #3562
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
patrickmscott
force-pushed
the
patrick/nolint
branch
from
cdcfe2a
to
2de421e
Compare
|
Test failures appear unrelated to the change |
patrickmscott
force-pushed
the
patrick/nolint
branch
from
ceb3aa2
to
a7a4d63
Compare
sluongng
reviewed
May 19, 2023
There was a problem hiding this comment.
This is great work @patrickmscott!! Damn impressive.
I have a small brain problem where I don't understand all of these though.
I think splitting these into 2 smaller PRs might be easier for reviewers to consume:
- Introduce
//nolint+ relevant tests - Allow
//nolint: linterA,linterB+ relevant tests
You would also want to update nogo documentation to highlight what do we support.
Keep in mind that down in each analyzer, they could also have there own ignore lint error directive, so we want to highlight that for future users of this feature to be aware of.
|
@sluongng I updated to use |
|
@sluongng any update? The test failure appears unrelated to my change. |
|
The failure should go away with a rebase onto master. |
Look for nolint comments and collect the ranges of where they apply. If a node immediately follows a range with the same column, expand the range to include the node. Add tests that verify errors are filtered out.
Inline the new report function and add some comments about nolint ranges.
Include a failing test that shows the column issue. Will work on a fix.
This is better than the logic used by golangci-lint in that it does not incorrectly attribute an inline comment with the next line if it contains an ast.Node with a matching column (see inline_column test).
Use table driven tests and `CombinedOutput`.
patrickmscott
force-pushed
the
patrick/nolint
branch
from
bba5375
to
a66f2f3
Compare
fmeum
approved these changes
Jun 7, 2023
renovate bot
added a commit
to kreempuff/rules_unreal_engine
that referenced
this pull request
Jun 22, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [io_bazel_rules_go](https://togithub.com/bazelbuild/rules_go) | http_archive | minor | `v0.39.1` -> `v0.40.0` | --- ### ⚠ Dependency Lookup Warnings ⚠ Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>bazelbuild/rules_go</summary> ### [`v0.40.0`](https://togithub.com/bazelbuild/rules_go/releases/tag/v0.40.0) [Compare Source](https://togithub.com/bazelbuild/rules_go/compare/v0.39.1...v0.40.0) #### What's Changed - Revert "Add automatic platform detection from inbound crosstool_top a… by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3468 - bzlmod: Add dedicated documentation by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3519 - Create TEST_SHARD_STATUS_FILE when sharding tests by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3547 - Move CI flags to .bazelrc and fix BwoB build by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3551 - Re-enable go_path_test on RBE by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3539 - nogo: provide usage doc by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3534 - respect global strip config by [@​malt3](https://togithub.com/malt3) in [bazelbuild/rules_go#3527 - stdliblist: return generated files by [@​grampelberg](https://togithub.com/grampelberg) in [bazelbuild/rules_go#3552 - Fix formatting in nogo usage doc by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3557 - Fix `goexperiment.*` build tags by [@​lbcjbb](https://togithub.com/lbcjbb) in [bazelbuild/rules_go#3556 - Remove tests for `go_path`'s `link` mode by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3565 - Fix tests with `--incompatible_disable_starlark_host_transitions` by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3560 - Create empty `.go` file in a random location by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3566 - gopackagesdriver: fix interface to work with golangci-lint ([#​3523](https://togithub.com/bazelbuild/rules_go/issues/3523)) by [@​grampelberg](https://togithub.com/grampelberg) in [bazelbuild/rules_go#3524 - Fix typo in load statement for bzlmod docs by [@​Sovietaced](https://togithub.com/Sovietaced) in [bazelbuild/rules_go#3570 - context: remove unused import by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3571 - docs: Mention `use_repo` automation by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3573 - Test basic-gazelle example with incompatible flags by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3575 - go_sdk extension: create `go_host_compatible_sdk` repository by [@​ylecornec](https://togithub.com/ylecornec) in [bazelbuild/rules_go#3543 - docs: Mention that `gazelle:prefix` can be replaced by `go.mod` by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3577 - go_download_sdk: apply extraction workaround to zips on non-windows OSs by [@​jayconrod](https://togithub.com/jayconrod) in [bazelbuild/rules_go#3563 - Fix `go_download_sdk` with Bazel dev versions by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3580 - Implement //nolint parsing similar to golangci-lint by [@​patrickmscott](https://togithub.com/patrickmscott) in [bazelbuild/rules_go#3562 #### New Contributors - [@​bricedp](https://togithub.com/bricedp) made their first contribution in [bazelbuild/rules_go#3512 - [@​patrickmscott](https://togithub.com/patrickmscott) made their first contribution in [bazelbuild/rules_go#3528 - [@​grampelberg](https://togithub.com/grampelberg) made their first contribution in [bazelbuild/rules_go#3552 - [@​Sovietaced](https://togithub.com/Sovietaced) made their first contribution in [bazelbuild/rules_go#3570 - [@​ylecornec](https://togithub.com/ylecornec) made their first contribution in [bazelbuild/rules_go#3543 **Full Changelog**: bazelbuild/rules_go@v0.39.1...v0.40.0 #### `WORKSPACE` code load("@​bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") http_archive( name = "io_bazel_rules_go", sha256 = "bfc5ce70b9d1634ae54f4e7b495657a18a04e0d596785f672d35d5f505ab491a", urls = [ "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.40.0/rules_go-v0.40.0.zip", "https://github.com/bazelbuild/rules_go/releases/download/v0.40.0/rules_go-v0.40.0.zip", ], ) load("@​io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies") go_rules_dependencies() go_register_toolchains(version = "1.20.5") </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/kreempuff/rules_unreal_engine). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMzEuMCIsInVwZGF0ZWRJblZlciI6IjM1LjEzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
renovate bot
added a commit
to cgrindel/rules_swift_package_manager
that referenced
this pull request
Jun 23, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [io_bazel_rules_go](https://togithub.com/bazelbuild/rules_go) | http_archive | minor | `v0.39.1` -> `v0.40.0` | --- ### Release Notes <details> <summary>bazelbuild/rules_go</summary> ### [`v0.40.0`](https://togithub.com/bazelbuild/rules_go/releases/tag/v0.40.0) [Compare Source](https://togithub.com/bazelbuild/rules_go/compare/v0.39.1...v0.40.0) #### What's Changed - Revert "Add automatic platform detection from inbound crosstool_top a… by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3468 - bzlmod: Add dedicated documentation by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3519 - Create TEST_SHARD_STATUS_FILE when sharding tests by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3547 - Move CI flags to .bazelrc and fix BwoB build by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3551 - Re-enable go_path_test on RBE by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3539 - nogo: provide usage doc by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3534 - respect global strip config by [@​malt3](https://togithub.com/malt3) in [bazelbuild/rules_go#3527 - stdliblist: return generated files by [@​grampelberg](https://togithub.com/grampelberg) in [bazelbuild/rules_go#3552 - Fix formatting in nogo usage doc by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3557 - Fix `goexperiment.*` build tags by [@​lbcjbb](https://togithub.com/lbcjbb) in [bazelbuild/rules_go#3556 - Remove tests for `go_path`'s `link` mode by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3565 - Fix tests with `--incompatible_disable_starlark_host_transitions` by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3560 - Create empty `.go` file in a random location by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3566 - gopackagesdriver: fix interface to work with golangci-lint ([#​3523](https://togithub.com/bazelbuild/rules_go/issues/3523)) by [@​grampelberg](https://togithub.com/grampelberg) in [bazelbuild/rules_go#3524 - Fix typo in load statement for bzlmod docs by [@​Sovietaced](https://togithub.com/Sovietaced) in [bazelbuild/rules_go#3570 - context: remove unused import by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3571 - docs: Mention `use_repo` automation by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3573 - Test basic-gazelle example with incompatible flags by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3575 - go_sdk extension: create `go_host_compatible_sdk` repository by [@​ylecornec](https://togithub.com/ylecornec) in [bazelbuild/rules_go#3543 - docs: Mention that `gazelle:prefix` can be replaced by `go.mod` by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3577 - go_download_sdk: apply extraction workaround to zips on non-windows OSs by [@​jayconrod](https://togithub.com/jayconrod) in [bazelbuild/rules_go#3563 - Fix `go_download_sdk` with Bazel dev versions by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3580 - Implement //nolint parsing similar to golangci-lint by [@​patrickmscott](https://togithub.com/patrickmscott) in [bazelbuild/rules_go#3562 #### New Contributors - [@​bricedp](https://togithub.com/bricedp) made their first contribution in [bazelbuild/rules_go#3512 - [@​patrickmscott](https://togithub.com/patrickmscott) made their first contribution in [bazelbuild/rules_go#3528 - [@​grampelberg](https://togithub.com/grampelberg) made their first contribution in [bazelbuild/rules_go#3552 - [@​Sovietaced](https://togithub.com/Sovietaced) made their first contribution in [bazelbuild/rules_go#3570 - [@​ylecornec](https://togithub.com/ylecornec) made their first contribution in [bazelbuild/rules_go#3543 **Full Changelog**: bazelbuild/rules_go@v0.39.1...v0.40.0 #### `WORKSPACE` code load("@​bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") http_archive( name = "io_bazel_rules_go", sha256 = "bfc5ce70b9d1634ae54f4e7b495657a18a04e0d596785f672d35d5f505ab491a", urls = [ "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.40.0/rules_go-v0.40.0.zip", "https://github.com/bazelbuild/rules_go/releases/download/v0.40.0/rules_go-v0.40.0.zip", ], ) load("@​io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies") go_rules_dependencies() go_register_toolchains(version = "1.20.5") </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/cgrindel/rules_swift_package_manager). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMzEuMCIsInVwZGF0ZWRJblZlciI6IjM1LjEzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
renovate bot
added a commit
to cgrindel/bazel-starlib
that referenced
this pull request
Jun 23, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [io_bazel_rules_go](https://togithub.com/bazelbuild/rules_go) | http_archive | minor | `v0.39.1` -> `v0.40.0` | --- ### Release Notes <details> <summary>bazelbuild/rules_go</summary> ### [`v0.40.0`](https://togithub.com/bazelbuild/rules_go/releases/tag/v0.40.0) [Compare Source](https://togithub.com/bazelbuild/rules_go/compare/v0.39.1...v0.40.0) #### What's Changed - Revert "Add automatic platform detection from inbound crosstool_top a… by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3468 - bzlmod: Add dedicated documentation by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3519 - Create TEST_SHARD_STATUS_FILE when sharding tests by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3547 - Move CI flags to .bazelrc and fix BwoB build by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3551 - Re-enable go_path_test on RBE by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3539 - nogo: provide usage doc by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3534 - respect global strip config by [@​malt3](https://togithub.com/malt3) in [bazelbuild/rules_go#3527 - stdliblist: return generated files by [@​grampelberg](https://togithub.com/grampelberg) in [bazelbuild/rules_go#3552 - Fix formatting in nogo usage doc by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3557 - Fix `goexperiment.*` build tags by [@​lbcjbb](https://togithub.com/lbcjbb) in [bazelbuild/rules_go#3556 - Remove tests for `go_path`'s `link` mode by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3565 - Fix tests with `--incompatible_disable_starlark_host_transitions` by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3560 - Create empty `.go` file in a random location by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3566 - gopackagesdriver: fix interface to work with golangci-lint ([#​3523](https://togithub.com/bazelbuild/rules_go/issues/3523)) by [@​grampelberg](https://togithub.com/grampelberg) in [bazelbuild/rules_go#3524 - Fix typo in load statement for bzlmod docs by [@​Sovietaced](https://togithub.com/Sovietaced) in [bazelbuild/rules_go#3570 - context: remove unused import by [@​sluongng](https://togithub.com/sluongng) in [bazelbuild/rules_go#3571 - docs: Mention `use_repo` automation by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3573 - Test basic-gazelle example with incompatible flags by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3575 - go_sdk extension: create `go_host_compatible_sdk` repository by [@​ylecornec](https://togithub.com/ylecornec) in [bazelbuild/rules_go#3543 - docs: Mention that `gazelle:prefix` can be replaced by `go.mod` by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3577 - go_download_sdk: apply extraction workaround to zips on non-windows OSs by [@​jayconrod](https://togithub.com/jayconrod) in [bazelbuild/rules_go#3563 - Fix `go_download_sdk` with Bazel dev versions by [@​fmeum](https://togithub.com/fmeum) in [bazelbuild/rules_go#3580 - Implement //nolint parsing similar to golangci-lint by [@​patrickmscott](https://togithub.com/patrickmscott) in [bazelbuild/rules_go#3562 #### New Contributors - [@​bricedp](https://togithub.com/bricedp) made their first contribution in [bazelbuild/rules_go#3512 - [@​patrickmscott](https://togithub.com/patrickmscott) made their first contribution in [bazelbuild/rules_go#3528 - [@​grampelberg](https://togithub.com/grampelberg) made their first contribution in [bazelbuild/rules_go#3552 - [@​Sovietaced](https://togithub.com/Sovietaced) made their first contribution in [bazelbuild/rules_go#3570 - [@​ylecornec](https://togithub.com/ylecornec) made their first contribution in [bazelbuild/rules_go#3543 **Full Changelog**: bazelbuild/rules_go@v0.39.1...v0.40.0 #### `WORKSPACE` code load("@​bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") http_archive( name = "io_bazel_rules_go", sha256 = "bfc5ce70b9d1634ae54f4e7b495657a18a04e0d596785f672d35d5f505ab491a", urls = [ "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.40.0/rules_go-v0.40.0.zip", "https://github.com/bazelbuild/rules_go/releases/download/v0.40.0/rules_go-v0.40.0.zip", ], ) load("@​io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies") go_rules_dependencies() go_register_toolchains(version = "1.20.5") </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/cgrindel/bazel-starlib). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMzEuMCIsInVwZGF0ZWRJblZlciI6IjM1LjEzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
tingilee
pushed a commit
to tingilee/rules_go
that referenced
this pull request
Jul 19, 2023
* Implement //nolint parsing similar to golangci-lint Look for nolint comments and collect the ranges of where they apply. If a node immediately follows a range with the same column, expand the range to include the node. Add tests that verify errors are filtered out. * Use a map instead of custom Linters type Inline the new report function and add some comments about nolint ranges. * Add separate tests for various filters Include a failing test that shows the column issue. Will work on a fix. * Use ast.CommentMap to associate comments to nodes This is better than the logic used by golangci-lint in that it does not incorrectly attribute an inline comment with the next line if it contains an ast.Node with a matching column (see inline_column test). * Address PR feedback Use table driven tests and `CombinedOutput`. --------- Co-authored-by: Patrick Scott <patrick.scott@observeinc.com>
](https://renovatebot.com){kind=link}
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.
#3561
Look for nolint comments and collect the ranges of where they apply. If a node immediately follows a range with the same column, expand the range to include the node.
Add tests that verify errors are filtered out.
What type of PR is this?
Feature
What does this PR do? Why is it needed?
Parses
//nolintcomments and filters out errors from nogo.Which issues(s) does this PR fix?
Fixes #3561
Other notes for review