nogo: provide usage doc #3534
Merged
nogo: provide usage doc #3534
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
fmeum
approved these changes
Apr 17, 2023
fmeum
reviewed
May 4, 2023
Explain basic usage of nogo to new user. Also provide a quick comparison between `nogo` and other popular linters such as golangci-lint
sluongng
force-pushed
the
sluongng/doc-nogo
branch
from
fb5647f
to
000bf95
Compare
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
](https://renovatebot.com){kind=link}
* nogo: provide usage doc Explain basic usage of nogo to new user. Also provide a quick comparison between `nogo` and other popular linters such as golangci-lint * re-word and format with 'fmt 90'
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.
What type of PR is this?
What does this PR do? Why is it needed?
Explain basic usage of nogo to new user.
Also provide a quick comparison between
nogoand other popular linterssuch as golangci-lint
Other notes for review