gomoddirectives

package module

v0.2.4 Latest Latest Go to latest Published: Mar 25, 2024 License: Apache-2.0 Imports: 9 Imported by: 14

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ldez/gomoddirectives

Links

Open Source Insights

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 (r Result) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetModuleFile ¶

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

GetModuleFile gets module file.

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 ¶ added in v0.2.0

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

AnalyzeFile analyzes a mod file.

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
gomoddirectives

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL