require-diagnostic-reason

Require reasons for diagnostic suppressions

A diagnostic suppression without a reason hides why the exception is necessary.
Instead, every @allow and @expect SHOULD include a concise reason.

- Category: style
- Level: warning
- Fix: none
- Scope: module

Reported

@allow("constant-condition")
function ready(): boolean {
    if (true) {
        return true;
    }

    return false;
}
Accepted

@allow("constant-condition", { reason: "required sentinel branch" })
function ready(): boolean {
    if (true) {
        return true;
    }

    return false;
}
Prior art

- Clippy · allowattributeswithoutreason
- typescript-eslint · ban-ts-comment

language/linter/src/rules/style/requirediagnosticreason.rs:7