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

Josh-Cena · 2022-05-20T08:45:23Z

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 · 2022-05-20T08:45:25Z

☁️ 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

Sent with 💌 from NxCloud.

netlify · 2022-05-20T08:45:25Z

✅ 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 · 2022-05-20T08:45:28Z

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.

…r ts-expect-error

codecov · 2022-05-20T09:01:51Z

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.

packages/eslint-plugin/src/rules/ban-ts-comment.ts

packages/eslint-plugin/tests/rules/ban-ts-comment.test.ts

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Josh-Cena · 2022-05-21T02:38:56Z

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 · 2022-05-25T18:36:01Z

packages/eslint-plugin/src/rules/ban-ts-comment.ts

+type DirectiveConfig =
+  | boolean
+  | 'allow-with-description'
+  | { descriptionFormat: string };


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 · 2022-05-26T15:36:38Z

Great work!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.26.0` -> `5.27.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.26.0/5.27.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.26.0` -> `5.27.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.26.0/5.27.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5270-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5260v5270-2022-05-30) [Compare Source](typescript-eslint/typescript-eslint@v5.26.0...v5.27.0) ##### Bug Fixes - **eslint-plugin:** \[no-type-alias] handle Template Literal Types ([#5092](typescript-eslint/typescript-eslint#5092)) ([8febf11](typescript-eslint/typescript-eslint@8febf11)) ##### Features - \[4.7] support new extensions ([#5027](typescript-eslint/typescript-eslint#5027)) ([efc147b](typescript-eslint/typescript-eslint@efc147b)) - **eslint-plugin:** \[ban-ts-comment] add descriptionFormat option ([#5026](typescript-eslint/typescript-eslint#5026)) ([1fb31a4](typescript-eslint/typescript-eslint@1fb31a4)) - **eslint-plugin:** \[no-misused-promises] warn when spreading promises ([#5053](typescript-eslint/typescript-eslint#5053)) ([61ffa9e](typescript-eslint/typescript-eslint@61ffa9e)) - **eslint-plugin:** \[space-infix-ops] missing error report for conditional types ([#5041](typescript-eslint/typescript-eslint#5041)) ([0bfab6c](typescript-eslint/typescript-eslint@0bfab6c)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5270-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5260v5270-2022-05-30) [Compare Source](typescript-eslint/typescript-eslint@v5.26.0...v5.27.0) ##### Bug Fixes - **types:** remove leftovers from removal of useJSXTextNode ([#5091](typescript-eslint/typescript-eslint#5091)) ([f9c3647](typescript-eslint/typescript-eslint@f9c3647)) ##### Features - \[4.7] support new extensions ([#5027](typescript-eslint/typescript-eslint#5027)) ([efc147b](typescript-eslint/typescript-eslint@efc147b)) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1385 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

Josh-Cena changed the title ~~feat(eslint-plugin): [ban-ts-comment] add descriptionFormat option for ts-expect-error~~ feat(eslint-plugin): [ban-ts-comment] add descriptionFormat option May 20, 2022

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

273e750

…r ts-expect-error

Josh-Cena force-pushed the ts-expect-error-pattern branch from 3ec575a to 273e750 Compare May 20, 2022 08:48

test: test

a1686bb

bradzacher added the enhancement: plugin rule option New rule option for an existing eslint-plugin rule label May 20, 2022

JoshuaKGoldberg requested changes May 20, 2022

View reviewed changes

Update packages/eslint-plugin/src/rules/ban-ts-comment.ts

88430b3

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Josh-Cena added 2 commits May 21, 2022 10:41

Merge branch 'master' into ts-expect-error-pattern

acf7b70

refactor: deduplicate

620bf20

JoshuaKGoldberg reviewed May 25, 2022

View reviewed changes

JoshuaKGoldberg approved these changes May 25, 2022

View reviewed changes

Merge branch 'main' into ts-expect-error-pattern

a93f5b0

JoshuaKGoldberg enabled auto-merge (squash) May 25, 2022 18:38

JoshuaKGoldberg merged commit 1fb31a4 into typescript-eslint:main May 25, 2022

Josh-Cena deleted the ts-expect-error-pattern branch May 26, 2022 02:23

github-actions bot locked as resolved and limited conversation to collaborators Jun 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Josh-Cena commented May 20, 2022

nx-cloud bot commented May 20, 2022 •

edited

Loading

netlify bot commented May 20, 2022 •

edited

Loading

typescript-eslint bot commented May 20, 2022

codecov bot commented May 20, 2022 •

edited

Loading

JoshuaKGoldberg left a comment

Josh-Cena commented May 21, 2022

JoshuaKGoldberg May 25, 2022

JoshuaKGoldberg left a comment

Char2sGu commented May 26, 2022

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

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

Conversation

Josh-Cena commented May 20, 2022

PR Checklist

Overview

nx-cloud bot commented May 20, 2022 • edited Loading

☁️ Nx Cloud Report

netlify bot commented May 20, 2022 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

typescript-eslint bot commented May 20, 2022

codecov bot commented May 20, 2022 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Josh-Cena commented May 21, 2022

JoshuaKGoldberg May 25, 2022

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Char2sGu commented May 26, 2022

nx-cloud bot commented May 20, 2022 •

edited

Loading

netlify bot commented May 20, 2022 •

edited

Loading

codecov bot commented May 20, 2022 •

edited

Loading