varpkg

Documentation

Index

• Variables
• func Check(local bool, node ast.Node, fileSet *token.FileSet)
• type Rule

Examples

• Check

Variables

var LocalVar = Rule{

	Rule: name.Rule{
		MaxLen: 30,
		Style:  "lowerCamelCase",
	},
	// contains filtered or unexported fields
}

var Var = Rule{

	Rule: name.Rule{
		MaxLen: 40,
		Style:  "camelCase",
	},
	// contains filtered or unexported fields
}

Functions

func Check

func Check(local bool, node ast.Node, fileSet *token.FileSet)

Example

var src = `package example
var V =  1
func F(arg1, Arg2 int) {
  const c =  2
  var V int
  slice := []int{}
  for k, v := range slice {
    k = 5
  }
  for k, v = range slice {
  }
}
`
problems.Clear()
w := walker.Parse("example.go", src)
w.Walk(func(isLocal bool, node ast.Node) {
	Check(isLocal, node, w.FileSet)
})
problems.Render()

Output:

+-----------------+-----------------------------------------------------+----------------+
|    position     |                       problem                       |      rule      |
+-----------------+-----------------------------------------------------+----------------+
| example.go:3:14 | func param name Arg2 should be lowerCamelCase style | localVar.style |
| example.go:5:7  | local var name V should be lowerCamelCase style     | localVar.style |
+-----------------+-----------------------------------------------------+----------------+

Types

type Rule

type Rule struct {
	namepkg.Rule `yaml:",inline"`
	// contains filtered or unexported fields
}