search

vercel / style-guide

Vercel's engineering style guide
Mozilla Public License 2.0
1.25k stars 33 forks source link

Consider adding rule to disallow configuration comments #58

Closed mrmckeb closed 6 months ago

mrmckeb commented 1 year ago

This is currently an escape hatch, but could also be misused.

One option is no-use with an allow-list, but that plugin isn't well supported and some users report that the rule is currently broken. https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/no-use.html

EndangeredMassa commented 1 year ago

These can be abused, but sometimes I do actually know better than the linter. I think this would get in the way more often than it would keep someone on the right path.

mrmckeb commented 1 year ago

We certainly couldn't roll comments/no-use out without allowing some/most of the comments that it disallows by default - the intention isn't to disallow eslint-disable[-*] comments.

I've updated the description to be clearer around what we are considering. We may need a custom rule for this.

mrmckeb commented 1 year ago

If we move forward with this, we'll only disallow: