Support auto-generated rule options lists #481
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.
Fixes #237. Similar to #480.
This is an optional feature for anyone who adds these marker comments to their rule docs, typically in a
## Config
or## Options
section:Rendered example of the table/list that will be generated:
bar
always
,never
always
foo
false
Based on this schema:
Note that rule option lists are experimental / subject-to-change as we add support for more kinds and properties of schemas. To fully take advantage of them, you'll want to ensure your rules have the
meta.schema
property fleshed out with properties likedescription
,type
,enum
,default
,required
,deprecated
.Future follow-up features to consider:
## Options
sections (breaking change) OR have an option to automatically add it to rule docs for the initial setup Consider unified option for controlling what features are required #488meta.defaultOptions
on rules eslint/rfcs#113? Various improvements to rule option lists #491