Tooling

tooling/ignore-with-reason

Every fs-ignore comment names the rule id it silences and says why; a bare fs-ignore silences every rule on the line.

moderatemanualfe-fix

Why

A suppression without an id hides every rule on that line, including problems added later. Without a reason, the next person cannot tell a deliberate exception from a shortcut, and nobody revisits it. The audit cannot report a bare fs-ignore itself, because the comment silences that finding too.

Fix

Fix the code when you can. When a finding is a real exception, write the id, then -- and a reason, in the same comment: <!-- fs-ignore a11y/positive-tabindex -- third-party widget sets it, issue #123 -->. Do not put a colon right after the id: a11y/positive-tabindex: is not read as an id, so the comment silences every rule. For a rule the team does not follow at all, put it in audit.ignore in the profile and record why with learn --lesson.

Examples

<!-- bad -->
<div tabindex="3"> <!-- fs-ignore -->
<!-- good -->
<!-- fs-ignore a11y/positive-tabindex -- embedded vendor widget, cannot change, issue #123 -->
<div tabindex="3">

Sources

Facts

Id
tooling/ignore-with-reason
Severity
moderate
Check
manual a person reviews it; the report lists it as a checklist
Applies to
html angular vue svelte astro jsx css scss less
Taught by the skill
fe-fix Fix findings
Since version
0.1.0

Rule file on GitHub

Read it in the terminal

npx github:dawidolko/frontend-skills explain tooling/ignore-with-reason