Skip to content

fix(combobox-item): replace type-enforced deprecated + required textLabel prop with runtime warning #10855

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

jcfranco
Copy link
Member

@jcfranco jcfranco commented Nov 23, 2024

Related Issue: #10321

Summary

Addressed usage issues caused by TypeScript-enforced required property that had been marked as deprecated.

Noteworthy changes:

  • adds warnIfMissingRequiredProp util for cases where TS-enforced required props are not suitable
  • enable jsdoc/no-restricted-syntax rule to catch props tagged as both required and deprecated

…Label` prop with runtime warning

* adds `warnIfMissingRequiredProp` util for cases where TS-enforced required props are not suitable
* enable `jsdoc/no-unrestricted-syntax` rule to catch props tagged as required and deprecated`
@jcfranco jcfranco requested a review from benelan as a code owner November 23, 2024 05:00
@github-actions github-actions bot added the bug Bug reports for broken functionality. Issues should include a reproduction of the bug. label Nov 23, 2024
@jcfranco jcfranco added the skip visual snapshots Pull requests that do not need visual regression testing. label Nov 23, 2024
@jcfranco
Copy link
Member Author

@anveshmekala We could tweak the new warnIfMissingRequiredProp util to help w/ #8697.

Copy link
Member

@driskull driskull left a comment

Choose a reason for hiding this comment

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

👍

@jcfranco jcfranco merged commit ae11edb into dev Nov 25, 2024
15 checks passed
@jcfranco jcfranco deleted the jcfranco/10321-fix-combobox-item-textLabel-prop-both-deprecated-and-required branch November 25, 2024 19:39
jcfranco added a commit that referenced this pull request Nov 26, 2024
**Related Issue:** #10321 

## Summary

Follow-up from #10855.
benelan pushed a commit that referenced this pull request Feb 8, 2025
…Label` prop with runtime warning (#10855)

**Related Issue:** #10321

## Summary

Addressed usage issues caused by TypeScript-enforced required property
that had been marked as deprecated.

### Noteworthy changes:

* adds `warnIfMissingRequiredProp` util for cases where TS-enforced
required props are not suitable
* enable
[`jsdoc/no-restricted-syntax`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md)
rule to catch props tagged as both required and deprecated
benelan pushed a commit that referenced this pull request Feb 8, 2025
**Related Issue:** #10321 

## Summary

Follow-up from #10855.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bug reports for broken functionality. Issues should include a reproduction of the bug. skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants