docs: Add messages property to rule meta documentation #20361
Merged
+1
−0
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
1 task
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
lumirlumir
requested changes
Dec 1, 2025
Member
lumirlumir
left a comment
lumirlumir
left a comment
There was a problem hiding this comment.
Hi @sabyasachisharma, thanks for the PR!
However, issue #20311 was originally assigned to @overlookmotel, so per our policy we cannot accept this PR without consensus from the original author. Thanks for understanding!
mdjermanovic
reviewed
Dec 1, 2025
mdjermanovic
added
the
accepted
Member
|
@sabyasachisharma per #20311 (comment), you can continue working on this PR. |
Adds the messages property to the meta object description in the custom rules documentation. The messages property is used to define violation and suggestion messages that can be referenced by messageIds in context.report() calls. Fixes eslint#20311
sabyasachisharma
force-pushed
the
issue20311
branch
from
5a81df7 to
f90bf10
Compare
lumirlumir
approved these changes
Dec 2, 2025
Member
lumirlumir
left a comment
lumirlumir
left a comment
There was a problem hiding this comment.
LGTM, thanks!
Would like @mdjermanovic to verify before merging.
github-project-automation
bot
moved this from Second Review Needed
to Complete
in Triage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Adds the messages property to the meta object description in the custom rules documentation. The messages property is used to define violation and suggestion messages that can be referenced by messageIds in context.report() calls.
Fixes #20311
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] 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)
Added the
messagesproperty to themetaobject description in the custom rules documentation (docs/src/extend/custom-rules.md). Themessagesproperty was already being used in examples throughout the documentation but was missing from the initialmetaobject description. This change adds a clear description of the property with a link to the messageIds section where it's discussed in detail.Is there anything you'd like reviewers to focus on?
No specific focus needed. This is a straightforward documentation update that adds the missing
messagesproperty description to match the existing examples in the documentation.