Java: Add query to detect special characters in string literals #19875
Conversation
| @@ -0,0 +1 @@ | |||
| Violations of Best Practice/SpecialCharactersInLiterals/NonExplicitControlAndWhitespaceCharsInLiterals.ql | |||
Check warning
Code scanning / CodeQL
Query test without inline test expectations Warning test
There was a problem hiding this comment.
Did you consider an inline expectations test?
There was a problem hiding this comment.
Yes, I quickly turned it into an inline expectations test, but it failed, I think due to the fact that the strings contain multiple special characters. So then I reverted it, and kept it as it is.
e1b966e to
9db9200
Compare
9db9200 to
eeaaa87
Compare
eeaaa87 to
834cb1b
Compare
| * correctness | ||
| * maintainability | ||
| * readability |
There was a problem hiding this comment.
Just checking: you believe this matches both the correctness and readability categories?
There was a problem hiding this comment.
I think readability is definitely okay. correctness might/could be challenged. What do you think?
There was a problem hiding this comment.
I think it can belong to both. But between maintainability and reliability, you think it's better to choose maintainability, because readability is definitely an issue whereas correctness is only occasionally an issue?
| @@ -0,0 +1 @@ | |||
| Violations of Best Practice/SpecialCharactersInLiterals/NonExplicitControlAndWhitespaceCharsInLiterals.ql | |||
There was a problem hiding this comment.
Did you consider an inline expectations test?
This pull request introduces a new query to detect non-explicit control and whitespace characters in Java literals, improving code readability and reducing potential bugs caused by invisible or hard-to-recognize characters.
Manually testing autofix works, the special characters are replaced with
\u0....