fix: correct and align retrievement of rule options #785
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
veritem
approved these changes
Oct 14, 2025
happy to and thank you 🫵🏼 for maintaining this extremely useful eslint plugin! ❤️ |
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
According to https://typescript-eslint.io/developers/custom-rules/#handling-rule-options we should "use the second parameter of the
createfunction, notcontext.options" to retrieve the (default) options.In this PR, all rules that previously relied on
context.optionshave been updated accordingly.It fixes #783. I guess considering it a "fix" is appropriate here since it would now work as outlined in the documentation.
For the other rules there are no logical changes. Please let me know if you prefer to have those changes in separate PRs.
Advantage: consistency and expected behavior for future adjustments to default options
Minor disadvantage: currently, we have to use the non-null assertion operator for default values as the types in
ESLintUtils.RuleCreatordoesn't seem to account for them