search

wikimedia / eslint-docgen

Automatically generate ESLint plugin documentation from rule metadata and test cases.
MIT License
10 stars 7 forks source link

Allow examples to be sorted by options first, instead of valid/invalid #48

Closed edg2s closed 4 years ago

edg2s commented 4 years ago

Currently the sort order for examples is:

Some plugins prefer:

(example: https://github.com/platinumazure/eslint-plugin-qunit/blob/master/docs/rules/require-expect.md)

edg2s commented 4 years ago

Ordering also used by eslint.org: https://eslint.org/docs/rules/semi-style#top

This seems to be a more sensible order and is used by most if not all plugins. Not sure it makes sense to keep the old order as an option.