Skip to content

fix(eslint-plugin): [consistent-type-assertions] allow default assertionStyle option #10512

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

scottohara
Copy link
Contributor

PR Checklist

Overview

Removes the schema requirement for assertionStyle to be provided, on the basis that when the defaultOptions are merged, an assertionStyle value of "as" will be used if none was provided.

This allows a user to supply partial options in their config, for example to override objectLiteralTypeAssertions: 'never' but retain the default assertionStyle: 'as', e.g. the following now works:

{
  '@typescript-eslint/consistent-type-assertions: [
    'error',
    { objectLiteralTypeAssertions: 'never' }
  ]
}

Note: I had intended to include a test case that omits the assertionStyle option, but I have a suspicion that the rule tester doesn't merge defaults, as I was unable to get the test to pass schema validation despite the fact that I had manually tested the change and can confirm that it works. Please let me know if a test case is still required for this.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @scottohara!

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.

Copy link

netlify bot commented Dec 17, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit f79e88b
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6760f7193d05cd000836058f
😎 Deploy Preview https://deploy-preview-10512--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98 (🟢 up 20 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.

Copy link

nx-cloud bot commented Dec 17, 2024

View your CI Pipeline Execution ↗ for commit f79e88b.

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

☁️ Nx Cloud last updated this comment at 2024-12-21 14:58:00 UTC

Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.78%. Comparing base (2c8a75e) to head (f79e88b).
Report is 48 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10512      +/-   ##
==========================================
+ Coverage   86.76%   86.78%   +0.02%     
==========================================
  Files         444      445       +1     
  Lines       15311    15366      +55     
  Branches     4457     4475      +18     
==========================================
+ Hits        13285    13336      +51     
- Misses       1672     1675       +3     
- Partials      354      355       +1     
Flag Coverage Δ
unittest 86.78% <ø> (+0.02%) ⬆️

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 94.82% <ø> (ø)

... and 18 files with indirect coverage changes

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

💯 thanks!

@JoshuaKGoldberg 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 Dec 21, 2024
@JoshuaKGoldberg JoshuaKGoldberg merged commit c6a387f into typescript-eslint:main Dec 23, 2024
63 of 65 checks passed
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Dec 23, 2024
| datasource | package                          | from   | to     |
| ---------- | -------------------------------- | ------ | ------ |
| npm        | @typescript-eslint/eslint-plugin | 8.18.1 | 8.18.2 |
| npm        | @typescript-eslint/parser        | 8.18.1 | 8.18.2 |


## [v8.18.2](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8182-2024-12-23)

##### 🩹 Fixes

-   **eslint-plugin:** \[no-unnecessary-condition] handle noUncheckedIndexedAccess true ([#10514](typescript-eslint/typescript-eslint#10514))
-   **eslint-plugin:** \[consistent-type-assertions] allow default assertionStyle option ([#10512](typescript-eslint/typescript-eslint#10512))
-   **eslint-plugin:** \[no-unnecessary-type-arguments] handle type/value context ([#10503](typescript-eslint/typescript-eslint#10503))
-   **eslint-plugin:** \[no-unsafe-type-assertion] fix for unsafe assertion to a constrained type parameter ([#10461](typescript-eslint/typescript-eslint#10461))
-   **eslint-plugin:** \[consistent-indexed-object-style] use a suggestion over an auto-fix if can't reliably determine that produced index signature is valid ([#10490](typescript-eslint/typescript-eslint#10490))
-   **eslint-plugin:** \[no-unnecessary-condition] don't flag values of an unconstrained or valid type parameter ([#10473](typescript-eslint/typescript-eslint#10473))
-   **eslint-plugin:** \[prefer-reduce-type-parameter] don't report cases in which the fix results in a type error ([#10494](typescript-eslint/typescript-eslint#10494))
-   **eslint-plugin:** \[no-deprecated] not reporting usages of deprecated declared constants as object value ([#10498](typescript-eslint/typescript-eslint#10498))

##### ❤️ Thank You

-   Luke Deen Taylor [@controversial](https://github.com/controversial)
-   Ronen Amiel
-   Scott O'Hara
-   YeonJuan [@yeonjuan](https://github.com/yeonjuan)
-   Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw)

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.
renovate bot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull request Dec 23, 2024
##### [v8.18.2](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8182-2024-12-23)

##### 🩹 Fixes

-   **eslint-plugin:** \[no-unnecessary-condition] handle noUncheckedIndexedAccess true ([#10514](typescript-eslint/typescript-eslint#10514))
-   **eslint-plugin:** \[consistent-type-assertions] allow default assertionStyle option ([#10512](typescript-eslint/typescript-eslint#10512))
-   **eslint-plugin:** \[no-unnecessary-type-arguments] handle type/value context ([#10503](typescript-eslint/typescript-eslint#10503))
-   **eslint-plugin:** \[no-unsafe-type-assertion] fix for unsafe assertion to a constrained type parameter ([#10461](typescript-eslint/typescript-eslint#10461))
-   **eslint-plugin:** \[consistent-indexed-object-style] use a suggestion over an auto-fix if can't reliably determine that produced index signature is valid ([#10490](typescript-eslint/typescript-eslint#10490))
-   **eslint-plugin:** \[no-unnecessary-condition] don't flag values of an unconstrained or valid type parameter ([#10473](typescript-eslint/typescript-eslint#10473))
-   **eslint-plugin:** \[prefer-reduce-type-parameter] don't report cases in which the fix results in a type error ([#10494](typescript-eslint/typescript-eslint#10494))
-   **eslint-plugin:** \[no-deprecated] not reporting usages of deprecated declared constants as object value ([#10498](typescript-eslint/typescript-eslint#10498))

##### ❤️ Thank You

-   Luke Deen Taylor [@controversial](https://github.com/controversial)
-   Ronen Amiel
-   Scott O'Hara
-   YeonJuan [@yeonjuan](https://github.com/yeonjuan)
-   Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw)

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.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [consistent-type-assertions] Omitting the default assertionStyle option causes a schema error
2 participants