fix: improve report message (#8)

* fix: improve report message

* tests: add test case

nosnakecase.go

@@ -23,13 +23,13 @@ var Analyzer = &analysis.Analyzer{
 }
 
 func run(pass *analysis.Pass) (interface{}, error) {
-	inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+	result := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
 
 	nodeFilter := []ast.Node{
 		(*ast.Ident)(nil),
 	}
 
-	inspect.Preorder(nodeFilter, func(n ast.Node) {
+	result.Preorder(nodeFilter, func(n ast.Node) {
 		switch n := n.(type) {
 		case *ast.Ident:
 			report(pass, n.Pos(), n.Name)
@@ -44,12 +44,14 @@ func report(pass *analysis.Pass, pos token.Pos, name string) {
 	if name == "_" {
 		return
 	}
+
 	// skip package xxx_test
 	if strings.Contains(name, "_test") {
 		return
 	}
+
 	if strings.Contains(name, "_") {
-		pass.Reportf(pos, "%s is used under score. You should use mixedCap or MixedCap.", name)
+		pass.Reportf(pos, "%s contains underscore. You should use mixedCap or MixedCap.", name)
 		return
 	}
 }

testdata/src/a/a.go

@@ -1,142 +1,148 @@
 package sandbox_test
 
+import f_mt "fmt" //  want "f_mt contains underscore. You should use mixedCap or MixedCap"
+
 // global variable name with underscore.
-var v_v = 0 // want "v_v is used under score. You should use mixedCap or MixedCap."
+var v_v = 0 // want "v_v contains underscore. You should use mixedCap or MixedCap."
 
 // global constant name with underscore.
-const c_c = 0 // want "c_c is used under score. You should use mixedCap or MixedCap."
+const c_c = 0 // want "c_c contains underscore. You should use mixedCap or MixedCap."
 
 // struct name with underscore.
-type S_a struct { // want "S_a is used under score. You should use mixedCap or MixedCap."
+type S_a struct { // want "S_a contains underscore. You should use mixedCap or MixedCap."
 	fi int
 }
 
 // non-exported struct field name with underscore.
 type Sa struct {
-	fi_a int // // want "fi_a is used under score. You should use mixedCap or MixedCap."
+	fi_a int // // want "fi_a contains underscore. You should use mixedCap or MixedCap."
 }
 
 // function as struct field, with parameter name with underscore.
 type Sb struct {
-	fib func(p_a int) // want "p_a is used under score. You should use mixedCap or MixedCap."
+	fib func(p_a int) // want "p_a contains underscore. You should use mixedCap or MixedCap."
 }
 
 // exported struct field with underscore.
 type Sc struct {
-	Fi_A int // want "Fi_A is used under score. You should use mixedCap or MixedCap."
+	Fi_A int // want "Fi_A contains underscore. You should use mixedCap or MixedCap."
 }
 
 // function as struct field, with return name with underscore.
 type Sd struct {
-	fib func(p int) (r_a int) // want "r_a is used under score. You should use mixedCap or MixedCap."
+	fib func(p int) (r_a int) // want "r_a contains underscore. You should use mixedCap or MixedCap."
 }
 
 // interface name with underscore.
-type I_a interface { // want "I_a is used under score. You should use mixedCap or MixedCap."
+type I_a interface { // want "I_a contains underscore. You should use mixedCap or MixedCap."
 	fn(p int)
 }
 
 // interface with parameter name with underscore.
 type Ia interface {
-	fn(p_a int) // want "p_a is used under score. You should use mixedCap or MixedCap."
+	fn(p_a int) // want "p_a contains underscore. You should use mixedCap or MixedCap."
 }
 
 // interface with parameter name with underscore.
 type Ib interface {
-	Fn(p_a int) // want "p_a is used under score. You should use mixedCap or MixedCap."
+	Fn(p_a int) // want "p_a contains underscore. You should use mixedCap or MixedCap."
 }
 
 // function as struct field, with return name with underscore.
 type Ic interface {
-	Fn_a() // want "Fn_a is used under score. You should use mixedCap or MixedCap."
+	Fn_a() // want "Fn_a contains underscore. You should use mixedCap or MixedCap."
 }
 
 // interface with return name with underscore.
 type Id interface {
-	Fn() (r_a int) // want "r_a is used under score. You should use mixedCap or MixedCap."
+	Fn() (r_a int) // want "r_a contains underscore. You should use mixedCap or MixedCap."
 }
 
 // function name with underscore.
-func f_a() {} // want "f_a is used under score. You should use mixedCap or MixedCap."
+func f_a() {} // want "f_a contains underscore. You should use mixedCap or MixedCap."
 
 // function's parameter name with underscore.
-func fb(p_a int) {} // want "p_a is used under score. You should use mixedCap or MixedCap."
+func fb(p_a int) {} // want "p_a contains underscore. You should use mixedCap or MixedCap."
 
 // named return with underscore.
-func fc() (r_b int) { // want "r_b is used under score. You should use mixedCap or MixedCap."
+func fc() (r_b int) { // want "r_b contains underscore. You should use mixedCap or MixedCap."
 	return 0
 }
 
 // local variable (short declaration) with underscore.
 func fd(p int) int {
-	v_b := p * 2 // want "v_b is used under score. You should use mixedCap or MixedCap."
+	v_b := p * 2 // want "v_b contains underscore. You should use mixedCap or MixedCap."
 
-	return v_b // want "v_b is used under score. You should use mixedCap or MixedCap."
+	return v_b // want "v_b contains underscore. You should use mixedCap or MixedCap."
 }
 
 // local constant with underscore.
 func fe(p int) int {
-	const v_b = 2 // want "v_b is used under score. You should use mixedCap or MixedCap."
+	const v_b = 2 // want "v_b contains underscore. You should use mixedCap or MixedCap."
 
-	return v_b * p // want "v_b is used under score. You should use mixedCap or MixedCap."
+	return v_b * p // want "v_b contains underscore. You should use mixedCap or MixedCap."
 }
 
 // local variable with underscore.
 func ff(p int) int {
-	var v_b = 2 // want "v_b is used under score. You should use mixedCap or MixedCap."
+	var v_b = 2 // want "v_b contains underscore. You should use mixedCap or MixedCap."
 
-	return v_b * p // want "v_b is used under score. You should use mixedCap or MixedCap."
+	return v_b * p // want "v_b contains underscore. You should use mixedCap or MixedCap."
 }
 
 // inner function, parameter name with underscore.
 func fg() {
-	fgl := func(p_a int) {} // want "p_a is used under score. You should use mixedCap or MixedCap."
+	fgl := func(p_a int) {} // want "p_a contains underscore. You should use mixedCap or MixedCap."
 	fgl(1)
 }
 
+func fh() {
+	f_mt.Println("hello") // want "f_mt contains underscore. You should use mixedCap or MixedCap."
+}
+
 type Foo struct{}
 
 // method name with underscore.
-func (f Foo) f_a() {} // want "f_a is used under score. You should use mixedCap or MixedCap."
+func (f Foo) f_a() {} // want "f_a contains underscore. You should use mixedCap or MixedCap."
 
 // method's parameter name with underscore.
-func (f Foo) fb(p_a int) {} // want "p_a is used under score. You should use mixedCap or MixedCap."
+func (f Foo) fb(p_a int) {} // want "p_a contains underscore. You should use mixedCap or MixedCap."
 
 // named return with underscore.
-func (f Foo) fc() (r_b int) { return 0 } // want "r_b is used under score. You should use mixedCap or MixedCap."
+func (f Foo) fc() (r_b int) { return 0 } // want "r_b contains underscore. You should use mixedCap or MixedCap."
 
 // local variable (short declaration) with underscore.
 func (f Foo) fd(p int) int {
-	v_b := p * 2 // want "v_b is used under score. You should use mixedCap or MixedCap."
+	v_b := p * 2 // want "v_b contains underscore. You should use mixedCap or MixedCap."
 
-	return v_b // want "v_b is used under score. You should use mixedCap or MixedCap."
+	return v_b // want "v_b contains underscore. You should use mixedCap or MixedCap."
 }
 
 // local constant with underscore.
 func (f Foo) fe(p int) int {
-	const v_b = 2 // want "v_b is used under score. You should use mixedCap or MixedCap."
+	const v_b = 2 // want "v_b contains underscore. You should use mixedCap or MixedCap."
 
-	return v_b * p // want "v_b is used under score. You should use mixedCap or MixedCap."
+	return v_b * p // want "v_b contains underscore. You should use mixedCap or MixedCap."
 }
 
 // local variable with underscore.
 func (f Foo) ff(p int) int {
-	var v_b = 2 // want "v_b is used under score. You should use mixedCap or MixedCap."
+	var v_b = 2 // want "v_b contains underscore. You should use mixedCap or MixedCap."
 
-	return v_b * p // want "v_b is used under score. You should use mixedCap or MixedCap."
+	return v_b * p // want "v_b contains underscore. You should use mixedCap or MixedCap."
 }
 
-func fna(a, p_a int) {} // want "p_a is used under score. You should use mixedCap or MixedCap."
+func fna(a, p_a int) {} // want "p_a contains underscore. You should use mixedCap or MixedCap."
 
-func fna1(a string, p_a int) {} // want "p_a is used under score. You should use mixedCap or MixedCap."
+func fna1(a string, p_a int) {} // want "p_a contains underscore. You should use mixedCap or MixedCap."
 
-func fnb(a, b, p_a int) {} // want "p_a is used under score. You should use mixedCap or MixedCap."
+func fnb(a, b, p_a int) {} // want "p_a contains underscore. You should use mixedCap or MixedCap."
 
-func fnb1(a, b string, p_a int) {} // want "p_a is used under score. You should use mixedCap or MixedCap."
+func fnb1(a, b string, p_a int) {} // want "p_a contains underscore. You should use mixedCap or MixedCap."
 
 func fnd(
-	p_a int, // want "p_a is used under score. You should use mixedCap or MixedCap."
-	p_b int, // want "p_b is used under score. You should use mixedCap or MixedCap."
-	p_c int, // want "p_c is used under score. You should use mixedCap or MixedCap."
+	p_a int, // want "p_a contains underscore. You should use mixedCap or MixedCap."
+	p_b int, // want "p_b contains underscore. You should use mixedCap or MixedCap."
+	p_c int, // want "p_c contains underscore. You should use mixedCap or MixedCap."
 ) {
 }