neostandard / neostandard

A spiritual successor to the standardjs javascript style guide
MIT License
49 stars 2 forks source link

Add documentation for config changes #19

Open voxpelli opened 1 month ago

voxpelli commented 1 month ago

Ideally I would like neostandard to adapt a documentation approach similar to the one I have been doing in my personal superset (see screenshot)

I was working on automating that before flat configs came around and changed the config format. I do would like to extend https://github.com/voxpelli/compare-eslint-configs to support that though (and maybe split it / rename it to a then less confusing name)

There exists eg. bmish/eslint-doc-generator for plugins to generate documentation for rules, but there is no similar one for configs, and I think that would be really helpful, especially when possibly evaluating existing configs in a future.

Skärmavbild 2024-05-29 kl  18 18 14

voxpelli commented 3 weeks ago

Could possibly use: https://github.com/eslint/config-inspector Especially if extended