Skip to content

Commit 61dadaa

Browse files
committed
Add README build instructions
1 parent 6982d70 commit 61dadaa

2 files changed

Lines changed: 2 additions & 21 deletions

File tree

linters/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AR Golang CI Lints
1+
# Golang CI Lints
22

33
Custom Go linters used on Wormhole CI. Each linter is a [golangci-lint
44
module plugin](https://golangci-lint.run/plugins/module-plugins/) and lives

linters/rules/channelcheck/README.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,4 @@ standalone analyzer flag (when running the `wormhole-lint` binary, using the
2121
| `CheckBlockingSends` | `blocking` | bool | `true` | Flag blocking sends that lack a `default`/timeout/ticker escape in their enclosing `select`. |
2222
| `CheckUnbufferedChannels` | `unbuffered` | bool | `false` | Flag creation of unbuffered channels (`make(chan T)`). |
2323
| `CheckBufferAmount` | `bufferMax` | uint64 | `0` | Flag buffered channels whose size exceeds this max. `0` disables the check. |
24-
| `IgnoreChannelsByName` | *(none)* | []string | `[]` | Channel/field names whose direct sends are exempt from the blocking-send check (e.g. `errC`). Settings-only; no standalone flag. |
25-
26-
## Configuration Steps Standalone
27-
The linter can be used by itself. Simply run the following to install the binary:
28-
29-
```bash
30-
go install ./cmd/channelcheck/main.go
31-
```
32-
33-
Usage:
34-
35-
```bash
36-
channellint ./examples
37-
```
38-
39-
## Resources
40-
- https://clavinjune.dev/en/blogs/buffered-vs-unbuffered-channel-in-golang/
41-
- https://medium.com/@chethan13/unbuffered-vs-buffered-channels-in-go-83b1a0956e46
42-
- https://chrisguitarguy.com/2024/04/17/beware-blocking-channel-sends-in-go/
43-
- https://abubakardev0.medium.com/understanding-channels-in-go-a-comprehensive-guide-a5a9f823c709
24+
| `IgnoreChannelsByName` | *(none)* | []string | `[]` | Channel/field names whose direct sends are exempt from the blocking-send check (e.g. `errC`). Settings-only; no standalone flag. |

0 commit comments

Comments
 (0)