detects nested contexts in loops
Find a file
2024-10-30 16:17:27 +01:00
.github add coverage report 2024-10-30 16:17:27 +01:00
cmd/fatcontext refactor: rename foreshadow to fatcontext 2024-03-27 23:50:12 +01:00
contrib refactor: rename foreshadow to fatcontext 2024-03-27 23:50:12 +01:00
pkg/analyzer doc: update linter description 2024-08-26 10:30:12 +02:00
testdata/src Detect nested contexts in function literals (#18) 2024-08-26 07:46:02 +02:00
.gitignore chore: ignore binary 2024-09-01 13:40:56 +02:00
.golangci.yml add linter and pre-commit 2024-03-27 22:01:27 +01:00
.goreleaser.yaml force github token in goreleaser 2024-03-28 00:01:25 +01:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2024-10-07 23:43:57 -04:00
go.mod build(deps): bump golang.org/x/tools from 0.24.0 to 0.25.0 2024-10-02 13:53:46 +02:00
go.sum build(deps): bump golang.org/x/tools from 0.24.0 to 0.25.0 2024-10-02 13:53:46 +02:00
LICENSE add LICENSE 2024-03-27 20:04:07 +01:00
Makefile Revert "ci: run go checks in pre-commit.ci" 2024-03-27 23:07:11 +01:00
README.md add badges in readme 2024-10-30 15:35:31 +01:00

fatcontext

Go Reference Go Report Card

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.

go install github.com/Crocmagnon/fatcontext/cmd/fatcontext@latest
fatcontext ./...

There are no specific configuration options or custom command-line flags.

Example

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:

pre-commit install

Run tests & linter:

make lint test

To release, just publish a git tag:

git tag -a v0.1.0 -m "v0.1.0"
git push --follow-tags