Only flag regexp calls that use values known at compile time #1
Conversation
Do not flag function calls that have variables or function calls in their arguments, as such code cannot be refactored to only be called once.
|
Hi, came across your project and wanted to make a suggestion. It makes sense for a linter to flag cases where a regular expression is being compiled when the content is known at program compile time, but if a program compiles a regular expression based on variables or function calls (based on user input, file content, etc.), then it probably doesn't make sense to flag those occurrences, since they are valid and can't be compiled in a way that satisfies this check. Although the check provides a comment suppression mechanism, it probably makes more sense to handle this directly. This PR contains an example of how this modification could be made by doing an extra AST check after the initial "called" check. |
| @@ -17,7 +20,7 @@ const doc = `Below functions should be called at once for performance. | |||
| - regexp.CompilePOSIX | |||
| - regexp.MustCompilePOSIX | |||
|
|
|||
| Allow call in init, and main(except for in for loop) functions because each function is called only once. | |||
| Allow call in init and main functions (unless call is in a for loop) because these functions are only called once. | |||
|
|
||
| regexp.MustCompile(constVal) // want `regexp.MustCompile must be called only once at initialize` | ||
| regexp.MustCompile(constVal + constVal) // want `regexp.MustCompile must be called only once at initialize` | ||
| } |
| @@ -73,6 +111,30 @@ func run(pass *analysis.Pass) (interface{}, error) { | |||
| return nil, nil | |||
| } | |||
|
|
|||
| // variablesOrCallInCallExpr returns true if the provided *ast.CallExpr has | |||
| // at least one argument and if the first argument contains a reference to a | |||
| // variable or a function call. | |||
There was a problem hiding this comment.
These comment are easy for me to understand. Thank you for explaining in comments.
|
and, sorry for review so late... |
|
I released new version included this PR! |
Do not flag function calls that have variables or function calls
in their arguments, as such code cannot be refactored to only be
called once.