ctxtodo

Documentation

Overview

Package ctxtodo implements a Go Analyzer for detecting context.TODO() and plumbing contexts to it.

Index

• Variables
• type NeedsContext
  • func (NeedsContext) AFact()
  • func (NeedsContext) String() string

Variables

var Analyzer = &analysis.Analyzer{
	Name:  "ctxtodo",
	Doc:   "Find calls of the context.TODO function in need of plumbing.",
	Run:   run,
	Flags: flags(),

	FactTypes: []analysis.Fact{
		new(NeedsContext),
	},

	RunDespiteErrors: true,
}

Analyzer provides the ctxtodo analyzer.

var (
	// ModuleCache is a prefix that will cause suggested fixes to be ignored.
	ModuleCache string
)

Types

type NeedsContext

type NeedsContext struct{}

NeedsContext indicates that an exported function is having a context added by the ctxtodo analyzer, so that other packages can understand the need to add a context parameter.

func (NeedsContext) AFact

func (NeedsContext) AFact()

func (NeedsContext) String

func (NeedsContext) String() string