TS · maintainability

←Previous Next→

no-vague-suppression-description

Require suppression descriptions to name the concrete mismatch or invariant instead of a generic non-reason.

vagueDescription Rule source Tests Catalog JSON

Why

Generic phrases satisfy require-description mechanically while leaving reviewers unable to audit the risk or remove stale debt.

Fix

Name the exact type/runtime mismatch, external contract, or safety invariant that makes this suppression acceptable.

Examples

Before — flagged Reject a suppression with no auditable reason

src/adapter.ts

function requestId(response: object) {
  // @ts-expect-error -- false positive
  return response.requestId;
}

After — preferred Explain the concrete runtime contract

src/adapter.ts

function requestId(response: object) {
  // @ts-expect-error -- vendor types omit the runtime requestId field
  return response.requestId;
}