lint

Documentation

Overview

Package lint provides the core functionality of easyp lint.

Index

• Variables
• func CheckIsIgnored(comments []*parser.Comment, ruleName string) bool
• func GetRuleName(rule Rule) string
• func SetAllowCommentIgnores(val bool)
• type ImportPath
  • func ConvertImportPath(source string) ImportPath
• type Issue
  • func AppendIssue(issues []Issue, lintRule Rule, pos meta.Position, sourceName string, ...) []Issue
• type IssueInfo
• type Lint
  • func New(rules []Rule, ignore []string, ignoreOnly map[string][]string, deps []string) *Lint
  • func (c *Lint) Lint(ctx context.Context, disk fs.FS) ([]IssueInfo, error)
• type OpenImportFileError
  • func (e *OpenImportFileError) Error() string
• type ProtoInfo
• type Rule

Variables

var (
	ErrInvalidRule = errors.New("invalid rule")
)

Functions

func CheckIsIgnored

func CheckIsIgnored(comments []*parser.Comment, ruleName string) bool

CheckIsIgnored check if passed ruleName has to be ignored due to ignore command in comments

func GetRuleName

func GetRuleName(rule Rule) string

GetRuleName returns rule name

func SetAllowCommentIgnores

func SetAllowCommentIgnores(val bool)

Types

type ImportPath

type ImportPath string

ImportPath type alias for path import in proto file

func ConvertImportPath

func ConvertImportPath(source string) ImportPath

type Issue

type Issue struct {
	Position   meta.Position
	SourceName string
	Message    string
	RuleName   string
}

Issue contains the information of an issue.

func AppendIssue

func AppendIssue(
	issues []Issue, lintRule Rule, pos meta.Position, sourceName string, comments []*parser.Comment,
) []Issue

AppendIssue check if lint error is ignored -> add new error to slice otherwise ignore appending

type IssueInfo

type IssueInfo struct {
	Issue
	Path string
}

IssueInfo contains the information of an issue and the path.

type Lint

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

Lint is the core functionality of easyp lint.

func New

func New(rules []Rule, ignore []string, ignoreOnly map[string][]string, deps []string) *Lint

New creates a new Lint.

func (*Lint) Lint

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

Lint lints the proto file.

type OpenImportFileError

type OpenImportFileError struct {
	FileName string
}

func (*OpenImportFileError) Error

func (e *OpenImportFileError) Error() string

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 {
	// Message returns the message of the rule.
	Message() string
	// Validate validates the proto rule.
	Validate(ProtoInfo) ([]Issue, error)
}

Rule is an interface for a rule checking.