feat(eslint-plugin): [consistent-type-assertions] add arrayLiteralTypeAssertions options #10565

yeonjuan · 2024-12-29T07:10:57Z

PR Checklist

Addresses an existing open issue: fixes Enhancement: [consistent-type-assertions] Prefer type annotation over assertion for arrays #6374
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This pr addresses #6374 and adds arrayLiteralTypeAssertions option to the consistent-type-assertions rule.
It starts from #6749, which was previously closed, and adds allow-as-parameter to the arrayLiteralTypeAssertions option. (#6749 (comment))

Co-authored-by: @danvk

…eAssertions options

typescript-eslint · 2024-12-29T07:11:01Z

Thanks for the PR, @yeonjuan!

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.

netlify · 2024-12-29T07:11:51Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f78ba99`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6780fb12864eef00086dded0
😎 Deploy Preview	https://deploy-preview-10565--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 6 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

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

nx-cloud · 2024-12-29T07:12:00Z

View your CI Pipeline Execution ↗ for commit f78ba99.

Command	Status	Duration	Result
`nx run-many --target=build --exclude website --...`	✅ Succeeded	3s	View ↗
`nx run-many --target=clean`	✅ Succeeded	11s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-13 16:29:59 UTC

codecov · 2024-12-29T09:59:12Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.96%. Comparing base (3ae4148) to head (f78ba99).
Report is 38 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10565      +/-   ##
==========================================
+ Coverage   86.86%   86.96%   +0.09%     
==========================================
  Files         445      446       +1     
  Lines       15455    15523      +68     
  Branches     4507     4524      +17     
==========================================
+ Hits        13425    13499      +74     
+ Misses       1675     1669       -6     
  Partials      355      355

Flag	Coverage Δ
unittest	`86.96% <100.00%> (+0.09%)`	⬆️

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

Files with missing lines	Coverage Δ
...int-plugin/src/rules/consistent-type-assertions.ts	`95.89% <100.00%> (+1.06%)`	⬆️

... and 23 files with indirect coverage changes

JoshuaKGoldberg

Lovely! The logic all makes sense and I like how the array and object checks are now mirrored. Great.

Requesting changes on some docs and testing please. 🚀

packages/eslint-plugin/tests/rules/consistent-type-assertions.test.ts

packages/eslint-plugin/docs/rules/consistent-type-assertions.mdx

packages/eslint-plugin/src/rules/consistent-type-assertions.ts

yeonjuan · 2025-01-06T15:41:05Z

@JoshuaKGoldberg Thanks for the review. I fixed

JoshuaKGoldberg

🚀 thanks!

ronami

Looks great! Thanks for sending this in! Just requesting minor changes, mostly around testing! 🏆

ronami · 2025-01-09T21:49:24Z

packages/eslint-plugin/src/rules/consistent-type-assertions.ts

+    function isAsParameter(
+      node: TSESTree.TSAsExpression | TSESTree.TSTypeAssertion,
+    ): boolean {


[Style]: I think this can be re-used for checking the object type's allow-as-parameter.

ronami · 2025-01-09T22:03:55Z

packages/eslint-plugin/src/rules/consistent-type-assertions.ts

+
+      if (
+        options.arrayLiteralTypeAssertions === 'allow-as-parameter' &&
+        isAsParameter(node)


[Testing]: This can be removed and no tests fail (&& isAsParameter(node)), I think it's important this would have a test that covers it.

ronami · 2025-01-09T22:09:08Z

packages/eslint-plugin/src/rules/consistent-type-assertions.ts

+        node.parent.type === AST_NODE_TYPES.NewExpression ||
+        node.parent.type === AST_NODE_TYPES.CallExpression ||
+        node.parent.type === AST_NODE_TYPES.ThrowStatement ||
+        node.parent.type === AST_NODE_TYPES.AssignmentPattern ||
+        node.parent.type === AST_NODE_TYPES.JSXExpressionContainer ||
+        (node.parent.type === AST_NODE_TYPES.TemplateLiteral &&
+          node.parent.parent.type === AST_NODE_TYPES.TaggedTemplateExpression)


[Testing]: Some of these can be removed with no tests failing, I think it would be helpful to have these covered by tests.

yeonjuan · 2025-01-10T11:16:20Z

Thanks @ronami. I fixed it. f78ba99

ronami

Thanks! 👍

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.19.1 | 8.20.0 | | npm | @typescript-eslint/parser | 8.19.1 | 8.20.0 | ## [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.19.1 | 8.20.0 | | npm | @typescript-eslint/parser | 8.19.1 | 8.20.0 | ## [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13) ##### 🚀 Features - **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565)) - **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585)) - **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551)) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602)) - **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593)) ##### ❤️ Thank You - Josh Goldberg ✨ - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

yeonjuan added 2 commits December 29, 2024 15:41

feat(eslint-plugin): [consistent-type-assertions] add arrayLiteralTyp…

e4b6227

…eAssertions options

add docs

9dfe2e8

yeonjuan added 2 commits December 29, 2024 16:17

Update consistent-type-assertions.mdx

880789a

update snapshot

8fcf981

yeonjuan marked this pull request as ready for review December 29, 2024 10:00

yeonjuan added 2 commits December 30, 2024 19:34

fix wrong data format

7d377d1

fix

ee8a2ef

JoshuaKGoldberg requested changes Dec 30, 2024

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Dec 30, 2024

yeonjuan added 4 commits December 31, 2024 14:17

review - rename getSuggests -> getSuggestions

0af07a9

review - docs

b64df60

fix tests

c3f66e5

Update consistent-type-assertions.test.ts

fdcd4ce

yeonjuan requested a review from JoshuaKGoldberg January 3, 2025 01:23

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 3, 2025

JoshuaKGoldberg previously approved these changes Jan 7, 2025

View reviewed changes

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jan 7, 2025

ronami requested changes Jan 9, 2025

View reviewed changes

ronami added awaiting response Issues waiting for a reply from the OP or another party and removed 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labels Jan 9, 2025

yeonjuan dismissed JoshuaKGoldberg’s stale review via 4e9c4e2 January 10, 2025 10:39

apply review

f78ba99

yeonjuan force-pushed the fix/6374 branch from 4e9c4e2 to f78ba99 Compare January 10, 2025 10:48

ronami approved these changes Jan 13, 2025

View reviewed changes

ronami added 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge and removed awaiting response Issues waiting for a reply from the OP or another party labels Jan 13, 2025

JoshuaKGoldberg merged commit a7fc28c into typescript-eslint:main Jan 13, 2025
65 of 66 checks passed

huuyafwww mentioned this pull request Jan 20, 2025

Update packages huuyafwww/eslint-config#29

Merged

github-actions bot locked as resolved and limited conversation to collaborators Jan 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [consistent-type-assertions] add arrayLiteralTypeAssertions options #10565

feat(eslint-plugin): [consistent-type-assertions] add arrayLiteralTypeAssertions options #10565

yeonjuan commented Dec 29, 2024 •

edited

Loading

typescript-eslint bot commented Dec 29, 2024

netlify bot commented Dec 29, 2024 •

edited

Loading

nx-cloud bot commented Dec 29, 2024 •

edited

Loading

codecov bot commented Dec 29, 2024 •

edited

Loading

JoshuaKGoldberg left a comment

yeonjuan commented Jan 6, 2025

JoshuaKGoldberg left a comment

ronami left a comment

ronami Jan 9, 2025

ronami Jan 9, 2025

ronami Jan 9, 2025

yeonjuan commented Jan 10, 2025 •

edited

Loading

ronami left a comment

feat(eslint-plugin): [consistent-type-assertions] add arrayLiteralTypeAssertions options #10565

feat(eslint-plugin): [consistent-type-assertions] add arrayLiteralTypeAssertions options #10565

Conversation

yeonjuan commented Dec 29, 2024 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Dec 29, 2024

netlify bot commented Dec 29, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Dec 29, 2024 • edited Loading

codecov bot commented Dec 29, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

yeonjuan commented Jan 6, 2025

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

ronami left a comment

Choose a reason for hiding this comment

ronami Jan 9, 2025

Choose a reason for hiding this comment

ronami Jan 9, 2025

Choose a reason for hiding this comment

ronami Jan 9, 2025

Choose a reason for hiding this comment

yeonjuan commented Jan 10, 2025 • edited Loading

ronami left a comment

Choose a reason for hiding this comment

yeonjuan commented Dec 29, 2024 •

edited

Loading

netlify bot commented Dec 29, 2024 •

edited

Loading

nx-cloud bot commented Dec 29, 2024 •

edited

Loading

codecov bot commented Dec 29, 2024 •

edited

Loading

yeonjuan commented Jan 10, 2025 •

edited

Loading