Docs: Add jsdoc type
annotation to sample rule
#15085
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.
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 autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Updates the first rule example in the Working with Rules website documentation page.
There are some exciting benefits to adding a jsdoc
type
annotation to the exported object in rule files.The
type
annotation is supported by VSCode/Webstorm/other code editors. It uses the TypeScript declaration so code editors can provide hints/information/autocomplete about rule structure/fields even when only using JavaScript.https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#type
Idea from: eslint/generator-eslint#113
Is there anything you'd like reviewers to focus on?
I have only updated the first rule example. I figured it wouldn't be worth updating every rule example. Should we update any other examples? Should we add a small section about this instead?