JS: Change js/misspelled-variable-name to sometimes report the local variable as the misspelling #3094
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erik-krogh
added
JS
Awaiting evaluation
…ces of the global
esbena
requested changes
Apr 17, 2020
esbena
requested changes
Apr 17, 2020
Co-Authored-By: Esben Sparre Andreasen <esbena@github.com>
(Except TypeScript, but that also fails on master). |
| int globalAccesses(string name) { result = count(GlobalVarAccess acc | acc.getName() = name) } | ||
|
|
||
| /** | ||
| * Holds if our heuristic says that the local variable `lvd` seems to be a misspelling of the global variable `gvd`. |
There was a problem hiding this comment.
Shouldn't this be gva?
There was a problem hiding this comment.
Yes it should.
Thanks.
esbena
approved these changes
Apr 20, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inspired by these alerts: https://lgtm.com/projects/g/MicrosoftDocs/iis-docs/alerts?id=js%2Fmisspelled-variable-name&mode=list
(From an anomalous query result)
The
js/misspelled-variable-namequery finds a pair of a local and global variable, where one seems to be a misspelling of the other. And the query always reports the global variable as the misspelling.This PR adds a heuristic to check if the local variable is likely the misspelling, based on the number of occurrences of each spelling.
If the local seems to be the misspelling, then the alert message is changed, but the alert location stays the same to avoid alerts shifting around.
It seems to work in practice, and gives an alert message that makes sense in more cases than previously.
(Here are results on a larger benchmark selection)