Linter docs don't mention eslint-disable / oxlint-disable
JoshuaKGoldberg opened this issue · comments
Following #2999 -> #3024: I can't find documentation on or around https://oxc.rs/docs/guide/usage/linter about inline config comments. The closest to a mention is a link under https://oxc.rs/docs/guide/usage/linter#features to ESLint comment disabling. But searching eslint-disable
and oxlint-disable
on the site otherwise bring up nothing.
Request: could there be a page -or section in a page- added to mention the support for inline config comments?
Proposal: how about a page after Linter > Configuration File named something like "Inline Configuration" that mentions:
- Primarily:
oxlint-*
comments - Additionally that
eslint-*
comments - Best practices around using them (i.e. what https://eslint-community.github.io/eslint-plugin-eslint-comments enforces)
Added in oxc-project/oxc-project.github.io#302!