search

j-f1 / eslint-docs

Keep your rule names and descriptions up-to-date across your repo
https://j-f1.github.io/eslint-docs
ISC License
3 stars 3 forks source link

Categories #36

Open armano2 opened 5 years ago

armano2 commented 5 years ago

It will be nice if there will be way to group rules by their categories.

meta.docs.category field

j-f1 commented 5 years ago

Should this be an option somehow? I was thinking about this earlier, and I was considering making yet another column with an emoji key for the different categories, but that might be too confusing.

armano2 commented 5 years ago

Categories often are shown as some sort of heading.

https://eslint.org/docs/rules/ https://palantir.github.io/tslint/rules/ https://github.com/mysticatea/eslint-plugin-node#-rules https://github.com/benmosher/eslint-plugin-import#rules https://github.com/yannickcr/eslint-plugin-react#list-of-supported-rules

splitting into categories is useful only when there is a lot of rules, than it should be configurable

armano2 commented 5 years ago

there is also one more not supported case, deprecated and replacedBy

j-f1 commented 5 years ago

IMO we shouldn’t list deprecated rules on the README. However, we could ensure that they have a warning message in bold+italics on their docs page:

This rule is DEPRECATED and has been replaced by [foo/bar](link)