fix: update error message for no-restricted-properties
#19855
Merged
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
✅ Deploy Preview for docs-eslint canceled.
|
|
Hi @Tanujkanti4441, could you take a look at the CI failure? The formatting is currently causing an error. |
nzakas
reviewed
Jun 18, 2025
| @@ -155,6 +155,10 @@ module.exports = { | |||
| const message = matchedObjectProperty.message | |||
| ? ` ${matchedObjectProperty.message}` | |||
| : ""; | |||
| const allowedPropertiesMessage = | |||
| matchedObjectProperty.allowProperties | |||
There was a problem hiding this comment.
Can we clean this up a bit?
Suggested change
| matchedObjectProperty.allowProperties | |
| ? ` Only these properties are allowed: ${matchedObjectProperty.allowProperties.join(", ")}.` |
| @@ -172,13 +177,17 @@ module.exports = { | |||
| const message = globalMatchedProperty.message | |||
| ? ` ${globalMatchedProperty.message}` | |||
| : ""; | |||
| const allowedObjectsMessage = globalMatchedProperty.allowObjects | |||
| ? ` It can be used only in allowed objects - ${globalMatchedProperty.allowObjects.join(", ")}.` | |||
There was a problem hiding this comment.
For clarity.
Suggested change
| ? ` It can be used only in allowed objects - ${globalMatchedProperty.allowObjects.join(", ")}.` | |
| ? ` Property ${propertyName} is only allowed on these objects: ${globalMatchedProperty.allowObjects.join(", ")}.` |
There was a problem hiding this comment.
Done! also added quotes around propertyName.
no-restricted-propertiesno-restricted-properties
nzakas
approved these changes
Jun 19, 2025
| @@ -73,10 +73,10 @@ module.exports = { | |||
| messages: { | |||
| restrictedObjectProperty: | |||
| // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period | |||
| "'{{objectName}}.{{propertyName}}' is restricted from being used.{{message}}", | |||
| "'{{objectName}}.{{propertyName}}' is restricted from being used.{{allowedPropertiesMessage}}{{message}}", | |||
There was a problem hiding this comment.
Just want to double-check, do we need a space here?
Suggested change
| "'{{objectName}}.{{propertyName}}' is restricted from being used.{{allowedPropertiesMessage}}{{message}}", | |
| "'{{objectName}}.{{propertyName}}' is restricted from being used.{{allowedPropertiesMessage}} {{message}}", |
There was a problem hiding this comment.
const message = matchedObjectProperty.message
? ` ${matchedObjectProperty.message}`
: "";There is already a space before the message, so we don't need space here.
| restrictedProperty: | ||
| // eslint-disable-next-line eslint-plugin/report-message-format -- Custom message might not end in a period | ||
| "'{{propertyName}}' is restricted from being used.{{message}}", | ||
| "'{{propertyName}}' is restricted from being used.{{allowedObjectsMessage}}{{message}}", |
There was a problem hiding this comment.
Same question.
Suggested change
| "'{{propertyName}}' is restricted from being used.{{allowedObjectsMessage}}{{message}}", | |
| "'{{propertyName}}' is restricted from being used.{{allowedObjectsMessage}} {{message}}", |
There was a problem hiding this comment.
Same for this one.
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[x] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Updated the error message of
no-restricted-propertiesfor two new optionsallowObjectsandallowProperties; now the error message will also show the property or objects names that are allowed.Now the error is -
'push' is restricted from being used. It can be used only in allowed objects - router.Now the error is -
'config.apiKey' is restricted from being used. Only allowed properties can be used - settings, version.Is there anything you'd like reviewers to focus on?