mirror of
https://github.com/Crocmagnon/fatcontext.git
synced 2024-11-23 08:28:09 +01:00
63 lines
1.4 KiB
Markdown
63 lines
1.4 KiB
Markdown
# fatcontext
|
|
|
|
[](https://pkg.go.dev/github.com/Crocmagnon/fatcontext)
|
|
[](https://goreportcard.com/report/github.com/Crocmagnon/fatcontext)
|
|
[](https://github.com/Crocmagnon/fatcontext/wiki/Coverage)
|
|
|
|
`fatcontext` is a Go linter which detects potential fat contexts in loops or function literals.
|
|
They can lead to performance issues, as documented here: https://gabnotes.org/fat-contexts/
|
|
|
|
## Installation / usage
|
|
|
|
`fatcontext` is available in `golangci-lint` since v1.58.0.
|
|
|
|
```bash
|
|
go install github.com/Crocmagnon/fatcontext/cmd/fatcontext@latest
|
|
fatcontext ./...
|
|
```
|
|
|
|
There are no specific configuration options or custom command-line flags.
|
|
|
|
## Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import "context"
|
|
|
|
func ok() {
|
|
ctx := context.Background()
|
|
|
|
for i := 0; i < 10; i++ {
|
|
ctx := context.WithValue(ctx, "key", i)
|
|
_ = ctx
|
|
}
|
|
}
|
|
|
|
func notOk() {
|
|
ctx := context.Background()
|
|
|
|
for i := 0; i < 10; i++ {
|
|
ctx = context.WithValue(ctx, "key", i) // "nested context in loop"
|
|
_ = ctx
|
|
}
|
|
}
|
|
```
|
|
|
|
## Development
|
|
|
|
Setup pre-commit locally:
|
|
```bash
|
|
pre-commit install
|
|
```
|
|
|
|
Run tests & linter:
|
|
```bash
|
|
make lint test
|
|
```
|
|
|
|
To release, just publish a git tag:
|
|
```bash
|
|
git tag -a v0.1.0 -m "v0.1.0"
|
|
git push --follow-tags
|
|
```
|