TypeScript · maintainability

no-trailing-value-narration

eslint:no-trailing-value-narration

Flag a trailing comment that repeats the line's numeric value only to name its unit.

Why

A repeated value can disagree with the expression after either the code or comment changes.

Put the unit in the identifier and keep comments only when they explain a constraint or non-obvious conversion.

Executed by this rule’s unit tests.

Before

src/timeouts.ts · focus

const staleTime = 5 * 60 * 1000; // 5 minutes

After

src/timeouts.ts · focus

const timeout = 5 * 60; // 5 minutes for cold starts

Only trailing comments with numeric values and recognized unit words are inspected.

narratesValue

Formerly: trailing-value-narration