lint

Documentation

Overview

Package lint provides the core functionality of easyp lint.

Index

• type ImportPath
  • func ConvertImportPath(source string) ImportPath
• type Lint
  • func New(rules []Rule, ignoreDirs []string, deps []string) *Lint
  • func (c *Lint) Lint(ctx context.Context, disk fs.FS) error
• type ProtoInfo
• type Rule

Types

type ImportPath

type ImportPath string

ImportPath type alias for path import in proto file

func ConvertImportPath

func ConvertImportPath(source string) ImportPath

type Lint

type Lint struct {
	// contains filtered or unexported fields
}

Lint is the core functionality of easyp lint.

func New

func New(rules []Rule, ignoreDirs []string, deps []string) *Lint

New creates a new Lint.

func (*Lint) Lint

func (c *Lint) Lint(ctx context.Context, disk fs.FS) error

Lint lints the proto file.

type ProtoInfo

type ProtoInfo struct {
	Path                 string
	Info                 *unordered.Proto
	ProtoFilesFromImport map[ImportPath]*unordered.Proto
}

ProtoInfo is the information of a proto file.

type Rule

type Rule interface {
	// Validate validates the proto rule.
	Validate(ProtoInfo) []error
}

Rule is an interface for a rule checking.