docs: add guideline against lint-suppress comments #16

Merged
addison merged 1 commit from exe-dev-bot/shelley-extras:docs/no-lint-suppress into main 2026-02-07 08:20:16 -05:00
Contributor

Adds an explicit guideline that lint-suppress comments (eslint-disable, nolint, // ignore, etc.) are workarounds, not fixes. The proper approach is updating the linter config.

Learned the hard way during the market newsletter delivery PR — I used eslint-disable-next-line instead of adding the file to the ESLint config's exemption list.

Adds an explicit guideline that lint-suppress comments (`eslint-disable`, `nolint`, `// ignore`, etc.) are workarounds, not fixes. The proper approach is updating the linter config. Learned the hard way during the market newsletter delivery PR — I used `eslint-disable-next-line` instead of adding the file to the ESLint config's exemption list.
Explicit reminder that eslint-disable, nolint, etc. are workarounds.
The proper fix is updating the linter config to allow the pattern.

Co-authored-by: Shelley <shelley@exe.dev>
exe-dev-bot force-pushed docs/no-lint-suppress from 22f3cabdfd to 7e42c2065f 2026-02-07 08:20:02 -05:00 Compare
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
kwila/shelley-extras!16
No description provided.