Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
Closed
Description
[Feature Request] @typescript-eslint/require-ts-comment-description
Rule Details
Examples of 👎incorrect code for this rule:
//@ts-expect-errorconstx:string=1;//@ts-ignoreconstx:string=1;
Examples of 👍correct code for this rule:
//@ts-expect-error because this code is testing a compiler I'm writingconstx:string=1;//@ts-ignore: because this code is testing a compiler I'm writingconstx:string=1;
Options
{"rules": {"@typescript-eslint/require-ts-comment-description":"error" }}The configuration looks like this:
interfaceOptions{'ts-expect-error'?:boolean;'ts-ignore'?:boolean;'ts-nocheck'?:boolean;'ts-check'?:boolean;}constdefaultOptions:Options={'ts-expect-error':true,'ts-ignore':true,'ts-nocheck':true,'ts-check':true,};
Additional Info
There is a similar rule inhttps://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html.
Ithought typescript-eslint had such a rule, but apparently not. My apologies if I just missed it.