typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.7k

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

JoshuaKGoldberg merged 6 commits intotypescript-eslint:mainfromJosh-Cena:ts-expect-error-pattern

May 25, 2022

Merged

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

JoshuaKGoldberg merged 6 commits intotypescript-eslint:mainfromJosh-Cena:ts-expect-error-pattern

May 25, 2022

Conversation

Copy link

Member

Josh-Cena commentedMay 20, 2022

PR Checklist

Addresses an existing open issue:fixes[ban-ts-comment] Enforce@ts-expect-error: TS1234 because xyz #4253
That issue was marked asaccepting prs
Steps inCONTRIBUTING.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.

Copy link

nx-cloudbot commentedMay 20, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commita93f5b0. 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 💌 fromNxCloud.

Copy link

netlifybot commentedMay 20, 2022•
edited
Loading

✅ Deploy Preview fortypescript-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 yourNetlify site settings.

Copy link

Contributor

typescript-eslintbot commentedMay 20, 2022

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 visitorsper day.

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 thets-expect-error-pattern branch from3ec575a to273e750Compare

May 20, 2022 08:48

Copy link

codecovbot commentedMay 20, 2022•
edited
Loading

Codecov Report

Merging#5026 (620bf20) intomain (73324aa) willincrease coverage by2.47%.
The diff coverage is100.00%.

❗ Current head620bf20 differs from pull request most recent heada93f5b0. Consider uploading reports for the commita93f5b0 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%> (ø)`
... and145 more

test: test

a1686bb

bradzacher added the enhancement: plugin rule optionNew rule option for an existing eslint-plugin rule label

May 20, 2022

JoshuaKGoldberg requested changes

May 20, 2022

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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 OutdatedShow resolvedHide resolved

packages/eslint-plugin/src/rules/ban-ts-comment.tsShow resolvedHide resolved

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

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

88430b3

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

Copy link

MemberAuthor

Josh-Cena commentedMay 21, 2022

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)

Josh-Cena added2 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

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

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

Copy link

Member

JoshuaKGoldbergMay 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Hmm, it would be nice to haveminimumDescriptionLength 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 approved these changes

May 25, 2022

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fantastic, thanks@Josh-Cena! 💯

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

a93f5b0

JoshuaKGoldbergenabled auto-merge (squash)

May 25, 2022 18:38

JoshuaKGoldberg merged commit1fb31a4 intotypescript-eslint:main

May 25, 2022

Josh-Cena deleted the ts-expect-error-pattern branch

May 26, 2022 02:23

Copy link

Char2sGu commentedMay 26, 2022

Great work!

crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request

Jun 5, 2022

Update typescript-eslint monorepo to v5.27.0 (#1385)

917449d

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 (@&#8203;typescript-eslint/eslint-plugin)</summary>### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;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 ([#&#8203;5092](typescript-eslint/typescript-eslint#5092)) ([8febf11](typescript-eslint/typescript-eslint@8febf11))##### Features-   \[4.7] support new extensions ([#&#8203;5027](typescript-eslint/typescript-eslint#5027)) ([efc147b](typescript-eslint/typescript-eslint@efc147b))-   **eslint-plugin:** \[ban-ts-comment] add descriptionFormat option ([#&#8203;5026](typescript-eslint/typescript-eslint#5026)) ([1fb31a4](typescript-eslint/typescript-eslint@1fb31a4))-   **eslint-plugin:** \[no-misused-promises] warn when spreading promises ([#&#8203;5053](typescript-eslint/typescript-eslint#5053)) ([61ffa9e](typescript-eslint/typescript-eslint@61ffa9e))-   **eslint-plugin:** \[space-infix-ops] missing error report for conditional types ([#&#8203;5041](typescript-eslint/typescript-eslint#5041)) ([0bfab6c](typescript-eslint/typescript-eslint@0bfab6c))</details><details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>### [`v5.27.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;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 ([#&#8203;5091](typescript-eslint/typescript-eslint#5091)) ([f9c3647](typescript-eslint/typescript-eslint@f9c3647))##### Features-   \[4.7] support new extensions ([#&#8203;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.--- - [ ] <!-- rebase-check -->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/1385Reviewed-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>

github-actionsbot locked asresolvedand limited conversation to collaborators

Jun 26, 2022

Labels

enhancement: plugin rule option

New rule option for an existing eslint-plugin rule

4 participants

Movatterモバイル変換

Uh oh!

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

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

Uh oh!

Conversation

Josh-Cena commentedMay 20, 2022

PR Checklist

Overview

Uh oh!

nx-cloudbot commentedMay 20, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

netlifybot commentedMay 20, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

typescript-eslintbot commentedMay 20, 2022

Uh oh!

codecovbot commentedMay 20, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Josh-Cena commentedMay 21, 2022

Uh oh!

JoshuaKGoldbergMay 25, 2022

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Char2sGu commentedMay 26, 2022

Uh oh!

Uh oh!

nx-cloudbot commentedMay 20, 2022•
edited
Loading

netlifybot commentedMay 20, 2022•
edited
Loading

codecovbot commentedMay 20, 2022•
edited
Loading