Fix: Correct [object Object] output of error.data. #9561
Merged
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.
Stops error.data from being output as [object Object] when the data property
is an object, such as a rule’s options object.
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[x] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
Tell us about your environment
4.10.0
9.0.0
5.5.1
What parser (default, Babel-ESLint, etc.) are you using?
default
Please show your full configuration:
What did you do? Please include the actual source code causing the issue.
In a test file in
test/lib/rules
, in an invalidity test, set the value ofoptions
to an array of 1 option, which contained a property whose name was not specified in the schema of the rule. For example, set line 398 oftest/lib/rules/object-property-newline.js
to:options: [{ XallowMultiplePropertiesPerLineX: true }],
What did you expect to happen?
I expected an intelligible error message explaining what was wrong.
What actually happened? Please include the actual, raw output from ESLint.
I received an error message that did not sufficiently explain what was wrong, namely:
Value [object Object] should NOT have additional properties
.What changes did you make? (Give an overview)
config-validator
to check for the type of error.data. If error.data has a type other than string and is not an array, I changed it to its JSON stringification.Is there anything you'd like reviewers to focus on?
Would it be better to check for other types not yet in use, or to invert the check and check only for non-array objects, or to JSON stringify everything regardless of type?