feat(eslint-plugin): [ban-ts-comment] add descriptionFormat option

[Josh-Cena]

PR Checklist

• Addresses an existing open issue: fixes [ban-ts-comment] Enforce @ts-expect-error: TS1234 because xyz #4253
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

For maximum flexibility, I didn't go with a hardcoded format, but allow passing in any kind of format.

I personally don't like this API design a lot, so I'd like to get settled on the API before writing docs.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit a93f5b0. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 47 targets

• Node 12 - nx test @typescript-eslint/eslint-plugin --coverage=false
• Node 18 - nx test @typescript-eslint/eslint-plugin
• nx run-many --target=build --all --parallel --exclude website
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/utils
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/visitor-keys
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=typecheck --all --parallel
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/utils --coverage=false
• Node 12 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/type-utils --coverage=false
• Node 12 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 12 - nx test @typescript-eslint/parser --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/scope-manager --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	a93f5b0
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/628e779091670900097f2a75
😎 Deploy Preview	https://deploy-preview-5026--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[typescript-eslint]

Thanks for the PR, @Josh-Cena!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[codecov]

Codecov Report

Merging #5026 (620bf20) into main (73324aa) will increase coverage by 2.47%.
The diff coverage is 100.00%.

❗ Current head 620bf20 differs from pull request most recent head a93f5b0. Consider uploading reports for the commit a93f5b0 to get more accurate results

@@            Coverage Diff             @@
##             main    #5026      +/-   ##
==========================================
+ Coverage   91.32%   93.79%   +2.47%     
==========================================
  Files         132      286     +154     
  Lines        1487     9806    +8319     
  Branches      224     2933    +2709     
==========================================
+ Hits         1358     9198    +7840     
- Misses         65      328     +263     
- Partials       64      280     +216     

Flag	Coverage Δ
unittest	93.79% <100.00%> (+2.47%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/eslint-plugin/src/rules/ban-ts-comment.ts	97.05% <100.00%> (ø)
...t-plugin/src/rules/no-confusing-void-expression.ts	98.85% <0.00%> (ø)
...n/src/rules/indent-new-do-not-use/OffsetStorage.ts	100.00% <0.00%> (ø)
.../eslint-plugin/src/rules/promise-function-async.ts	98.03% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/no-extra-parens.ts	90.41% <0.00%> (ø)
...lugin/src/rules/no-confusing-non-null-assertion.ts	82.60% <0.00%> (ø)
...eslint-plugin/src/rules/no-parameter-properties.ts	94.11% <0.00%> (ø)
packages/eslint-plugin/src/rules/semi.ts	92.85% <0.00%> (ø)
...src/rules/naming-convention-utils/parse-options.ts	100.00% <0.00%> (ø)
packages/eslint-plugin/src/rules/array-type.ts	97.18% <0.00%> (ø)
... and 145 more

[JoshuaKGoldberg]

The code looks pretty reasonable at first glance. I think the API might need to be able to consider the original error code(s), as many users will ask for that?

Requesting changes more so that we can discuss it. Personally I'm on the fence.

[Josh-Cena]

Do note that this PR is purely stylistic and there's no semantic difference to tsc itself. // @ts-expect-error is still going to suppress all errors. I think ^: TS\\d+ because .+$ is going to suffice for most usage (with sufficient user discretion of how to use it)

[JoshuaKGoldberg]

Hmm, it would be nice to have minimumDescriptionLength as an option in each object, so individual directives can override it... but that feels like a pretty niche use case. Maybe a followup to wait for someone to file an issue on.

[JoshuaKGoldberg]

Fantastic, thanks @Josh-Cena! 💯

[Char2sGu]

Great work!