gomoddirectives

README

gomoddirectives

A linter that handle replace, retract, exclude directives into go.mod.

Features:

• ban all replace directives
• allow only local replace directives
• allow only some replace directives
• force explanation for retract directives
• ban all exclude directives
• detect duplicated replace directives
• detect identical replace directives

Documentation

Overview

Package gomoddirectives a linter that handle `replace`, `retract`, `exclude` directives into `go.mod`.

Index

• func GetModuleFile() (*modfile.File, error)
• type Options
• type Result
  • func Analyze(opts Options) ([]Result, error)
  • func AnalyzeFile(file *modfile.File, opts Options) []Result
  • func AnalyzePass(pass *analysis.Pass, opts Options) ([]Result, error)
  • func NewResult(file *modfile.File, line *modfile.Line, reason string) Result
  • func (r Result) String() string

Functions

func GetModuleFile

func GetModuleFile() (*modfile.File, error)

GetModuleFile gets module file. It's better to use [GetGoModFile] instead of this function.

Types

type Options

type Options struct {
	ReplaceAllowList          []string
	ReplaceAllowLocal         bool
	ExcludeForbidden          bool
	RetractAllowNoExplanation bool
}

Options the analyzer options.

type Result

type Result struct {
	Reason string
	Start  token.Position
	End    token.Position
}

Result the analysis result.

func Analyze

func Analyze(opts Options) ([]Result, error)

Analyze analyzes a project.

func AnalyzeFile

func AnalyzeFile(file *modfile.File, opts Options) []Result

AnalyzeFile analyzes a mod file.

func AnalyzePass

func AnalyzePass(pass *analysis.Pass, opts Options) ([]Result, error)

AnalyzePass analyzes a pass.

func NewResult

func NewResult(file *modfile.File, line *modfile.Line, reason string) Result

NewResult creates a new Result.

func (Result) String

func (r Result) String() string