fix #759 [rule.add-constant] change 'ignoreFuncs' expressions in docu…

…mentation and test (#760)
mgechev · Oct 15, 2022 · 1c3a15c · 1c3a15c
1 parent 3d83403
commit 1c3a15c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/RULES_DESCRIPTIONS.md b/RULES_DESCRIPTIONS.md
@@ -91,7 +91,7 @@ Example:
 
 ```toml
 [rule.add-constant]
-  arguments = [{maxLitCount = "3",allowStrs ="\"\"",allowInts="0,1,2",allowFloats="0.0,0.,1.0,1.,2.0,2.","ignoreFuncs": "os.*,fmt.Println,make"}]
+  arguments = [{maxLitCount = "3",allowStrs ="\"\"",allowInts="0,1,2",allowFloats="0.0,0.,1.0,1.,2.0,2.","ignoreFuncs": "os\\.*,fmt\\.Println,make"}]
 ```
 
 ## argument-limit

diff --git a/test/add-constant_test.go b/test/add-constant_test.go
@@ -13,7 +13,7 @@ func TestAddConstant(t *testing.T) {
 		"allowStrs":   "\"\"",
 		"allowInts":   "0,1,2",
 		"allowFloats": "0.0,1.0",
-		"ignoreFuncs": "os\\.(CreateFile|WriteFile|Chmod|FindProcess),.Println,ignoredFunc",
+		"ignoreFuncs": "os\\.(CreateFile|WriteFile|Chmod|FindProcess),\\.Println,ignoredFunc",
 	}}
 
 	testRule(t, "add-constant", &rule.AddConstantRule{}, &lint.RuleConfig{

diff --git a/testdata/add-constant.go b/testdata/add-constant.go
@@ -24,7 +24,9 @@ func foo(a, b, c, d int) {
 	os.FindProcess(102100)  // ignore
 	fmt.Println("test", 12) // ignore
 	fmt.Printf("%d", 100)   // MATCH /avoid magic numbers like '100', create a named constant for it/
+	myPrintln("%d", 100)    // MATCH /avoid magic numbers like '100', create a named constant for it/
 	ignoredFunc(1000)       // ignore
+	ignoredFunc1(1000)      // ignore - match regexp too
 
 	println("The result of calling myFunc is: ", ignoredFunc(100))             // ignore
 	println("result is: ", ignoredFunc(notIgnoredFunc(ignoredFunc(100))))      // ignore
@@ -38,7 +40,7 @@ func myPrintln(s string, num int) {
 
 }
 
-func not2ignoredFunc(num int) int {
+func ignoredFunc1(num int) int {
 	return num
 }