ir

Documentation

Index

• type BundleImport
• type File
• type FilterExpr
  • func (e FilterExpr) IsBasicLit() bool
  • func (e FilterExpr) IsBinaryExpr() bool
  • func (e FilterExpr) IsValid() bool
  • func (e FilterExpr) String() string
• type FilterOp
  • func (op FilterOp) String() string
• type PackageImport
• type Rule
• type RuleGroup

Types

type BundleImport

type BundleImport struct {
	Line int

	PkgPath string
	Prefix  string
}

type File

type File struct {
	PkgPath string

	RuleGroups []RuleGroup

	CustomDecls []string

	BundleImports []BundleImport
}

type FilterExpr

type FilterExpr struct {
	Line int

	Op    FilterOp
	Src   string
	Value interface{}
	Args  []FilterExpr
}

func (FilterExpr) IsBasicLit

func (e FilterExpr) IsBasicLit() bool

func (FilterExpr) IsBinaryExpr

func (e FilterExpr) IsBinaryExpr() bool

func (FilterExpr) IsValid

func (e FilterExpr) IsValid() bool

func (FilterExpr) String

func (e FilterExpr) String() string

type FilterOp

type FilterOp int

const (
	FilterInvalidOp FilterOp = 0

	// !$Args[0]
	FilterNotOp FilterOp = 1

	// $Args[0] && $Args[1]
	FilterAndOp FilterOp = 2

	// $Args[0] || $Args[1]
	FilterOrOp FilterOp = 3

	// $Args[0] == $Args[1]
	FilterEqOp FilterOp = 4

	// $Args[0] != $Args[1]
	FilterNeqOp FilterOp = 5

	// $Args[0] > $Args[1]
	FilterGtOp FilterOp = 6

	// $Args[0] < $Args[1]
	FilterLtOp FilterOp = 7

	// $Args[0] >= $Args[1]
	FilterGtEqOp FilterOp = 8

	// $Args[0] <= $Args[1]
	FilterLtEqOp FilterOp = 9

	// m[$Value].Addressable
	// $Value type: string
	FilterVarAddressableOp FilterOp = 10

	// m[$Value].Pure
	// $Value type: string
	FilterVarPureOp FilterOp = 11

	// m[$Value].Const
	// $Value type: string
	FilterVarConstOp FilterOp = 12

	// m[$Value].Text
	// $Value type: string
	FilterVarTextOp FilterOp = 13

	// m[$Value].Line
	// $Value type: string
	FilterVarLineOp FilterOp = 14

	// m[$Value].Value.Int()
	// $Value type: string
	FilterVarValueIntOp FilterOp = 15

	// m[$Value].Type.Size
	// $Value type: string
	FilterVarTypeSizeOp FilterOp = 16

	// m[$Value].Filter($Args[0])
	// $Value type: string
	FilterVarFilterOp FilterOp = 17

	// m[$Value].Node.Is($Args[0])
	// $Value type: string
	FilterVarNodeIsOp FilterOp = 18

	// m[$Value].Object.Is($Args[0])
	// $Value type: string
	FilterVarObjectIsOp FilterOp = 19

	// m[$Value].Type.Is($Args[0])
	// $Value type: string
	FilterVarTypeIsOp FilterOp = 20

	// m[$Value].Type.Underlying().Is($Args[0])
	// $Value type: string
	FilterVarTypeUnderlyingIsOp FilterOp = 21

	// m[$Value].Type.ConvertibleTo($Args[0])
	// $Value type: string
	FilterVarTypeConvertibleToOp FilterOp = 22

	// m[$Value].Type.AssignableTo($Args[0])
	// $Value type: string
	FilterVarTypeAssignableToOp FilterOp = 23

	// m[$Value].Type.Implements($Args[0])
	// $Value type: string
	FilterVarTypeImplementsOp FilterOp = 24

	// m[$Value].Text.Matches($Args[0])
	// $Value type: string
	FilterVarTextMatchesOp FilterOp = 25

	// m.Deadcode()
	FilterDeadcodeOp FilterOp = 26

	// m.GoVersion().Eq($Value)
	// $Value type: string
	FilterGoVersionEqOp FilterOp = 27

	// m.GoVersion().LessThan($Value)
	// $Value type: string
	FilterGoVersionLessThanOp FilterOp = 28

	// m.GoVersion().GreaterThan($Value)
	// $Value type: string
	FilterGoVersionGreaterThanOp FilterOp = 29

	// m.GoVersion().LessEqThan($Value)
	// $Value type: string
	FilterGoVersionLessEqThanOp FilterOp = 30

	// m.GoVersion().GreaterEqThan($Value)
	// $Value type: string
	FilterGoVersionGreaterEqThanOp FilterOp = 31

	// m.File.Imports($Value)
	// $Value type: string
	FilterFileImportsOp FilterOp = 32

	// m.File.PkgPath.Matches($Value)
	// $Value type: string
	FilterFilePkgPathMatchesOp FilterOp = 33

	// m.File.Name.Matches($Value)
	// $Value type: string
	FilterFileNameMatchesOp FilterOp = 34

	// $Value holds a function name
	// $Value type: string
	FilterFilterFuncRefOp FilterOp = 35

	// $Value holds a string constant
	// $Value type: string
	FilterStringOp FilterOp = 36

	// $Value holds an int64 constant
	// $Value type: int64
	FilterIntOp FilterOp = 37

	// m[`$$`].Node.Parent().Is($Args[0])
	FilterRootNodeParentIsOp FilterOp = 38
)

func (FilterOp) String

func (op FilterOp) String() string

type PackageImport

type PackageImport struct {
	Path string
	Name string
}

type Rule

type Rule struct {
	Line int

	SyntaxPattern  string
	CommentPattern string

	ReportTemplate  string
	SuggestTemplate string

	WhereExpr FilterExpr

	LocationVar string
}

type RuleGroup

type RuleGroup struct {
	Line        int
	Name        string
	MatcherName string

	DocTags    []string
	DocSummary string
	DocBefore  string
	DocAfter   string
	DocNote    string

	Imports []PackageImport

	Rules []Rule
}