Skip to content
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

[Fix] prop-types: props missing in validation when using generic types from a namespace import #3859

Conversation

rbondoc96
Copy link
Contributor

Description

Fixes #3684.

TypeScript code that uses ComponentProps and ComponentPropsWithoutRef from a namespace import (such as import React from 'react' or import * as React from 'react') led to destructured props receiving a "is missing in props validation" error.

For example:

import * as React from 'react';

export const Button = React.forwardRef<HTMLButtonElement, React.ComponentPropsWithoutRef<'button'>>(
    // Error: 'className' is missing in props validation (from the react/prop-types rule)
    ({ children, className, ...props }, ref) => {
        return (
            <button className={className} ref={ref} {...props}>
                {children}
            </button>
        );
    },
);
Button.displayName = 'Button';

@rbondoc96 rbondoc96 force-pushed the fix-prop-types-validation-with-namespace-imports branch from e1eb228 to b9f70bd Compare December 10, 2024 08:09
Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.66%. Comparing base (01ac0a2) to head (b9f70bd).
Report is 31 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3859      +/-   ##
==========================================
- Coverage   97.70%   97.66%   -0.05%     
==========================================
  Files         136      136              
  Lines        9950     9978      +28     
  Branches     3685     3703      +18     
==========================================
+ Hits         9722     9745      +23     
- Misses        228      233       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

Thanks, looks great!

@ljharb ljharb force-pushed the fix-prop-types-validation-with-namespace-imports branch from b9f70bd to b713026 Compare December 12, 2024 19:15
@rbondoc96
Copy link
Contributor Author

Glad I could help 🙂

@ljharb ljharb merged commit b713026 into jsx-eslint:master Dec 12, 2024
402 checks passed
Rhahgan21

This comment was marked as spam.

Rhahgan21

This comment was marked as spam.

cswimr pushed a commit to cswimr/gauntlet-cswimr-plugins that referenced this pull request Dec 27, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) | devDependencies | patch | [`7.37.2` -> `7.37.3`](https://renovatebot.com/diffs/npm/eslint-plugin-react/7.37.2/7.37.3) |

---

### Release Notes

<details>
<summary>jsx-eslint/eslint-plugin-react (eslint-plugin-react)</summary>

### [`v7.37.3`](https://github.com/jsx-eslint/eslint-plugin-react/blob/HEAD/CHANGELOG.md#7373---20241223)

[Compare Source](jsx-eslint/eslint-plugin-react@v7.37.2...v7.37.3)

##### Fixed

-   \[`no-danger`]: avoid a crash on a nested component name ([#&#8203;3833][] [@&#8203;ljharb](https://github.com/ljharb))
-   \[Fix] types: correct generated type declaration ([#&#8203;3840][] [@&#8203;ocavue](https://github.com/ocavue))
-   \[`no-unknown-property`]: support `precedence` prop in react 19 ([#&#8203;3829][] [@&#8203;acusti](https://github.com/acusti))
-   \[`prop-types`]: props missing in validation when using generic types from a namespace import ([#&#8203;3859][] [@&#8203;rbondoc96](https://github.com/rbondoc96))

##### Changed

-   \[Tests] \[`jsx-no-script-url`]: Improve tests ([#&#8203;3849][] [@&#8203;radu2147](https://github.com/radu2147))
-   \[Docs] fix broken links: \[`default-props-match-prop-types`], \[`jsx-boolean-value`], \[`jsx-curly-brace-presence`], \[`jsx-no-bind`], \[`no-array-index-key`], \[`no-is-mounted`], \[`no-render-return-value`], \[`require-default-props`] ([#&#8203;3841][] [@&#8203;bastiendmt](https://github.com/bastiendmt))

[7.37.3]: jsx-eslint/eslint-plugin-react@v7.37.2...v7.37.3

[#&#8203;3859]: jsx-eslint/eslint-plugin-react#3859

[#&#8203;3849]: jsx-eslint/eslint-plugin-react#3849

[#&#8203;3841]: jsx-eslint/eslint-plugin-react#3841

[#&#8203;3840]: jsx-eslint/eslint-plugin-react#3840

[#&#8203;3833]: jsx-eslint/eslint-plugin-react#3833

[#&#8203;3829]: jsx-eslint/eslint-plugin-react#3829

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - 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 this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS44My40IiwidXBkYXRlZEluVmVyIjoiMzkuODMuNCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Reviewed-on: https://www.coastalcommits.com/cswimr/gauntlet-cswimr-plugins/pulls/9
Co-authored-by: Renovate <[email protected]>
Co-committed-by: Renovate <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: forwardRef error: 'className' is missing in props
3 participants