Improve detection of static arguments of context.report() in several rules
#129
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
…eral rules
Several of our rules check the arguments of `context.report()`. This PR makes some improvements:
1. When inferring the arguments passed to `context.report()` in `utils.getReportInfo()`, take into account the static value of the second argument when available.
2. Update the rules using `utils.getReportInfo()` to also consider the static value or variable declaration of the message argument when necessary.
I noticed these issues because in a number of my plugins, we have stored rule error messages in variables like `const MESSAGE = 'do A instead of B';`, and this prevented many of our rules from operating correctly.
Example of how this improvement enables the `no-deprecated-report-api` rule to correctly autofix this code:
```js
const MESSAGE = 'do A instead of B';
module.exports = {
create(context) {
// Before autofix
context.report(theNode, MESSAGE);
// After autofix
context.report({node: theNode, message: MESSAGE});
}
};
```
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.
Several of our rules check the arguments of
context.report(). This PR makes some improvements:context.report()inutils.getReportInfo(), take into account the static value of the second argument when available.utils.getReportInfo()to also consider the static value or variable declaration of the message argument when necessary.I noticed these issues because in a number of my plugins, we have stored rule error messages in variables like
const MESSAGE = 'do A instead of B';, and this prevented many of the eslint-plugin-eslint-plugin rules from operating correctly.Example of how this improvement enables the
no-deprecated-report-apirule to correctly autofix this code (previously no autofix):